Skip to content

Commit 35c96be

Browse files
author
Sarah Krebs
committed
docs: update installation of example requirements
1 parent 1a8cc8a commit 35c96be

File tree

3 files changed

+11
-12
lines changed

3 files changed

+11
-12
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ pip install deepcave[optuna]
3232
pip install deepcave[bohb]
3333
```
3434

35+
To try the examples for recording your results in DeepCAVE format, run this after installing:
36+
```bash
37+
pip install deepcave[examples]
38+
```
39+
3540
If you want to contribute to DeepCAVE, use the following steps instead:
3641
```bash
3742
git clone https://github.com/automl/DeepCAVE.git
@@ -42,11 +47,6 @@ conda install -c anaconda swig
4247
make install-dev
4348
```
4449

45-
To try the examples for recording your results in DeepCAVE format, run this after installing:
46-
```bash
47-
make install-examples
48-
```
49-
5050
Please visit the [documentation](https://automl.github.io/DeepCAVE/main/installation.html) to get
5151
further help (e.g. if you cannot install redis server or if you are on MacOS).
5252

docs/installation.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ respective packages by running:
2828
pip install deepcave[optuna]
2929
pip install deepcave[bohb]
3030
31+
To try the examples for recording your results in DeepCAVE format, run this after installing:
32+
33+
.. code:: bash
34+
35+
pip install deepcave[examples]
3136
3237
If you want to contribute to DeepCAVE, you can clone it from GitHub and install the dev package:
3338

@@ -39,12 +44,6 @@ If you want to contribute to DeepCAVE, you can clone it from GitHub and install
3944
conda install -c anaconda swig
4045
make install-dev
4146
42-
To try the examples for recording your results in DeepCAVE format, run this after installing:
43-
44-
.. code:: bash
45-
46-
make install-examples
47-
4847
4948
.. warning::
5049

examples/record/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ You can install them via the following command:
1111

1212
.. code-block:: bash
1313
14-
make install-examples
14+
pip install deepcave[examples]

0 commit comments

Comments
 (0)