search

slds-lmu / yahpo_gym

Surrogate benchmarks for HPO problems
26 stars 3 forks source link

[enhancement] Please describe the very first setup in the home #74

Closed nabenabe0928 closed 1 year ago

nabenabe0928 commented 1 year ago

Thank you for the nice benchmark dataset. I have a suggestion for the enhancement of the doc. As it took me a while to run the benchmark at the first point, I would like you to add some information regarding the very first setup. Specifically, the following information helps:

  1. The info about local_config.init_config (I had no idea what Could not load local_config! meant)
  2. The URL to the benchmark data
  3. Minimal codeblock to test whether the setup is done.

Although the introduction to the features of this benchmark is important, I think a better installation guide would prevent users from making a decision to not use the benchmark datasets. Again, thanks for the nice benchmark datasets!

pfistfl commented 1 year ago

Hey @nabenabe0928

Thanks for the feedback, I will update this once I get around to it!

pfistfl commented 1 year ago

1) This is documented here: https://github.com/slds-lmu/yahpo_gym/tree/main/yahpo_gym#setup 2) This is also documented in the README, right above the setup part. 3) I have written a sentence on this in the README as well.