|
1 | 1 | # HPOBench |
2 | 2 |
|
3 | | -HPOBench is a library for hyperparameter optimization and black-box optimization benchmark with a focus on reproducibility. |
| 3 | +HPOBench is a library for providing benchmarks for (multi-fidelity) hyperparameter optimization and with a focus on reproducibility. |
4 | 4 |
|
5 | | -**Note:** HPOBench is under active construction. Stay tuned for more benchmarks. Information on how to contribute a new benchmark will follow shortly. |
| 5 | +## Status |
6 | 6 |
|
7 | | -**Note:** If you are looking for a different or older version of our benchmarking library, you might be looking for |
8 | | - [HPOlib1.5](https://github.com/automl/HPOlib1.5) |
| 7 | +Status for Master Branch: |
| 8 | +[](https://https://github.com/automl/HPOBench/actions) |
| 9 | +[](https://codecov.io/gh/automl/HPOBench) |
| 10 | + |
| 11 | +Status for Development Branch: |
| 12 | +[](https://https://github.com/automl/HPOBench/actions) |
| 13 | +[](https://codecov.io/gh/automl/HPOBench) |
9 | 14 |
|
10 | 15 | ## In 4 lines of code |
11 | 16 |
|
12 | | -Run a random configuration within a singularity container |
| 17 | +Evaluate a random configuration using a singularity container |
13 | 18 | ```python |
14 | 19 | from hpobench.container.benchmarks.ml.xgboost_benchmark import XGBoostBenchmark |
15 | 20 | b = XGBoostBenchmark(task_id=167149, container_source='library://phmueller/automl', rng=1) |
@@ -137,13 +142,8 @@ the used container. When starting an experiment, HPOBench writes automatically t |
137 | 142 | - **A Benchmark fails with `SystemError: Could not start an instance of the benchmark. Retried 5 times` but the container |
138 | 143 | can be started locally with `singularity instance start <pathtocontainer> test`** |
139 | 144 | See whether in `~/.singularity/instances/sing/$HOSTNAME/*/` there is a file that does not end with '}'. If yes delete this file and retry. |
140 | | - |
141 | | -## Status |
142 | 145 |
|
143 | | -Status for Master Branch: |
144 | | -[](https://https://github.com/automl/HPOBench/actions) |
145 | | -[](https://codecov.io/gh/automl/HPOBench) |
| 146 | +**Note:** If you are looking for a different or older version of our benchmarking library, you might be looking for |
| 147 | + [HPOlib1.5](https://github.com/automl/HPOlib1.5) |
| 148 | + |
146 | 149 |
|
147 | | -Status for Development Branch: |
148 | | -[](https://https://github.com/automl/HPOBench/actions) |
149 | | -[](https://codecov.io/gh/automl/HPOBench) |
0 commit comments