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``
^^^^^^^^^^^^^^^^^^^^^
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``.