Merge pull request #184 from automl/docs/installation-of-extra-reqs

Docs/installation of extra reqs

Author: sarah-segel

CHANGELOG.md

@@ -1,3 +1,8 @@
+# Version 1.3.1
+
+## Quality of Life
+- Improved documentation on installation of extra requirements.
+
 # Version 1.3
 
 ## Converters

README.md

@@ -25,7 +25,14 @@ conda install -c anaconda swig
 pip install DeepCAVE
 ```
 
-If you want to contribute to DeepCAVE use the following steps instead:
+To load runs created with Optuna or the BOHB optimizer, you need to install the
+respective packages by running:
+```bash
+pip install deepcave[optuna]
+pip install deepcave[bohb]
+```
+
+If you want to contribute to DeepCAVE, use the following steps instead:
 ```bash
 git clone https://github.com/automl/DeepCAVE.git
 cd DeepCAVE
@@ -35,18 +42,11 @@ conda install -c anaconda swig
 make install-dev
 ```
 
-If you want to try the examples for recording your results in DeepCAVE format, run this after installing:
+To try the examples for recording your results in DeepCAVE format, run this after installing:
 ```bash
 make install-examples
 ```
 
-To load runs created with Optuna or the BOHB optimizer, you need to install the
-respective packages by running:
-```bash
-make install-optuna
-make install-bohb
-```
-
 Please visit the [documentation](https://automl.github.io/DeepCAVE/main/installation.html) to get
 further help (e.g. if you cannot install redis server or if you are on MacOS).
 

deepcave/runs/converters/bohb.py

@@ -100,7 +100,7 @@ def from_path(cls, path: Union[Path, str]) -> "BOHBRun":
         except ImportError:
             raise ImportError(
                 "The HpBandSter package is required to load BOHB runs. "
-                "Please install it via `make install-bohb`"
+                "Please install it via `pip install deepcave[bohb]`"
             )
 
         bohb = logged_results_to_HBS_result(str(path))

deepcave/runs/converters/optuna.py

@@ -134,7 +134,7 @@ def from_path(cls, path: Union[Path, str]) -> "OptunaRun":
         except ImportError:
             raise ImportError(
                 "The Optuna package is required to load Optuna runs. "
-                "Please install it via `make install-optuna`"
+                "Please install it via `pip install deepcave[optuna]`"
             )
 
         # Load the optuna study from the file path

docs/converters/bohb.rst

@@ -5,4 +5,4 @@ To load an BOHB run into DeepCAVE, it is necessary to install HpBandSter, e.g. v
 
    .. code-block:: bash
 
-        make install-bohb
+        pip install deepcave[bohb]

docs/converters/optuna.rst

@@ -26,7 +26,7 @@ Furthermore, to load an Optuna run into DeepCAVE, it is necessary to install Opt
 
    .. code-block:: bash
 
-        make install-optuna
+        pip install deepcave[optuna]
 
 .. warning::
     Loading Optuna runs with conditional search spaces or dynamic hyperparameter value ranges

docs/installation.rst

@@ -20,6 +20,14 @@ installed directly. If you use a different environment, make sure that
     conda install -c anaconda swig
     pip install DeepCAVE
 
+To load runs created with Optuna or the BOHB optimizer, you need to install the
+respective packages by running:
+
+.. code:: bash
+
+    pip install deepcave[optuna]
+    pip install deepcave[bohb]
+
 
 If you want to contribute to DeepCAVE, you can clone it from GitHub and install the dev package:
 
@@ -31,6 +39,13 @@ If you want to contribute to DeepCAVE, you can clone it from GitHub and install
     conda install -c anaconda swig
     make install-dev
 
+To try the examples for recording your results in DeepCAVE format, run this after installing:
+
+.. code:: bash
+
+    make install-examples
+
+
 .. warning::
 
     DeepCAVE is officially tested and supported on Linux platforms.