Examples
We provide some examples of MLPro’s … funcionalities implementation, which is available on our GitHub file. For new examples, there are several items that needs to be checked:
Code follows the clean code paradigma.
Descriptions of the examples are clear.
Documenting the Examples using the How To Template.
How To Template
Title with hyperlink to source
-----------------
Ver. 0.0.0 (YYYY-MM-DD)
This module description ...
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>`_
Results
`````````````````
Descriptions, plots, images, screenshots of expected results.
Example Code
`````````````````
.. literalinclude:: ../../../template.py
:language: python