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

Added docstrings to class intialisers

Browse Source
This commit is contained in:
Marek Wolan
2023-07-06 16:08:51 +01:00
parent 2a08d3a2a5
commit 86725064ec
23 changed files with 253 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/primaite/agents/simple.py
View File

@@ -3,7 +3,8 @@ from primaite.agents.utils import get_new_action, transform_action_acl_enum, tra
class RandomAgent(HardCodedAgentSessionABC):
"""A Random Agent.
"""
A Random Agent.
Get a completely random action from the action space.
"""
@@ -13,7 +14,8 @@ class RandomAgent(HardCodedAgentSessionABC):
class DummyAgent(HardCodedAgentSessionABC):
"""A Dummy Agent.
"""
A Dummy Agent.
All action spaces setup so dummy action is always 0 regardless of action type used.
"""
@@ -23,7 +25,8 @@ class DummyAgent(HardCodedAgentSessionABC):
class DoNothingACLAgent(HardCodedAgentSessionABC):
"""A do nothing ACL agent.
"""
A do nothing ACL agent.
A valid ACL action that has no effect; does nothing.
"""
@@ -37,7 +40,8 @@ class DoNothingACLAgent(HardCodedAgentSessionABC):
class DoNothingNodeAgent(HardCodedAgentSessionABC):
"""A do nothing Node agent.
"""
A do nothing Node agent.
A valid Node action that has no effect; does nothing.
"""