From 833fd18936391e886f7cef5673642f319bcc21f0 Mon Sep 17 00:00:00 2001 From: Czar Echavez Date: Thu, 18 Apr 2024 16:44:18 +0100 Subject: [PATCH] #2470: add write_sys_log_to_terminal to documentation --- docs/source/configuration/io_settings.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/source/configuration/io_settings.rst b/docs/source/configuration/io_settings.rst index bce28d4d..3c6c5b19 100644 --- a/docs/source/configuration/io_settings.rst +++ b/docs/source/configuration/io_settings.rst @@ -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: