From 3fa1104d2e9c996a44c074da60c6eebed5154f9e Mon Sep 17 00:00:00 2001 From: Charlie Crane Date: Wed, 12 Mar 2025 17:10:51 +0000 Subject: [PATCH 1/3] #3110 - Amend Documentation pages that have out of date material following updates --- docs/source/configuration/io_settings.rst | 6 ------ .../simulation/nodes/common/common_node_attributes.rst | 5 ----- .../simulation/nodes/common/node_type_list.rst | 1 + .../configuration/simulation/software/applications.rst | 6 ++---- docs/source/configuration/simulation/software/services.rst | 2 -- 5 files changed, 3 insertions(+), 17 deletions(-) diff --git a/docs/source/configuration/io_settings.rst b/docs/source/configuration/io_settings.rst index e156d14f..ee3b2700 100644 --- a/docs/source/configuration/io_settings.rst +++ b/docs/source/configuration/io_settings.rst @@ -14,7 +14,6 @@ This section configures how PrimAITE saves data during simulation and training. .. code-block:: yaml io_settings: - # save_logs: True save_agent_actions: True save_step_metadata: False save_pcap_logs: False @@ -26,11 +25,6 @@ This section configures how PrimAITE saves data during simulation and training. agent_log_level: INFO -``save_logs`` -------------- - -*currently unused*. - ``save_agent_actions`` ---------------------- diff --git a/docs/source/configuration/simulation/nodes/common/common_node_attributes.rst b/docs/source/configuration/simulation/nodes/common/common_node_attributes.rst index e6d5da67..c0386e5a 100644 --- a/docs/source/configuration/simulation/nodes/common/common_node_attributes.rst +++ b/docs/source/configuration/simulation/nodes/common/common_node_attributes.rst @@ -4,11 +4,6 @@ .. _common_node_attributes: -``ref`` -------- - -Human readable name used as reference for the |NODE|. Not used in code. - ``hostname`` ------------ diff --git a/docs/source/configuration/simulation/nodes/common/node_type_list.rst b/docs/source/configuration/simulation/nodes/common/node_type_list.rst index 21181019..106c337a 100644 --- a/docs/source/configuration/simulation/nodes/common/node_type_list.rst +++ b/docs/source/configuration/simulation/nodes/common/node_type_list.rst @@ -12,6 +12,7 @@ Available options are: - ``computer`` - ``firewall`` - ``router`` +- ``wireless_router`` - ``server`` - ``switch`` diff --git a/docs/source/configuration/simulation/software/applications.rst b/docs/source/configuration/simulation/software/applications.rst index 9973a167..d382c2ad 100644 --- a/docs/source/configuration/simulation/software/applications.rst +++ b/docs/source/configuration/simulation/software/applications.rst @@ -14,12 +14,10 @@ Applications takes a list of applications as shown in the example below. .. code-block:: yaml - - ref: client_1 - hostname: client_1 - type: computer + - hostname: client_1 + type: computer ... applications: - - ref: example_application type: example_application_type options: # this section is different for each application diff --git a/docs/source/configuration/simulation/software/services.rst b/docs/source/configuration/simulation/software/services.rst index ec6bbba9..56841e84 100644 --- a/docs/source/configuration/simulation/software/services.rst +++ b/docs/source/configuration/simulation/software/services.rst @@ -14,12 +14,10 @@ Services takes a list of services as shown in the example below. .. code-block:: yaml - - ref: client_1 hostname: client_1 type: computer ... applications: - - ref: example_service type: example_service_type options: # this section is different for each service From 1433ee08f06852302bcfe71c22fa775df9b6b52d Mon Sep 17 00:00:00 2001 From: Charlie Crane Date: Thu, 13 Mar 2025 13:06:45 +0000 Subject: [PATCH 2/3] #3110 - Address some incorrect comments in PrimAITE documentation and sort outstanding TODO comments --- docs/source/configuration/agents.rst | 11 ++++++++--- docs/source/configuration/game.rst | 2 +- docs/source/configuration/simulation.rst | 9 ++------- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/source/configuration/agents.rst b/docs/source/configuration/agents.rst index c2674e31..e7373b53 100644 --- a/docs/source/configuration/agents.rst +++ b/docs/source/configuration/agents.rst @@ -97,8 +97,7 @@ Similar to action space, this is defined as a list of components from the :py:mo ``reward_components`` ^^^^^^^^^^^^^^^^^^^^^ -TODO: update description -A list of reward types from :py:mod:`primaite.game.agent.rewards.RewardFunction.rew_class_identifiers` +A list of available reward types from :py:mod:`primaite.game.agent.rewards.RewardFunction.rew_class_identifiers` e.g. @@ -106,7 +105,13 @@ e.g. reward_components: - type: dummy + weight: 1.0 - type: database-file-integrity + weight: 0.40 + options: + node_hostname: database_server + folder_name: database + file_name: database.db ``agent_settings`` @@ -154,4 +159,4 @@ If ``True``, gymnasium flattening will be performed on the observation space bef ----------------- Agents will record their action log for each step. This is a summary of what the agent did, along with response information from requests within the simulation. -A summary of the actions taken by the agent can be viewed using the `show_history()` function. By default, this will display all actions taken apart from ``DONOTHING``. +A summary of the actions taken by the agent can be viewed using the `show_history()` function. By default, this will display all actions taken apart from ``do-nothing``. diff --git a/docs/source/configuration/game.rst b/docs/source/configuration/game.rst index d4b8cc90..02c2a441 100644 --- a/docs/source/configuration/game.rst +++ b/docs/source/configuration/game.rst @@ -59,4 +59,4 @@ These are used to determine the thresholds of high, medium and low categories fo ``seed`` -------- -Used to configure the random seeds used within PrimAITE, ensuring determinism within episode/session runs. If empty or set to -1, no seed is set. +Used to configure the random seeds used within PrimAITE, ensuring determinism within episode/session runs. If empty or set to -1, no seed is set. The given seed value is logged (by default) in ``primaite//sessions//