diff --git a/docs/source/configuration/agents.rst b/docs/source/configuration/agents.rst index c2674e31..e7373b53 100644 --- a/docs/source/configuration/agents.rst +++ b/docs/source/configuration/agents.rst @@ -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``. diff --git a/docs/source/configuration/game.rst b/docs/source/configuration/game.rst index d4b8cc90..02c2a441 100644 --- a/docs/source/configuration/game.rst +++ b/docs/source/configuration/game.rst @@ -59,4 +59,4 @@ These are used to determine the thresholds of high, medium and low categories fo ``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//sessions//