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

#2257: update sphinx version + cleaning up some errors + splitting configuration page into multiple pages

Browse Source
This commit is contained in:
Czar Echavez
2024-02-16 16:14:36 +00:00
parent e390d8385c
commit 2e2d83c3e9
15 changed files with 220 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/state_system.rst
View File

@@ -3,7 +3,7 @@
© Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
Simulation State
==============
================
``SimComponent`` objects in the simulation have a method called ``describe_state`` which return a dictionary of the state of the component. This is used to report pertinent data that could impact an agent's actions or rewards. For instance, the name and health status of a node is reported, which can be used by a reward function to punish corrupted or compromised nodes and reward healthy nodes. Each ``SimComponent`` object reports not only its own attributes in the state but also those of its child components. I.e. a computer node will report the state of its ``FileSystem`` and the ``FileSystem`` will report the state of its files and folders. This happens by recursively calling the childrens' own ``describe_state`` methods.