Documentation

fhswf · Feb 15, 2024 · 7bc0558 · 7bc0558
1 parent 18e16fb
commit 7bc0558
Show file tree

Hide file tree

Showing 17 changed files with 154 additions and 59 deletions.
diff --git a/.../content/04_appendices/appendix1/main.rst → .../content/02_appendices/appendix1/main.rst b/.../content/04_appendices/appendix1/main.rst → .../content/02_appendices/appendix1/main.rst
@@ -1,5 +1,5 @@
 .. _target_appendix1:
-A1 - Custom Appendix
+A1 - Example Pool
 ====================
 
 .. toctree::

diff --git a/doc/rtd/content/02_appendices/appendix1/sub/03_howto.rl.rst b/doc/rtd/content/02_appendices/appendix1/sub/03_howto.rl.rst
@@ -0,0 +1,11 @@
+.. _target_appendix1_Hyperopt:
+MLPro - Hyperparameter Optimization using Hyperopt
+=================================
+
+The following examples demonstrate functionalities of the integration of Hyperopt into MLPro:
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   sub/*
diff --git a/doc/rtd/content/02_appendices/appendix1/sub/howto.rl.ht.001.rst b/doc/rtd/content/02_appendices/appendix1/sub/howto.rl.ht.001.rst
@@ -0,0 +1,71 @@
+.. _Howto RL HT 001:
+Howto RL-HT-001: Hyperparameter Tuning using Hyperopt
+=====================================================
+
+**Prerequisites**
+
+Please install the following packages to run this examples properly:
+
+    - `Hyperopt <https://pypi.org/project/hyperopt/>`_
+
+
+
+**Executable code**
+
+.. literalinclude:: ../../../../../../../../test/howtos/rl/howto_rl_ht_001_hyperopt.py
+	:language: python
+
+
+
+**Results**
+
+.. code-block:: bashh
+
+    2023-02-12  16:44:58.495569  I  HyperParam Tuner "Hyperopt": Instantiated
+    2023-02-12  16:44:58.496565  I  HyperParam Tuner "Hyperopt": Wrapped package hyperopt installed in version 0.2.7
+    2023-02-12  16:44:58.496565  I  HyperParam Tuner "Hyperopt": Hyperopt configuration is successful
+    2023-02-12  16:44:58.496565  I  Training "RL": Instantiated
+    2023-02-12  16:44:58.497574  I  Training "RL": Training started (with hyperparameter tuning)
+    2023-02-12  16:44:58.503565  I  HyperParam Tuner "Hyperopt": Spaces for hyperopt is ready
+    2023-02-12  16:44:58.503565  I  HyperParam Tuner "Hyperopt": ------------------------------------------------------------------------------
+
+    2023-02-12  16:44:58.536565
+    I  HyperParam Tuner "Hyperopt":
+    Trial number 0 has started
+
+    2023-02-12  16:44:58.537565
+    I  HyperParam Tuner "Hyperopt":
+    ------------------------------------------------------------------------------
+
+    2023-02-12  16:45:00.336566
+    I  HyperParam Tuner "Hyperopt":
+    Trial number 1 has finished
+
+    2023-02-12  16:45:00.337566
+    I  HyperParam Tuner "Hyperopt":
+    ------------------------------------------------------------------------------
+
+    2023-02-12  16:45:00.353564
+    I  HyperParam Tuner "Hyperopt":
+    Trial number 1 has started
+
+    2023-02-12  16:45:00.353564
+    I  HyperParam Tuner "Hyperopt":
+    ------------------------------------------------------------------------------
+
+    2023-02-12  16:45:02.055567
+    I  HyperParam Tuner "Hyperopt":
+    Trial number 2 has finished
+
+    2023-02-12  16:45:02.056566
+    I  HyperParam Tuner "Hyperopt":
+    ------------------------------------------------------------------------------
+
+
+
+**Cross Reference**
+
+    - :ref:`API Reference - RL Agent <target_api_rl_agents>`
+    - :ref:`API Reference - RL Environments <target_api_rl_env>`
+    - :ref:`API Reference - RL Scenario and Training <target_api_rl_run_train>`
+    - :ref:`API Reference - Machine Learning <target_api_bf_ml>`
diff --git a/..._part/custom_section1/sub/images/.gitkeep → ..._appendices/appendix1/sub/images/.gitkeep b/..._part/custom_section1/sub/images/.gitkeep → ..._appendices/appendix1/sub/images/.gitkeep
diff --git a/doc/rtd/content/02_appendices/appendix1/sub/sub/howto.rl.ht.001.rst b/doc/rtd/content/02_appendices/appendix1/sub/sub/howto.rl.ht.001.rst
@@ -0,0 +1,71 @@
+.. _Howto RL HT 001:
+Howto RL-HT-001: Hyperparameter Tuning using Hyperopt
+=====================================================
+
+**Prerequisites**
+
+Please install the following packages to run this examples properly:
+
+    - `Hyperopt <https://pypi.org/project/hyperopt/>`_
+
+
+
+**Executable code**
+
+.. literalinclude:: ../../../../../../../../test/howtos/rl/howto_rl_ht_001_hyperopt.py
+	:language: python
+
+
+
+**Results**
+
+.. code-block:: bashh
+
+    2023-02-12  16:44:58.495569  I  HyperParam Tuner "Hyperopt": Instantiated
+    2023-02-12  16:44:58.496565  I  HyperParam Tuner "Hyperopt": Wrapped package hyperopt installed in version 0.2.7
+    2023-02-12  16:44:58.496565  I  HyperParam Tuner "Hyperopt": Hyperopt configuration is successful
+    2023-02-12  16:44:58.496565  I  Training "RL": Instantiated
+    2023-02-12  16:44:58.497574  I  Training "RL": Training started (with hyperparameter tuning)
+    2023-02-12  16:44:58.503565  I  HyperParam Tuner "Hyperopt": Spaces for hyperopt is ready
+    2023-02-12  16:44:58.503565  I  HyperParam Tuner "Hyperopt": ------------------------------------------------------------------------------
+
+    2023-02-12  16:44:58.536565
+    I  HyperParam Tuner "Hyperopt":
+    Trial number 0 has started
+
+    2023-02-12  16:44:58.537565
+    I  HyperParam Tuner "Hyperopt":
+    ------------------------------------------------------------------------------
+
+    2023-02-12  16:45:00.336566
+    I  HyperParam Tuner "Hyperopt":
+    Trial number 1 has finished
+
+    2023-02-12  16:45:00.337566
+    I  HyperParam Tuner "Hyperopt":
+    ------------------------------------------------------------------------------
+
+    2023-02-12  16:45:00.353564
+    I  HyperParam Tuner "Hyperopt":
+    Trial number 1 has started
+
+    2023-02-12  16:45:00.353564
+    I  HyperParam Tuner "Hyperopt":
+    ------------------------------------------------------------------------------
+
+    2023-02-12  16:45:02.055567
+    I  HyperParam Tuner "Hyperopt":
+    Trial number 2 has finished
+
+    2023-02-12  16:45:02.056566
+    I  HyperParam Tuner "Hyperopt":
+    ------------------------------------------------------------------------------
+
+
+
+**Cross Reference**
+
+    - :ref:`API Reference - RL Agent <target_api_rl_agents>`
+    - :ref:`API Reference - RL Environments <target_api_rl_env>`
+    - :ref:`API Reference - RL Scenario and Training <target_api_rl_run_train>`
+    - :ref:`API Reference - Machine Learning <target_api_bf_ml>`
diff --git a/.../content/04_appendices/appendix2/main.rst → .../content/02_appendices/appendix2/main.rst b/.../content/04_appendices/appendix2/main.rst → .../content/02_appendices/appendix2/main.rst
diff --git a/..._appendices/appendix2/sub/01_wrappers.rst → ..._appendices/appendix2/sub/01_wrappers.rst b/..._appendices/appendix2/sub/01_wrappers.rst → ..._appendices/appendix2/sub/01_wrappers.rst
diff --git a/...dices/appendix2/sub/wrappers/hyperopt.rst → ...dices/appendix2/sub/wrappers/hyperopt.rst b/...dices/appendix2/sub/wrappers/hyperopt.rst → ...dices/appendix2/sub/wrappers/hyperopt.rst
diff --git a/doc/rtd/content/02_custom_part/custom_section1/main.rst b/doc/rtd/content/02_custom_part/custom_section1/main.rst
diff --git a/doc/rtd/content/02_custom_part/custom_section1/sub/01_overview.rst b/doc/rtd/content/02_custom_part/custom_section1/sub/01_overview.rst
diff --git a/doc/rtd/content/03_custom_part/custom_section2/main.rst b/doc/rtd/content/03_custom_part/custom_section2/main.rst
diff --git a/doc/rtd/content/03_custom_part/custom_section2/sub/01_overview.rst b/doc/rtd/content/03_custom_part/custom_section2/sub/01_overview.rst
diff --git a/doc/rtd/content/03_custom_part/custom_section2/sub/images/.gitkeep b/doc/rtd/content/03_custom_part/custom_section2/sub/images/.gitkeep
diff --git a/doc/rtd/content/04_appendices/appendix1/sub/01_overview.rst b/doc/rtd/content/04_appendices/appendix1/sub/01_overview.rst
diff --git a/doc/rtd/content/04_appendices/appendix1/sub/images/.gitkeep b/doc/rtd/content/04_appendices/appendix1/sub/images/.gitkeep
diff --git a/doc/rtd/content/04_appendices/appendix2/sub/wrappers/gymnasium.rst b/doc/rtd/content/04_appendices/appendix2/sub/wrappers/gymnasium.rst
diff --git a/doc/rtd/index.rst b/doc/rtd/index.rst
@@ -40,16 +40,6 @@ Welcome to ...
 
 
 
-.. toctree::
-   :maxdepth: 3
-   :caption: Welcome to ...
-   :glob:
-   :numbered:
-
-   content/01_welcome/sub/*
-
-
-
 .. toctree::
    :maxdepth: 3
    :caption: Appendices