Skip to content

Commit

Permalink
docs: changes from review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Sarah Krebs committed Jun 5, 2024
1 parent 023d50a commit ab4e144
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 14 deletions.
9 changes: 5 additions & 4 deletions docs/contributing/contributing-a-benchmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,11 @@ and return a `TrialValue` object. If your problem requires additional methods, y
them in your class. For example, you might need a method to load data for your problem.


3. **Requirements file**: Create a requirements file under
`container_recipes/benchmarks/my_benchmark/my_benchmark_requirements.txt` and add the
requirements for your benchmark. Please specify exact versions of all requirements!
This is very important for reproducibility.
3. **Requirements file**: Create a requirements file and add the requirements for your benchmark.
The file structure must be
`container_recipes/benchmarks/<benchmark_id>/<benchmark_id>_requirements.txt`, so for example,
`container_recipes/benchmarks/my_benchmark/my_benchmark_requirements.txt`. Please specify exact
versions of all requirements! This is very important for reproducibility.


4. **Config files**: Add config files for the different benchmarking tasks under
Expand Down
9 changes: 5 additions & 4 deletions docs/contributing/contributing-an-optimizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,11 @@ queries a new trial to evaluate from the optimizer and returns it as a TrialInfo
the trial. If your optimizer requires additional methods, you can implement them in your class.


3. **Requirements file**: Create a requirements file under
`container_recipes/optimizers/my_optimizer/my_optimizer_requirements.txt` and add the
requirements for your optimizer. Please specify exact versions of all requirements!
This is very important for reproducibility.
3. **Requirements file**: Create a requirements file and add the requirements for your optimizer.
The file structure must be
`container_recipes/optimizers/<optimizer_container_id>/<optimizer_container_id>_requirements.txt`,
so for example, `container_recipes/optimizers/my_optimizer/my_optimizer_requirements.txt`.
Please specify exact versions of all requirements! This is very important for reproducibility.


4. **Config files**: Add config files for the different optimizers under
Expand Down
23 changes: 17 additions & 6 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,20 @@ pip install -r container_recipes/optimizers/SMAC3/SMAC3_requirements.txt
pip install -r container_recipes/benchmarks/BBOB/BBOB_requirements.txt
```

For some benchmarks, it might additionally be necessary to download data,
such as surrogate models, in order to run the benchmark. For example for YAHPO, you can
download the surrogate benchmarks with
```bash
mkdir data; cd data; git clone https://github.com/slds-lmu/yahpo_data
```
For some benchmarks, it is additionally necessary to download data,
such as surrogate models, in order to run the benchmark:

- For HPOB, you can download the surrogate benchmarks with
```bash
bash container_recipes/benchmarks/HPOB/download_data.sh
```

- For MFPBench, you can download the surrogate benchmarks with
```bash
bash container_recipes/benchmarks/MFPBench/download_data.sh
```

- For YAHPO, you can download the required surrogate benchmarks and meta-data with
```bash
bash container_recipes/benchmarks/YAHPO/prepare_yahpo.sh
```

0 comments on commit ab4e144

Please sign in to comment.