Files
PrimAITE/docs/source/config.rst

14 lines
1.2 KiB
ReStructuredText
Raw Normal View History

2023-10-25 17:19:24 +01:00
Primaite v3 config
******************
2023-10-25 17:19:24 +01:00
PrimAITE uses a single configuration file to define a cybersecurity scenario. This includes the computer network and multiple agents. There are three main sections: training_config, game, and simulation.
2023-10-25 17:19:24 +01:00
The simulation section describes the simulated network environment with which the agetns interact.
2023-10-25 17:19:24 +01:00
The game section describes the agents and their capabilities. Each agent has a unique type and is associated with a team (GREEN, RED, or BLUE). Each agent has a configurable observation space, action space, and reward function.
2023-10-25 17:19:24 +01:00
The training_config section describes the training parameters for the learning agents. This includes the number of episodes, the number of steps per episode, and the number of steps before the agents start learning. The training_config section also describes the learning algorithm used by the agents. The learning algorithm is specified by the name of the algorithm and the hyperparameters for the algorithm. The hyperparameters are specific to each algorithm and are described in the documentation for each algorithm.
2023-10-25 17:19:24 +01:00
.. only:: comment
This needs a bit of refactoring so I haven't written extensive documentation about the config yet.