Environment
- When providing a new environment to the pool, there are a few things to keep in mind:
Code follows the clean code paradigma.
Change logs are true to their descriptions.
Documenting the Environment using the Environment Pool Template.
Environment Pool Template
Environment name with hyperlink to source
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This environment's short introduction, coupled with a representative figure
when possible.
This environment can be imported via:
.. code-block:: python
import ...
Prerequisites
=============
The third party dependencies or steps to prepare the environment should be mentioned here.
General Information
===================
+------------------------------------+-------------------------------------------------------+
| Parameter | Value |
+====================================+=======================================================+
| Agents | |
+------------------------------------+-------------------------------------------------------+
| Native Source | |
+------------------------------------+-------------------------------------------------------+
| Action Space Dimension | |
+------------------------------------+-------------------------------------------------------+
| Action Space Base Set | |
+------------------------------------+-------------------------------------------------------+
| Action Space Boundaries | |
+------------------------------------+-------------------------------------------------------+
| State Space Dimension | |
+------------------------------------+-------------------------------------------------------+
| State Space Base Set | |
+------------------------------------+-------------------------------------------------------+
| State Space Boundaries | |
+------------------------------------+-------------------------------------------------------+
| Reward Structure | |
+------------------------------------+-------------------------------------------------------+
Action Space
============
Description of the action space.
+--------------------+---------------------+-----------------------+
| Actuator | Parameter | Boundaries |
+====================+=====================+=======================+
| | | |
+--------------------+---------------------+-----------------------+
| | | |
+--------------------+---------------------+-----------------------+
State Space
===========
Description of the state space.
+--------------------+---------------------------------------------+-----------------------+
| Element | Parameter | Boundaries |
+====================+=============================================+=======================+
| | | |
+--------------------+---------------------------------------------+-----------------------+
| | | |
+--------------------+---------------------------------------------+-----------------------+
Reward Structure
================
The reward calculation structure. It is possible to include the mathematical background here as well.
.. code-block:: python
reward = ...
Change Log
==========
+--------------------+---------------------------------------------+
| Version | Changes |
+====================+=============================================+
| 0.0.0 | Description of the change |
+--------------------+---------------------------------------------+
Cross Reference
===============
Other documents related to the environment should be referenced here. For example,
the respecitve API Reference.
+ :ref:`API Reference <...>`
If you apply this environment in your research or work, please kindly cite the following related paper:
.. code-block:: bibtex
@article{NoName2021
}