diff --git a/docs/index.rst b/docs/index.rst index ff97f60d..118f7ebf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -60,6 +60,8 @@ The ARCD Primary-level AI Training Environment (**PrimAITE**) provides an effect - Modelling background (green) pattern-of-life; - Operates at machine-speed to enable fast training cycles via Reinforcement Learning (RL). +PrimAITE has been designed as an extensible environment and toolkit to support the development, test, training and evaluation of AI-based cyber defensive agents. Whilst PrimAITE ships with a number of example modelled scenarios (a.k.a. Use Cases), it has not been developed to mandate the solving of a single cyber challenge, and instead provides a highly flexible environment application that can be extended and reconfigured by the user to suit their specific cyber defence training and evaluation needs. PrimAITE provides default networks, red agent and green agent behaviour, reward functions, and action / observation space configuration, all of which can be utilised out of the box, but which ultimately can (and in some instances should) be built upon and / or reconfigured to meet the needs of different defensive agent developers. The PrimAITE user guide provides comprehensive instruction on all PrimAITE features, functionality and components, and can be consulted in order to help guide users in any reconfiguration or enhancements they wish to undertake; a library of example Jupyter notebooks are also provided to support such work. + Features ^^^^^^^^ diff --git a/docs/source/simulation_components/system/applications/c2_suite.rst b/docs/source/simulation_components/system/applications/c2_suite.rst index fd9ee546..d045949a 100644 --- a/docs/source/simulation_components/system/applications/c2_suite.rst +++ b/docs/source/simulation_components/system/applications/c2_suite.rst @@ -270,7 +270,7 @@ How often should the C2 Beacon confirm it's connection in timesteps. For example, if the keep alive Frequency is set to one then every single timestep the C2 connection will be confirmed. -It's worth noting that this may be useful option when investigating +It's worth noting that this may be a useful option when investigating network blue agent observation space. This must be a valid integer i.e ``10``. Defaults to ``5``. @@ -283,7 +283,7 @@ The protocol that the C2 Beacon will use to communicate to the C2 Server with. Currently only ``TCP`` and ``UDP`` are valid masquerade protocol options. -It's worth noting that this may be useful option to bypass ACL rules. +It's worth noting that this may be a useful option to bypass ACL rules. This must be a string i.e *UDP*. Defaults to ``TCP``. diff --git a/docs/source/simulation_components/system/common/common_configuration.rst b/docs/source/simulation_components/system/common/common_configuration.rst index 7b32a463..c53ac8b8 100644 --- a/docs/source/simulation_components/system/common/common_configuration.rst +++ b/docs/source/simulation_components/system/common/common_configuration.rst @@ -20,7 +20,7 @@ The type of software that should be added. To add the required software, this mu options """"""" -The configuration options are the attributes that fall under the options for an application. +The configuration options are the attributes that fall under the options for an application or service. fix_duration """""""""""" diff --git a/src/primaite/notebooks/Command-&-Control-E2E-Demonstration.ipynb b/src/primaite/notebooks/Command-&-Control-E2E-Demonstration.ipynb index 97b436cb..45af6c12 100644 --- a/src/primaite/notebooks/Command-&-Control-E2E-Demonstration.ipynb +++ b/src/primaite/notebooks/Command-&-Control-E2E-Demonstration.ipynb @@ -1164,7 +1164,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Now we are unable to do so as the C2 Server has lost it's connection to the C2 Beacon:" + "Now we are unable to do so as the C2 Server has lost its connection to the C2 Beacon:" ] }, {