Added docstrings to class intialisers

src/primaite/agents/agent.py

@@ -38,7 +38,8 @@ def get_session_path(session_timestamp: datetime) -> Path:
 
 
 class AgentSessionABC(ABC):
-    """An ABC that manages training and/or evaluation of agents in PrimAITE.
+    """
+    An ABC that manages training and/or evaluation of agents in PrimAITE.
 
     This class cannot be directly instantiated and must be inherited from with all implemented abstract methods
     implemented.
@@ -46,6 +47,15 @@ class AgentSessionABC(ABC):
 
     @abstractmethod
     def __init__(self, training_config_path, lay_down_config_path):
+        """
+        Initialise an agent session from config files.
+
+        :param training_config_path: YAML file containing configurable items defined in
+            `primaite.config.training_config.TrainingConfig`
+        :type training_config_path: Union[path, str]
+        :param lay_down_config_path: YAML file containing configurable items for generating network laydown.
+        :type lay_down_config_path: Union[path, str]
+        """
         if not isinstance(training_config_path, Path):
             training_config_path = Path(training_config_path)
         self._training_config_path: Final[Union[Path, str]] = training_config_path
@@ -289,13 +299,23 @@ class AgentSessionABC(ABC):
 
 
 class HardCodedAgentSessionABC(AgentSessionABC):
-    """An Agent Session ABC for evaluation deterministic agents.
+    """
+    An Agent Session ABC for evaluation deterministic agents.
 
     This class cannot be directly instantiated and must be inherited from with all implemented abstract methods
     implemented.
     """
 
     def __init__(self, training_config_path, lay_down_config_path):
+        """
+        Initialise a hardcoded agent session.
+
+        :param training_config_path: YAML file containing configurable items defined in
+            `primaite.config.training_config.TrainingConfig`
+        :type training_config_path: Union[path, str]
+        :param lay_down_config_path: YAML file containing configurable items for generating network laydown.
+        :type lay_down_config_path: Union[path, str]
+        """
         super().__init__(training_config_path, lay_down_config_path)
         self._setup()
 

src/primaite/agents/hardcoded_acl.py

@@ -23,7 +23,8 @@ class HardCodedACLAgent(HardCodedAgentSessionABC):
             return self._calculate_action_full_view(obs)
 
     def get_blocked_green_iers(self, green_iers, acl, nodes):
-        """Get blocked green IERs.
+        """
+        Get blocked green IERs.
 
         TODO: Add params and return in docstring.
         TODO: Typehint params and return.

src/primaite/agents/rllib.py

@@ -42,6 +42,18 @@ class RLlibAgent(AgentSessionABC):
     """An AgentSession class that implements a Ray RLlib agent."""
 
     def __init__(self, training_config_path, lay_down_config_path):
+        """
+        Initialise the RLLib Agent training session.
+
+        :param training_config_path: YAML file containing configurable items defined in
+            `primaite.config.training_config.TrainingConfig`
+        :type training_config_path: Union[path, str]
+        :param lay_down_config_path: YAML file containing configurable items for generating network laydown.
+        :type lay_down_config_path: Union[path, str]
+        :raises ValueError: If the training config contains an unexpected value for agent_framework (should be "RLLIB")
+        :raises ValueError: If the training config contains an unexpected value for agent_identifies (should be `PPO`
+            or `A2C`)
+        """
         super().__init__(training_config_path, lay_down_config_path)
         if not self._training_config.agent_framework == AgentFramework.RLLIB:
             msg = f"Expected RLLIB agent_framework, " f"got {self._training_config.agent_framework}"

src/primaite/agents/sb3.py

@@ -19,6 +19,18 @@ class SB3Agent(AgentSessionABC):
     """An AgentSession class that implements a Stable Baselines3 agent."""
 
     def __init__(self, training_config_path, lay_down_config_path):
+        """
+        Initialise the SB3 Agent training session.
+
+        :param training_config_path: YAML file containing configurable items defined in
+            `primaite.config.training_config.TrainingConfig`
+        :type training_config_path: Union[path, str]
+        :param lay_down_config_path: YAML file containing configurable items for generating network laydown.
+        :type lay_down_config_path: Union[path, str]
+        :raises ValueError: If the training config contains an unexpected value for agent_framework (should be "SB3")
+        :raises ValueError: If the training config contains an unexpected value for agent_identifies (should be `PPO`
+            or `A2C`)
+        """
         super().__init__(training_config_path, lay_down_config_path)
         if not self._training_config.agent_framework == AgentFramework.SB3:
             msg = f"Expected SB3 agent_framework, " f"got {self._training_config.agent_framework}"

src/primaite/agents/simple.py

@@ -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.
     """