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

#2470: add write_sys_log_to_terminal to documentation

Browse Source
This commit is contained in:
Czar Echavez
2024-04-18 16:44:18 +01:00
parent cbea0fd595
commit 833fd18936
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/configuration/io_settings.rst
View File

@@ -18,6 +18,7 @@ This section configures how PrimAITE saves data during simulation and training.
save_step_metadata: False
save_pcap_logs: False
save_sys_logs: False
write_sys_log_to_terminal: False
sys_log_level: INFO
@@ -26,7 +27,6 @@ This section configures how PrimAITE saves data during simulation and training.
*currently unused*.
``save_agent_actions``
----------------------
@@ -58,6 +58,14 @@ Optional. Default value is ``False``.
If ``True``, then the log files which contain all node actions during the simulation will be saved.
``write_sys_log_to_terminal``
-----------------------------
Optional. Default value is ``False``.
If ``True``, PrimAITE will print sys log to the terminal.
``sys_log_level``
-------------
@@ -65,7 +73,7 @@ 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.
``save_sys_logs`` or ``write_sys_log_to_terminal`` has to be set to ``True`` for this setting to be used.
Available options are: