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

#3110 - Address some incorrect comments in PrimAITE documentation and sort outstanding TODO comments

Browse Source
This commit is contained in:
Charlie Crane
2025-03-13 13:06:45 +00:00
parent 2107e2f166
commit 1433ee08f0
3 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/source/configuration/agents.rst
View File

@@ -97,8 +97,7 @@ Similar to action space, this is defined as a list of components from the :py:mo
``reward_components`` ``reward_components``
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
TODO: update description A list of available reward types from :py:mod:`primaite.game.agent.rewards.RewardFunction.rew_class_identifiers`
A list of reward types from :py:mod:`primaite.game.agent.rewards.RewardFunction.rew_class_identifiers`
e.g. e.g.
@@ -106,7 +105,13 @@ e.g.
reward_components: reward_components:
- type: dummy - type: dummy
weight: 1.0
- type: database-file-integrity - type: database-file-integrity
weight: 0.40
options:
node_hostname: database_server
folder_name: database
file_name: database.db
``agent_settings`` ``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. 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``.

2
docs/source/configuration/game.rst
View File

@@ -59,4 +59,4 @@ These are used to determine the thresholds of high, medium and low categories fo
``seed`` ``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/<VERSION>/sessions/<DATE>/<TIME>/simulation_output``.

9
docs/source/configuration/simulation.rst
View File

@@ -5,8 +5,7 @@
``simulation`` ``simulation``
============== ==============
In this section the network layout is defined. This part of the config follows a hierarchical structure. Almost every component defines a ``ref`` field which acts as a human-readable unique identifier, used by other parts of the config, such as agents. In this section the network layout is defined. This part of the config follows a hierarchical structure.
# TODO: ref field is no longer real
At the top level of the network are ``nodes``, ``links`` and ``airspace``. At the top level of the network are ``nodes``, ``links`` and ``airspace``.
e.g. e.g.
@@ -26,7 +25,7 @@ e.g.
``nodes`` ``nodes``
--------- ---------
This is where the list of nodes are defined. Some items will differ according to the node type, however, there will be common items such as a node's reference (which is used by the agent), the node's ``type`` and ``hostname`` This is where the list of nodes are defined. Some items will differ according to the node type, however, there will be common items such as a node's hostname (which is used by the agent) and the node's ``type``.
To see the configuration for these nodes, refer to the following: To see the configuration for these nodes, refer to the following:
@@ -74,10 +73,6 @@ this results in:
endpoint_b_port: 2 # port 2 on switch endpoint_b_port: 2 # port 2 on switch
bandwidth: 100 bandwidth: 100
``ref``
^^^^^^^
The human readable name for the link. Not used in code, however is useful for a human to understand what the link is for.
``endpoint_a_hostname`` ``endpoint_a_hostname``
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^