oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updates to documentation pages

Browse Source
This commit is contained in:
Charlie Crane
2025-02-26 12:03:00 +00:00
parent 7ec664ae67
commit 0d93981ef8
8 changed files with 27 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/source/how_to_guides/custom_environments.rst Normal file
View File

@@ -0,0 +1,31 @@
.. only:: comment
© Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _custom_environments:
Creating Custom Environments for PrimAITE
*****************************************
PrimAITE generates it's training configuration/Environments through ingestion of YAML files. A detailed walkthrough of how to create your own environment can be found within the ``Creating-Custom-Environments`` jupyter notebook.
You configuration file should follow the hierarchy seen below:
.. code:: yaml
metadata:
version: 4.0
io_settings:
...
game:
...
agents:
...
simulation:
...
It's important to include the metadata tag within your YAML file, as this is used to ensure PrimAITE can interpret the configuration correctly. This should also include any plugins that are required for the defined environment, along with their respective version.
For detailed information about each configuration item found within the configuration file, see :ref:`Configurable Items`.