2024-02-16 16:14:36 +00:00
.. only :: comment
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
`` io_settings ``
===============
This section configures how PrimAITE saves data during simulation and training.
2024-02-21 14:49:59 +00:00
`` io_settings `` hierarchy
-------------------------
2024-02-16 16:14:36 +00:00
2024-02-21 14:49:59 +00:00
.. code-block :: yaml
2024-02-16 16:14:36 +00:00
2024-02-21 14:49:59 +00:00
io_settings:
# save_logs: True
2024-03-04 18:59:03 +00:00
save_agent_actions: True
2024-02-21 14:49:59 +00:00
save_step_metadata: False
save_pcap_logs: False
save_sys_logs: False
2024-04-18 16:40:05 +01:00
sys_log_level: INFO
2024-04-18 15:57:02 +01:00
2024-02-21 14:49:59 +00:00
`` save_logs ``
-------------
*currently unused* .
2024-03-04 18:59:03 +00:00
`` save_agent_actions ``
2024-03-05 15:46:30 +00:00
----------------------
2024-03-04 18:59:03 +00:00
Optional. Default value is `` True `` .
2024-03-05 11:21:49 +00:00
If `` True `` , this will create a JSON file each episode detailing every agent's action in each step of that episode, formatted according to the CAOS format. This includes scripted, RL, and red agents.
2024-03-04 18:59:03 +00:00
2024-02-21 14:49:59 +00:00
`` save_step_metadata ``
----------------------
Optional. Default value is `` False `` .
If `` True `` , The RL agent(s) actions, environment states and other data will be saved at every single step.
`` save_pcap_logs ``
------------------
Optional. Default value is `` False `` .
If `` True `` , then the pcap files which contain all network traffic during the simulation will be saved.
`` save_sys_logs ``
-----------------
Optional. Default value is `` False `` .
If `` True `` , then the log files which contain all node actions during the simulation will be saved.
2024-04-18 16:38:42 +01:00
`` sys_log_level ``
-------------
Optional. Default value is `` INFO `` .
The level of logging that should be visible in the sys logs or the logs output to the terminal.
`` save_sys_logs `` has to be set to `` True `` for this setting to be used.
Available options are:
- `` DEBUG `` : Debug level items and the items below
- `` INFO `` : Info level items and the items below
- `` WARNING `` : Warning level items and the items below
- `` ERROR `` : Error level items and the items below
- `` CRITICAL `` : Only critical level logs
See also |logging_levels|
.. |logging_levels| raw :: html
<a href="https://docs.python.org/3/library/logging.html#logging-levels" target="blank">Python logging levels</a>
