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

#3110: fix links in how-to guides

Browse Source
This commit is contained in:
Nick Todd
2025-03-11 12:27:45 +00:00
parent b4df227af3
commit 42f7925748
10 changed files with 72 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@@ -39,7 +39,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Updated tests that don't use YAMLs to still use the new action and agent schemas - Updated tests that don't use YAMLs to still use the new action and agent schemas
- Nodes now use a config schema and are extensible, allowing for plugin support. - Nodes now use a config schema and are extensible, allowing for plugin support.
- Node tests have been updated to use the new node config schemas when not using YAML files. - Node tests have been updated to use the new node config schemas when not using YAML files.
- Documentation has been updated to include details of extensability with PrimAITE. - Documentation has been updated to include details of extensibility with PrimAITE.
- Software is created in the GOOD health state instead of UNUSED. - Software is created in the GOOD health state instead of UNUSED.
- Standardised naming convention for YAML config files using kebab-case. - Standardised naming convention for YAML config files using kebab-case.
This naming convention is used for configuring software, observations, actions and node types. This naming convention is used for configuring software, observations, actions and node types.

2
docs/source/action_masking.rst
View File

@@ -2,6 +2,8 @@
© Crown-owned copyright 2025, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _action_masking:
Action Masking Action Masking
************** **************
The PrimAITE simulation is able to provide action masks in the environment output. These action masks let the agents know The PrimAITE simulation is able to provide action masks in the environment output. These action masks let the agents know

2
docs/source/config.rst
View File

@@ -2,6 +2,8 @@
© Crown-owned copyright 2025, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _Configurable_Items:
PrimAITE |VERSION| Configuration PrimAITE |VERSION| Configuration
******************************** ********************************

2
docs/source/how_to_guides/custom_environments.rst
View File

@@ -42,4 +42,4 @@ Should your custom environment need any additional PrimAITE plugins, each must b
Configuration Items Configuration Items
=================== ===================
For detailed information about the remaining configuration items found within the configuration file, see :ref:`Configurable Items`. For detailed information about the remaining configuration items found within the configuration file, see :ref:`Configurable_Items`.

2
docs/source/how_to_guides/custom_rewards.rst
View File

@@ -9,7 +9,7 @@ Creating Custom Rewards in PrimAITE
Rewards within PrimAITE are contained within ``rewards.py``, which details the rewards available for all agents within training sessions, how they are calculated and any other specific information where necessary. Rewards within PrimAITE are contained within ``rewards.py``, which details the rewards available for all agents within training sessions, how they are calculated and any other specific information where necessary.
Rewards within PrimAITE have been updated to facilitate extensability and the creation of plugins with the release of PrimAITE version 4.0. Additional information about this is covered within :ref:`extensible_rewards`. Rewards within PrimAITE have been updated to facilitate extensibility and the creation of plugins with the release of PrimAITE version 4.0. Additional information about this is covered within :ref:`extensible_rewards`.
Custom Rewards within PrimAITE should inherit from the ``AbstractReward`` class, found in ``rewards.py``. It's important to include an identifier for any class created within PrimAITE. Custom Rewards within PrimAITE should inherit from the ``AbstractReward`` class, found in ``rewards.py``. It's important to include an identifier for any class created within PrimAITE.

4
docs/source/how_to_guides/extensible_agents.rst
View File

@@ -17,7 +17,7 @@ All agent types within PrimAITE must be subclassed from ``AbstractAgent`` in ord
The core features that should be implemented in any new agent are detailed below: The core features that should be implemented in any new agent are detailed below:
#. **ConfigSchema**: **ConfigSchema**:
Configurable items within a new agent within PrimAITE should contain a ``ConfigSchema`` which holds all configurable variables of the agent. This should not include parameters related to its *state*, these would be listed seperately. Configurable items within a new agent within PrimAITE should contain a ``ConfigSchema`` which holds all configurable variables of the agent. This should not include parameters related to its *state*, these would be listed seperately.
Agent generation will fail pydantic checks if incorrect or invalid parameters are passed to the ConfigSchema of the chosen Agent. Agent generation will fail pydantic checks if incorrect or invalid parameters are passed to the ConfigSchema of the chosen Agent.
@@ -60,7 +60,7 @@ The core features that should be implemented in any new agent are detailed below
starting_host: "Server_1" starting_host: "Server_1"
#. **discriminators**: **discriminators**:
All agent classes should have an ``discriminator`` attribute, a unique kebab-case string, for when they are added to the base ``AbstractAgent`` registry. This is then specified in your configuration YAML, and used by PrimAITE to generate the correct Agent. All agent classes should have an ``discriminator`` attribute, a unique kebab-case string, for when they are added to the base ``AbstractAgent`` registry. This is then specified in your configuration YAML, and used by PrimAITE to generate the correct Agent.

2
docs/source/how_to_guides/extensible_rewards.rst
View File

@@ -51,7 +51,5 @@ class DatabaseFileIntegrity(AbstractReward, discriminator="database-file-integri
Changes to YAML file. Changes to YAML file.
===================== =====================
.. code:: YAML
There's no longer a need to provide a `dns_server` as an option in the simulation section There's no longer a need to provide a `dns_server` as an option in the simulation section
of the config file. of the config file.

2
docs/source/how_to_guides/primaite_yaml_migration_guide.rst
View File

@@ -33,7 +33,7 @@ However, a few more options have been introduced:
sys_log_level: WARNING sys_log_level: WARNING
agent_log_level: INFO agent_log_level: INFO
More information can be found in the detailed in the configuration page: :ref:`_io_settings`. More information can be found in the detailed in the configuration page: :ref:`io_settings`.
``game`` ``game``
======== ========

2
docs/source/rewards.rst
View File

@@ -2,6 +2,8 @@
© Crown-owned copyright 2025, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _Rewards:
Rewards Rewards
####### #######