Skip to content

Commit

Permalink
Creation of appendix 1 submenus #188
Browse files Browse the repository at this point in the history
  • Loading branch information
budiatmadjajaWill committed Dec 6, 2021
1 parent e312731 commit fbc943b
Show file tree
Hide file tree
Showing 7 changed files with 47 additions and 56 deletions.
11 changes: 11 additions & 0 deletions doc/rtd/content/append1/howto.bf.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Basic Functions
================

We provide some examples of `MLPro <https://github.com/fhswf/MLPro.git>`_'s basic funcionalities implementation, which is available on our GitHub file.

- File 01: `(Various) Log and Timer <https://github.com/fhswf/MLPro/blob/main/examples/bf/Howto%2001%20-%20(Various)%20Log%20and%20timer.py>`_
- File 02: `(Math) Spaces, subspaces and elements <https://github.com/fhswf/MLPro/blob/main/examples/bf/Howto%2002%20-%20(Math)%20Spaces%2C%20subspaces%20and%20elements.py>`_
- File 03: `(Various) Store, plot, and save variables <https://github.com/fhswf/MLPro/blob/main/examples/bf/Howto%2003%20-%20(Various)%20Store%2C%20plot%2C%20and%20save%20variables.py>`_
- File 04: `(ML) Hyperparameters setup <https://github.com/fhswf/MLPro/blob/main/examples/bf/Howto%2004%20-%20(ML)%20Hyperparameters%20setup.py>`_

Moreover, you can find the UML diagram of MLPro's basic funcionalities `here <https://github.com/fhswf/MLPro/tree/main/doc/bf>`_.
9 changes: 9 additions & 0 deletions doc/rtd/content/append1/howto.gt.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Game Theory
================

We provide some examples of `MLPro <https://github.com/fhswf/MLPro.git>`_'s GT implementation, which is available on our GitHub file.

- File 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>`_
- File 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>`_

Moreover, you can find the UML diagram of MLPro's GT funcionalities `here <https://github.com/fhswf/MLPro/tree/main/doc/gt>`_.
14 changes: 14 additions & 0 deletions doc/rtd/content/append1/howto.rl.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Reinforcement Learning
================

We provide some examples of `MLPro <https://github.com/fhswf/MLPro.git>`_'s RL funcionalities implementation, which is available on our GitHub file.

- File 01: `(RL) Types of reward <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2001%20-%20(RL)%20Types%20of%20reward.py>`_
- File 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>`_
- File 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%20%20gym%20environment.py>`_
- File 04: `(RL) 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>`_
- File 05: `(RL) 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>`_
- File 06: `(RL) A2C Implementation <https://github.com/fhswf/MLPro/blob/main/examples/rl/Howto%2006%20-%20(RL)%20A2C%20Implementation.py>`_
- File 08: `(RL) 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>`_

Moreover, you can find the UML diagram of MLPro's RL funcionalities `here <https://github.com/fhswf/MLPro/tree/main/doc/rl>`_.
50 changes: 0 additions & 50 deletions doc/rtd/content/append1/howto.rst

This file was deleted.

8 changes: 8 additions & 0 deletions doc/rtd/content/append1/howto.ui.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
User Interface
================

We provide some examples of `MLPro <https://github.com/fhswf/MLPro.git>`_'s SciUI funcionalities implementation, which is available on our GitHub file.

- File 01: `(SciUI) - 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>`_

Moreover, you can find the UML diagram of MLPro's UI funcionalities `here <https://github.com/fhswf/MLPro/tree/main/doc/sciui>`_.
4 changes: 0 additions & 4 deletions doc/rtd/content/append1/test.rst

This file was deleted.

7 changes: 5 additions & 2 deletions doc/rtd/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,13 @@ Instructions for use
content/ui/sciui

.. toctree::
:maxdepth: 2
:maxdepth: 4
:caption: Appendix 1: List of Examples

content/append1/test
content/append1/howto.bf
content/append1/howto.rl
content/append1/howto.gt
content/append1/howto.ui

.. toctree::
:maxdepth: 4
Expand Down

0 comments on commit fbc943b

Please sign in to comment.