From 6fd37a609ac663da8795238ac41a094e993f85b5 Mon Sep 17 00:00:00 2001 From: Nick Todd Date: Mon, 27 Nov 2023 14:38:59 +0000 Subject: [PATCH] #2068: code review comments. --- docs/index.rst | 1 - docs/source/about.rst | 4 ++-- docs/source/custom_agent.rst | 14 -------------- 3 files changed, 2 insertions(+), 17 deletions(-) delete mode 100644 docs/source/custom_agent.rst diff --git a/docs/index.rst b/docs/index.rst index 2dfc8a65..9eae8adc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -107,7 +107,6 @@ Head over to the :ref:`getting-started` page to install and setup PrimAITE! source/primaite_session source/simulation source/game_layer - source/custom_agent source/config .. toctree:: diff --git a/docs/source/about.rst b/docs/source/about.rst index e8befbaf..3f905933 100644 --- a/docs/source/about.rst +++ b/docs/source/about.rst @@ -278,7 +278,7 @@ The game layer is built on top of the simulator and it consumes the simulation a 3. Any (Agent can take both node-based and ACL-based actions) The choice of action space used during a training session is determined in the config_[name].yaml file. **Node-Based** - The agent is able to influence the status of nodes by switching them off, resetting, or patching operating systems and services. In this instance, the action space is an Gymnasium spaces.Discrete type, as follows: + The agent is able to influence the status of nodes by switching them off, resetting, or patching operating systems and services. In this instance, the action space is a Gymnasium spaces.Discrete type, as follows: * Dictionary item {... ,1: [x1, x2, x3,x4] ...} The placeholders inside the list under the key '1' mean the following: * [0, num nodes] - Node ID (0 = nothing, node ID) @@ -286,7 +286,7 @@ The game layer is built on top of the simulator and it consumes the simulation a * [0, 3] - Action on property (0 = nothing, 1 = on / scan, 2 = off / repair, 3 = reset / patch / restore) * [0, num services] - Resolves to service ID (0 = nothing, resolves to service) **Access Control List** - The blue agent is able to influence the configuration of the Access Control List rule set (which implements a system-wide firewall). In this instance, the action space is an OpenAI spaces.Discrete type, as follows: + The blue agent is able to influence the configuration of the Access Control List rule set (which implements a system-wide firewall). In this instance, the action space is an Gymnasium spaces.Discrete type, as follows: * Dictionary item {... ,1: [x1, x2, x3, x4, x5, x6] ...} The placeholders inside the list under the key '1' mean the following: * [0, 2] - Action (0 = do nothing, 1 = create rule, 2 = delete rule) diff --git a/docs/source/custom_agent.rst b/docs/source/custom_agent.rst deleted file mode 100644 index 7a9d83c1..00000000 --- a/docs/source/custom_agent.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. only:: comment - - © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK - -Custom Agents -============= - - -Integrating a user defined blue agent -************************************* - -.. note:: - - TBA