-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update howto doc according to Template #188
- Loading branch information
1 parent
40edfcd
commit b198941
Showing
27 changed files
with
615 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,40 @@ | ||
`Howto 02 - (Various) Timer <https://github.com/fhswf/MLPro/blob/main/examples/bf/Howto%2002%20-%20(Various)%20Timer.py>`_ | ||
================ | ||
Ver. 1.0.1 (2021-11-13) | ||
|
||
This module demonstrates the Timer class functionality. | ||
|
||
Prerequisites | ||
````````````````` | ||
|
||
Please install the following packages to run this examples properly: | ||
- :ref:`MLPro <Installation>` | ||
.. | ||
- `Matplotlib <https://pypi.org/project/matplotlib/>`_ | ||
.. | ||
- `NumPy <https://pypi.org/project/numpy/>`_ | ||
.. | ||
- `Pytorch <https://pypi.org/project/torch/>`_ | ||
.. | ||
- `OpenAI Gym <https://pypi.org/project/gym/>`_ | ||
.. | ||
- `PettingZoo <https://pypi.org/project/PettingZoo/>`_ | ||
.. | ||
- `Stable-Baselines3 <https://pypi.org/project/stable-baselines3/>`_ | ||
.. | ||
- `Optuna <https://pypi.org/project/optuna/>`_ | ||
.. | ||
- `Hyperopt <https://pypi.org/project/hyperopt/>`_ | ||
.. | ||
- `ROS <http://wiki.ros.org/noetic/Installation>`_ | ||
Example Code | ||
````````````````` | ||
|
||
.. literalinclude:: ../../../../../examples/bf/Howto 02 - (Various) Timer.py | ||
:language: python | ||
|
||
Results | ||
````````````````` | ||
Descriptions, plots, images, screenshots of expected results. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,22 @@ | ||
`Howto 03 - (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>`_ | ||
================ | ||
Ver. 1.0.2 (2021-12-03) | ||
|
||
This module demonstrates how to create a space and subspaces and to spawn elements. | ||
|
||
Prerequisites | ||
````````````````` | ||
|
||
Please install the following packages to run this examples properly: | ||
- :ref:`MLPro <Installation>` | ||
- `NumPy <https://pypi.org/project/numpy/>`_ | ||
|
||
Example Code | ||
````````````````` | ||
|
||
.. literalinclude:: ../../../../../examples/bf/Howto 03 - (Math) Spaces, subspaces and elements.py | ||
:language: python | ||
|
||
Results | ||
````````````````` | ||
Descriptions, plots, images, screenshots of expected results. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,24 @@ | ||
`Howto 04 - (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>`_ | ||
================ | ||
Ver. 1.2.3 (2021-10-26) | ||
|
||
This module demonstrates how to store, plot, save and load variables. | ||
|
||
Prerequisites | ||
````````````````` | ||
|
||
Please install the following packages to run this examples properly: | ||
- :ref:`MLPro <Installation>` | ||
- `NumPy <https://pypi.org/project/numpy/>`_ | ||
- `Matplotlib <https://pypi.org/project/matplotlib/>`_ | ||
|
||
|
||
Example Code | ||
````````````````` | ||
|
||
.. literalinclude:: ../../../../../examples/bf/Howto 04 - (Data) Store, plot, and save variables.py | ||
:language: python | ||
|
||
|
||
Results | ||
````````````````` | ||
Descriptions, plots, images, screenshots of expected results. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,25 @@ | ||
`Howto 05 - (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. | ||
Ver. 1.0.1 (2021-12-10) | ||
|
||
This module demonstrates how to set-up hyperparameters using available HyperParamTuple, | ||
HyperParamSpace, and HyperParam classes. | ||
|
||
Prerequisites | ||
````````````````` | ||
|
||
Please install the following packages to run this examples properly: | ||
- :ref:`MLPro <Installation>` | ||
- `NumPy <https://pypi.org/project/numpy/>`_ | ||
- `Matplotlib <https://pypi.org/project/matplotlib/>`_ | ||
|
||
|
||
Example Code | ||
````````````````` | ||
|
||
.. literalinclude:: ../../../../../examples/bf/Howto 05 - (ML) Hyperparameters setup.py | ||
:language: python | ||
|
||
|
||
Results | ||
````````````````` | ||
Descriptions, plots, images, screenshots of expected results. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,24 @@ | ||
`Howto 06 - (Data) Buffer <https://github.com/fhswf/MLPro/blob/main/examples/bf/Howto%2006%20-%20(Data)%20Buffer.py>`_ | ||
================ | ||
Ver. 1.0.0 (2021-10-26) | ||
|
||
This module demonstrates how to use classes Buffer and BufferElement. | ||
|
||
Prerequisites | ||
````````````````` | ||
|
||
Please install the following packages to run this examples properly: | ||
- :ref:`MLPro <Installation>` | ||
- `NumPy <https://pypi.org/project/numpy/>`_ | ||
- `Matplotlib <https://pypi.org/project/matplotlib/>`_ | ||
|
||
|
||
Example Code | ||
````````````````` | ||
|
||
.. literalinclude:: ../../../../../examples/bf/Howto 06 - (Data) Buffer.py | ||
:language: python | ||
:language: python | ||
|
||
Results | ||
````````````````` | ||
Descriptions, plots, images, screenshots of expected results. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,29 @@ | ||
`Howto 06 - (GT) 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>`_ | ||
================ | ||
Ver. 1.1.0 (2021-11-15) | ||
|
||
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. | ||
|
||
Prerequisites | ||
````````````````` | ||
|
||
Please install the following packages to run this examples properly: | ||
- :ref:`MLPro <Installation>` | ||
- `NumPy <https://pypi.org/project/numpy/>`_ | ||
- `Matplotlib <https://pypi.org/project/matplotlib/>`_ | ||
- `OpenAI Gym <https://pypi.org/project/gym/>`_ | ||
- `Pytorch <https://pypi.org/project/torch/>`_ | ||
- `Stable-Baselines3 <https://pypi.org/project/stable-baselines3/>`_ | ||
- `PettingZoo <https://pypi.org/project/PettingZoo/>`_ | ||
- `Pyglet <https://pypi.org/project/pyglet/>`_ | ||
|
||
Example Code | ||
````````````````` | ||
|
||
.. literalinclude:: ../../../../../examples/gt/Howto 06 - (GT) Run multi-player with own policy in multicartpole game board.py | ||
:language: python | ||
|
||
Results | ||
````````````````` | ||
Descriptions, plots, images, screenshots of expected results. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,30 @@ | ||
`Howto 07 - (GT) 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>`_ | ||
================ | ||
Ver. 1.2.1 (2021-12-07) | ||
|
||
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. | ||
""" | ||
|
||
Prerequisites | ||
````````````````` | ||
|
||
Please install the following packages to run this examples properly: | ||
- :ref:`MLPro <Installation>` | ||
- `NumPy <https://pypi.org/project/numpy/>`_ | ||
- `Matplotlib <https://pypi.org/project/matplotlib/>`_ | ||
- `OpenAI Gym <https://pypi.org/project/gym/>`_ | ||
- `Pytorch <https://pypi.org/project/torch/>`_ | ||
- `Stable-Baselines3 <https://pypi.org/project/stable-baselines3/>`_ | ||
- `PettingZoo <https://pypi.org/project/PettingZoo/>`_ | ||
- `Pyglet <https://pypi.org/project/pyglet/>`_ | ||
|
||
Example Code | ||
````````````````` | ||
|
||
.. literalinclude:: ../../../../../examples/gt/Howto 07 - (GT) Train own multi-player with multicartpole game board.py | ||
:language: python | ||
:language: python | ||
|
||
Results | ||
````````````````` | ||
Descriptions, plots, images, screenshots of expected results. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,41 @@ | ||
`Howto 01 - (RL) Types of reward <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2001%20-%20(RL)%20Types%20of%20reward.py>`_ | ||
================ | ||
Ver. 1.0.0 (2021-09-11) | ||
|
||
This module shows how to create and interprete reward objects in own projects. | ||
|
||
Prerequisites | ||
````````````````` | ||
|
||
Please install the following packages to run this examples properly: | ||
- :ref:`MLPro <Installation>` | ||
.. | ||
- `NumPy <https://pypi.org/project/numpy/>`_ | ||
.. | ||
- `Matplotlib <https://pypi.org/project/matplotlib/>`_ | ||
.. | ||
- `OpenAI Gym <https://pypi.org/project/gym/>`_ | ||
.. | ||
- `Pytorch <https://pypi.org/project/torch/>`_ | ||
.. | ||
- `Stable-Baselines3 <https://pypi.org/project/stable-baselines3/>`_ | ||
.. | ||
- `PettingZoo <https://pypi.org/project/PettingZoo/>`_ | ||
.. | ||
- `Optuna <https://pypi.org/project/optuna/>`_ | ||
.. | ||
- `Hyperopt <https://pypi.org/project/hyperopt/>`_ | ||
.. | ||
- `ROS <http://wiki.ros.org/noetic/Installation>`_ | ||
Example Code | ||
````````````````` | ||
|
||
.. literalinclude:: ../../../../../examples/rl/Howto 01 - (RL) Types of reward.py | ||
:language: python | ||
|
||
Results | ||
````````````````` | ||
Descriptions, plots, images, screenshots of expected results. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,42 @@ | ||
`Howto 02 - (RL) 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>`_ | ||
================ | ||
Ver. 1.2.2 (2021-12-03) | ||
|
||
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. | ||
|
||
Prerequisites | ||
````````````````` | ||
|
||
Please install the following packages to run this examples properly: | ||
- :ref:`MLPro <Installation>` | ||
.. | ||
- `NumPy <https://pypi.org/project/numpy/>`_ | ||
.. | ||
- `Matplotlib <https://pypi.org/project/matplotlib/>`_ | ||
.. | ||
- `OpenAI Gym <https://pypi.org/project/gym/>`_ | ||
.. | ||
- `Pytorch <https://pypi.org/project/torch/>`_ | ||
.. | ||
- `Stable-Baselines3 <https://pypi.org/project/stable-baselines3/>`_ | ||
.. | ||
- `PettingZoo <https://pypi.org/project/PettingZoo/>`_ | ||
.. | ||
- `Optuna <https://pypi.org/project/optuna/>`_ | ||
.. | ||
- `Hyperopt <https://pypi.org/project/hyperopt/>`_ | ||
.. | ||
- `ROS <http://wiki.ros.org/noetic/Installation>`_ | ||
Example Code | ||
````````````````` | ||
|
||
.. literalinclude:: ../../../../../examples/rl/Howto 02 - (RL) Run agent with own policy with gym environment.py | ||
:language: python | ||
|
||
Results | ||
````````````````` | ||
Descriptions, plots, images, screenshots of expected results. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,40 @@ | ||
`Howto 03 - (RL) 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>`_ | ||
================ | ||
Ver. 1.3.2 (2021-12-07) | ||
|
||
This module shows how to train an agent with a custom policy inside on an OpenAI Gym environment using the fhswf_at_ml framework. | ||
""" | ||
|
||
Prerequisites | ||
````````````````` | ||
|
||
Please install the following packages to run this examples properly: | ||
- :ref:`MLPro <Installation>` | ||
.. | ||
- `NumPy <https://pypi.org/project/numpy/>`_ | ||
.. | ||
- `Matplotlib <https://pypi.org/project/matplotlib/>`_ | ||
.. | ||
- `OpenAI Gym <https://pypi.org/project/gym/>`_ | ||
.. | ||
- `Pytorch <https://pypi.org/project/torch/>`_ | ||
.. | ||
- `Stable-Baselines3 <https://pypi.org/project/stable-baselines3/>`_ | ||
.. | ||
- `PettingZoo <https://pypi.org/project/PettingZoo/>`_ | ||
.. | ||
- `Optuna <https://pypi.org/project/optuna/>`_ | ||
.. | ||
- `Hyperopt <https://pypi.org/project/hyperopt/>`_ | ||
.. | ||
- `ROS <http://wiki.ros.org/noetic/Installation>`_ | ||
Example Code | ||
````````````````` | ||
|
||
.. literalinclude:: ../../../../../examples/rl/Howto 03 - (RL) Train agent with own policy on gym environment.py | ||
:language: python | ||
:language: python | ||
|
||
Results | ||
````````````````` | ||
Descriptions, plots, images, screenshots of expected results. |
Oops, something went wrong.