Skip to content

Commit 23e9365

Browse files
Update README.md
1 parent 4a625e3 commit 23e9365

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
# HPOBench
22

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.
44

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
66

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+
[![Build Status](https://github.com/automl/HPOBench/workflows/Test%20Pull%20Requests/badge.svg?branch=master)](https://https://github.com/automl/HPOBench/actions)
9+
[![codecov](https://codecov.io/gh/automl/HPOBench/branch/master/graph/badge.svg)](https://codecov.io/gh/automl/HPOBench)
10+
11+
Status for Development Branch:
12+
[![Build Status](https://github.com/automl/HPOBench/workflows/Test%20Pull%20Requests/badge.svg?branch=development)](https://https://github.com/automl/HPOBench/actions)
13+
[![codecov](https://codecov.io/gh/automl/HPOBench/branch/development/graph/badge.svg)](https://codecov.io/gh/automl/HPOBench)
914

1015
## In 4 lines of code
1116

12-
Run a random configuration within a singularity container
17+
Evaluate a random configuration using a singularity container
1318
```python
1419
from hpobench.container.benchmarks.ml.xgboost_benchmark import XGBoostBenchmark
1520
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
137142
- **A Benchmark fails with `SystemError: Could not start an instance of the benchmark. Retried 5 times` but the container
138143
can be started locally with `singularity instance start <pathtocontainer> test`**
139144
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
142145

143-
Status for Master Branch:
144-
[![Build Status](https://github.com/automl/HPOBench/workflows/Test%20Pull%20Requests/badge.svg?branch=master)](https://https://github.com/automl/HPOBench/actions)
145-
[![codecov](https://codecov.io/gh/automl/HPOBench/branch/master/graph/badge.svg)](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+
146149

147-
Status for Development Branch:
148-
[![Build Status](https://github.com/automl/HPOBench/workflows/Test%20Pull%20Requests/badge.svg?branch=development)](https://https://github.com/automl/HPOBench/actions)
149-
[![codecov](https://codecov.io/gh/automl/HPOBench/branch/development/graph/badge.svg)](https://codecov.io/gh/automl/HPOBench)

0 commit comments

Comments
 (0)