add module level docstrings

src/primaite/acl/__init__.py

@@ -1 +1,2 @@
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+"""Access Control List. Models firewall functionality."""

src/primaite/agents/__init__.py

@@ -0,0 +1 @@
+"""Common interface between RL agents from different libraries and PrimAITE."""

src/primaite/common/__init__.py

@@ -1 +1,2 @@
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+"""Objects which are shared between many PrimAITE modules."""

src/primaite/data_viz/__init__.py

@@ -1,5 +1,5 @@
 from enum import Enum
-
+"""Utility to generate plots of sessions metrics after PrimAITE."""
 
 class PlotlyTemplate(Enum):
     """The built-in plotly templates."""

src/primaite/environment/__init__.py

@@ -1 +1,2 @@
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+"""Gym/Gymnasium environment for RL agents consisting of a simulated computer network."""

src/primaite/links/__init__.py

@@ -1 +1,2 @@
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+"""Network connections between nodes in the simulation."""

src/primaite/nodes/__init__.py

@@ -1 +1,2 @@
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+"""Nodes represent network hosts in the simulation."""

src/primaite/notebooks/__init__.py

@@ -1,3 +1,4 @@
+"""Contains default jupyter notebooks which demonstrate PrimAITE functionality."""
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 import importlib.util
 import os

src/primaite/pol/__init__.py

@@ -1 +1,2 @@
+"""Pattern of Life- Represents the actions of users on the network."""
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.

src/primaite/primaite_session.py

@@ -1,3 +1,4 @@
+"""Main entry point to PrimAITE. Configure training/evaluation experiments and input/output."""
 from __future__ import annotations
 
 from pathlib import Path
@@ -35,12 +36,12 @@ class PrimaiteSession:
         """
         if not isinstance(training_config_path, Path):
             training_config_path = Path(training_config_path)
-        self._training_config_path: Final[Union[Path]] = training_config_path
+        self._training_config_path: Final[Union[Path, str]] = training_config_path
         self._training_config: Final[TrainingConfig] = training_config.load(self._training_config_path)
 
         if not isinstance(lay_down_config_path, Path):
             lay_down_config_path = Path(lay_down_config_path)
-        self._lay_down_config_path: Final[Union[Path]] = lay_down_config_path
+        self._lay_down_config_path: Final[Union[Path, str]] = lay_down_config_path
         self._lay_down_config: Dict = lay_down_config.load(self._lay_down_config_path)
 
         self._agent_session: AgentSessionABC = None  # noqa

src/primaite/setup/__init__.py

@@ -1 +1,2 @@
+"""Utilities to prepare the user's data folders."""
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.

src/primaite/transactions/__init__.py

@@ -1 +1,2 @@
+"""Record data of the system's state and agent's observations and actions."""
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.

src/primaite/utils/__init__.py

@@ -0,0 +1 @@
+"""Utilities for PrimAITE."""