Add comments on Appendix 1 #188

doc/rtd/content/append1/howto.bf.rst

@@ -5,36 +5,43 @@ We provide some examples of `MLPro <https://github.com/fhswf/MLPro.git>`_'s basi
 
 `(Various) Logging <https://github.com/fhswf/MLPro/blob/main/examples/bf/Howto%2001%20-%20(Various)%20Logging.py>`_
 -----------------
+This module demonstrates the Log class functionality.
 
 .. literalinclude:: ../../../../examples/bf/Howto 01 - (Various) Logging.py
     :language: python
 
 `(Various) Timer <https://github.com/fhswf/MLPro/blob/main/examples/bf/Howto%2002%20-%20(Various)%20Timer.py>`_
 -----------------
+This module demonstrates the Timer class functionality.
 
 .. literalinclude:: ../../../../examples/bf/Howto 02 - (Various) Timer.py
     :language: python
 
 `(Math) Spaces, subspaces and elements <https://github.com/fhswf/MLPro/blob/main/examples/bf/Howto%2003%20-%20(Math)%20Spaces%2C%20subspaces%20and%20elements.py>`_
 -----------------
+This module demonstrates how to create a space and subspaces and to spawn elements.
 
 .. literalinclude:: ../../../../examples/bf/Howto 03 - (Math) Spaces, subspaces and elements.py
     :language: python
 
 `(Data) Store, plot, and save variables <https://github.com/fhswf/MLPro/blob/main/examples/bf/Howto%2004%20-%20(Data)%20Store%2C%20plot%2C%20and%20save%20variables.py>`_
 -----------------
+This module demonstrates how to store, plot, save and load variables.
 
 .. literalinclude:: ../../../../examples/bf/Howto 04 - (Data) Store, plot, and save variables.py
     :language: python
 
 `(ML) Hyperparameters setup <https://github.com/fhswf/MLPro/blob/main/examples/bf/Howto%2005%20-%20(ML)%20Hyperparameters%20setup.py>`_
 -----------------
+This module demonstrates how to set-up hyperparameters using available
+HyperParamTupel, HyperParamSpace, and HyperParam classes.
 
 .. literalinclude:: ../../../../examples/bf/Howto 05 - (ML) Hyperparameters setup.py
     :language: python
 
 `(Data) Buffer <https://github.com/fhswf/MLPro/blob/main/examples/bf/Howto%2006%20-%20(Data)%20Buffer.py>`_
 -----------------
+This module demonstrates how to use classes Buffer and BufferElement.
 
 .. literalinclude:: ../../../../examples/bf/Howto 06 - (Data) Buffer.py
     :language: python

doc/rtd/content/append1/howto.gt.rst

@@ -5,13 +5,17 @@ We provide some examples of `MLPro <https://github.com/fhswf/MLPro.git>`_'s GT i
 
 `Run multi-player with own policy in multicartpole game board <https://github.com/fhswf/MLPro/blob/main/examples/gt/Howto%2006%20-%20(GT)%20Run%20multi-player%20with%20own%20policy%20in%20multicartpole%20game%20board.py>`_
 -----------------
+This module shows how to run an own multi-player with the enhanced multi-action game board 
+MultiCartPole based on the OpenAI Gym CartPole environment.
 
 .. literalinclude:: ../../../../examples/gt/Howto 06 - (GT) Run multi-player with own policy in multicartpole game board.py
     :language: python
 
 
 `Train own multi-player with multicartpole game board <https://github.com/fhswf/MLPro/blob/main/examples/gt/Howto%2007%20-%20(GT)%20Train%20own%20multi-player%20with%20multicartpole%20game%20board.py>`_
 -----------------
+This module shows how to train an own multi-player with the enhanced multi-action
+game board MultiCartPole based on the OpenAI Gym CartPole environment.
 
 .. literalinclude:: ../../../../examples/gt/Howto 07 - (GT) Train own multi-player with multicartpole game board.py
     :language: python

doc/rtd/content/append1/howto.rl.rst

@@ -5,104 +5,125 @@ We provide some examples of `MLPro <https://github.com/fhswf/MLPro.git>`_'s RL f
 
 `Types of reward <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2001%20-%20(RL)%20Types%20of%20reward.py>`_
 -----------------
+This module shows how to create and interprete reward objects in own projects.
 
 .. literalinclude:: ../../../../examples/rl/Howto 01 - (RL) Types of reward.py
     :language: python
 
 
 `Run agent with own policy with gym environment <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2002%20-%20(RL)%20Run%20agent%20with%20own%20policy%20with%20gym%20environment.py>`_
 -----------------
+This module shows how to run an own policy inside the standard agent model with an OpenAI Gym environment using 
+the fhswf_at_ml framework.
 
 .. literalinclude:: ../../../../examples/rl/Howto 02 - (RL) Run agent with own policy with gym environment.py
     :language: python
 
 
 `Train agent with own policy on gym environment <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2003%20-%20(RL)%20Train%20agent%20with%20own%20policy%20on%20gym%20environment.py>`_
 -----------------
+This module shows how to train an agent with a custom policy inside on an OpenAI Gym environment using the fhswf_at_ml framework.
+"""
 
 .. literalinclude:: ../../../../examples/rl/Howto 03 - (RL) Train agent with own policy on gym environment.py
     :language: python
 
 
 `Run multi-agent with own policy in multicartpole environment <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2004%20-%20(RL)%20Run%20multi-agent%20with%20own%20policy%20in%20multicartpole%20environment.py>`_
 -----------------
+This module shows how to run an own multi-agent with the enhanced multi-action environment 
+MultiCartPole based on the OpenAI Gym CartPole environment.
 
 .. literalinclude:: ../../../../examples/rl/Howto 04 - (RL) Run multi-agent with own policy in multicartpole environment.py
     :language: python
 
 
 `Train multi-agent with own policy on multicartpole environment <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2005%20-%20(RL)%20Train%20multi-agent%20with%20own%20policy%20on%20multicartpole%20environment.py>`_
 -----------------
+This module shows how to train an own multi-agent with the enhanced multi-action environment 
+MultiCartPole based on the OpenAI Gym CartPole environment.
 
 .. literalinclude:: ../../../../examples/rl/Howto 05 - (RL) Train multi-agent with own policy on multicartpole environment.py
     :language: python
 
 
 `A2C Implementation <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2006%20-%20(RL)%20A2C%20Implementation.py>`_
 -----------------
+This module shows how to implement A2C from the pool
 
 .. literalinclude:: ../../../../examples/rl/Howto 06 - (RL) A2C Implementation.py
     :language: python
 
 
 `Train UR5 Robot environment with A2C Algorithm <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2007%20-%20(RL)%20Train%20UR5%20Robot%20environment%20with%20A2C%20Algorithm.py>`_
 -----------------
+This module shows how to implement A2C on the UR5 Robot Environment
+"""
 
 .. literalinclude:: ../../../../examples/rl/Howto 07 - (RL) Train UR5 Robot environment with A2C Algorithm.py
     :language: python
 
 
 `Run own agents with petting zoo environment <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2008%20-%20(RL)%20Run%20own%20agents%20with%20petting%20zoo%20environment.py>`_
 -----------------
+This module shows how to run an own policy inside the standard agent model with a Petting Zoo environment using 
+the mlpro framework.
 
 .. literalinclude:: ../../../../examples/rl/Howto 08 - (RL) Run own agents with petting zoo environment.py
     :language: python
 
 
 `SAC Implementation <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2009%20-%20(RL)%20SAC%20Implementation.py>`_
 -----------------
+This module shows how to implement SAC from the pool
 
 .. literalinclude:: ../../../../examples/rl/Howto 09 - (RL) SAC Implementation.py
     :language: python
 
 
 `Train using SB3 Wrapper <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2010%20-%20(RL)%20Train%20using%20SB3%20Wrapper.py>`_
 -----------------
+This module shows how to train with SB3 Wrapper for On-Policy Algorithm
 
 .. literalinclude:: ../../../../examples/rl/Howto 10 - (RL) Train using SB3 Wrapper.py
     :language: python
 
 
 `Wrap mlpro Environment class to gym environment <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2011%20-%20(RL)%20Wrap%20mlpro%20Environment%20class%20to%20gym%20environment.py>`_
 -----------------
+This module shows how to wrap mlpro's Environment class to gym compatible.
 
 .. literalinclude:: ../../../../examples/rl/Howto 11 - (RL) Wrap mlpro Environment class to gym environment.py
     :language: python
 
 
 `Wrap mlpro Environment class to petting zoo environment <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2012%20-%20(RL)%20Wrap%20mlpro%20Environment%20class%20to%20petting%20zoo%20environment.py>`_
 -----------------
+This module shows how to wrap mlpro's Environment class to petting zoo compatible.
 
 .. literalinclude:: ../../../../examples/rl/Howto 12 - (RL) Wrap mlpro Environment class to petting zoo environment.py
     :language: python
 
 
 `Comparison Native and Wrapper SB3 Policy <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2013%20-%20(RL)%20Comparison%20Native%20and%20Wrapper%20SB3%20Policy.py>`_
 -----------------
+This module shows how to train with SB3 Wrapper for On-Policy Algorithm
 
 .. literalinclude:: ../../../../examples/rl/Howto 13 - (RL) Comparison Native and Wrapper SB3 Policy.py
     :language: python
 
 
 `Train UR5 with SB3 wrapper <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2014%20-%20(RL)%20Train%20UR5%20with%20SB3%20wrapper.py>`_
 -----------------
+This module shows how to use SB3 wrapper to train UR5 robot
 
 .. literalinclude:: ../../../../examples/rl/Howto 14 - (RL) Train UR5 with SB3 wrapper.py
     :language: python
 
 
 `Train Robothtm with SB3 Wrapper <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2015%20-%20(RL)%20Train%20Robothtm%20with%20SB3%20Wrapper.py>`_
 -----------------
+This module shows how to use SB3 wrapper to train Robothtm
 
 .. literalinclude:: ../../../../examples/rl/Howto 15 - (RL) Train Robothtm with SB3 Wrapper.py
     :language: python

doc/rtd/content/append1/howto.ui.rst

@@ -5,13 +5,16 @@ We provide some examples of `MLPro <https://github.com/fhswf/MLPro.git>`_'s SciU
 
 `Reuse of interactive 2D,3D input space <https://github.com/fhswf/MLPro/blob/main/examples/sciui/Howto%2001%20(SciUI)%20-%20Reuse%20of%20interactive%202D%2C3D%20input%20space.py>`_
 -----------------
+Demo scenarios for SciUI framework that shows the reuse of the interactive 2D/3D input space class.
+Can be executed directly...
 
 .. literalinclude:: ../../../../examples/sciui/Howto 01 (SciUI) - Reuse of interactive 2D,3D input space.py
     :language: python
 
 
 `Reinforcement learning cockpit <https://github.com/fhswf/MLPro/blob/main/examples/sciui/Howto%2002%20(SciUI)%20-%20Reinforcement%20learning%20cockpit.py>`_
 -----------------
+SciUI template for a Reinforcement Learning simulation.
 
 .. literalinclude:: ../../../../examples/sciui/Howto 02 (SciUI) - Reinforcement learning cockpit.py
     :language: python