Files
PrimAITE/docs/source/config.rst

22 lines
1.1 KiB
ReStructuredText
Raw Normal View History

.. only:: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
2023-10-25 17:19:24 +01:00
Primaite v3 config
******************
2023-12-04 09:14:20 +00:00
PrimAITE uses a single configuration file to define everything needed to train and evaluate an RL policy in a custom cybersecurity scenario. This includes the configuration of the network, the scripted or trained agents that interact with the network, as well as settings that define how to perform training in Stable Baselines 3 or Ray RLLib.
The entire config is used by the ``PrimaiteSession`` object for users who wish to let PrimAITE handle the agent definition and training. If you wish to define custom agents and control the training loop yourself, you can use the config with the ``PrimaiteGame``, and ``PrimaiteGymEnv`` objects instead. That way, only the network configuration and agent setup parts of the config are used, and the training section is ignored.
2023-12-04 09:14:20 +00:00
Configurable items
##################
2023-12-04 09:14:20 +00:00
.. toctree::
:maxdepth: 1
2023-12-04 09:14:20 +00:00
configuration/training_config.rst
configuration/io_settings.rst
configuration/game.rst
configuration/agents.rst
configuration/simulation.rst