Merged PR 307: #2369: commiting work done so far

## Summary
Added a page to explain how to use the Jupyter notebooks via jupyter command and VSCode

Also added Nick's suggestion to fix #2226

Going to be honest - not my finest pull request

## Test process
*How have you tested this (if applicable)?*

## Checklist
- [X] PR is linked to a **work item**
- [X] **acceptance criteria** of linked ticket are met
- [X] performed **self-review** of the code
- [ ] written **tests** for any new functionality added with this PR
- [X] updated the **documentation** if this PR changes or adds functionality
- [ ] written/updated **design docs** if this PR implements new functionality
- [ ] updated the **change log**
- [X] ran **pre-commit** checks for code style
- [ ] attended to any **TO-DOs** left in the code

#2369: commiting work done so far

Related work items: #2369

src/primaite/config/_package_data/data_manipulation_marl.yaml

@@ -13,8 +13,6 @@ training_config:
 
 
 io_settings:
-  save_checkpoints: true
-  checkpoint_interval: 5
   save_agent_actions: true
   save_step_metadata: false
   save_pcap_logs: false

src/primaite/game/agent/rewards.py

@@ -111,7 +111,7 @@ class DatabaseFileIntegrity(AbstractReward):
         """
         database_file_state = access_from_nested_dict(state, self.location_in_state)
         if database_file_state is NOT_PRESENT_IN_STATE:
-            _LOGGER.info(
+            _LOGGER.debug(
                 f"Could not calculate {self.__class__} reward because "
                 "simulation state did not contain enough information."
             )
@@ -231,7 +231,7 @@ class WebpageUnavailablePenalty(AbstractReward):
         # If the last request did actually go through, then check if the webpage also loaded
         web_browser_state = access_from_nested_dict(state, self.location_in_state)
         if web_browser_state is NOT_PRESENT_IN_STATE or "history" not in web_browser_state:
-            _LOGGER.info(
+            _LOGGER.debug(
                 "Web browser reward could not be calculated because the web browser history on node",
                 f"{self._node} was not reported in the simulation state. Returning 0.0",
             )

src/primaite/notebooks/Data-Manipulation-Customising-Red-Agent.ipynb

@@ -22,6 +22,7 @@
     "# Imports\n",
     "\n",
     "from primaite.config.load import data_manipulation_config_path\n",
+    "from primaite.game.agent.interface import AgentActionHistoryItem\n",
     "from primaite.session.environment import PrimaiteGymEnv\n",
     "import yaml\n",
     "from pprint import pprint"
@@ -62,12 +63,12 @@
    "source": [
     "def friendly_output_red_action(info):\n",
     "    # parse the info dict form step output and write out what the red agent is doing\n",
-    "    red_info = info['agent_actions']['data_manipulation_attacker']\n",
-    "    red_action = red_info[0]\n",
+    "    red_info : AgentActionHistoryItem = info['agent_actions']['data_manipulation_attacker']\n",
+    "    red_action = red_info.action\n",
     "    if red_action == 'DONOTHING':\n",
     "        red_str = 'DO NOTHING'\n",
     "    elif red_action == 'NODE_APPLICATION_EXECUTE':\n",
-    "        client = \"client 1\" if red_info[1]['node_id'] == 0 else \"client 2\"\n",
+    "        client = \"client 1\" if red_info.parameters['node_id'] == 0 else \"client 2\"\n",
     "        red_str = f\"ATTACK from {client}\"\n",
     "    return red_str"
    ]

src/primaite/notebooks/Data-Manipulation-E2E-Demonstration.ipynb

@@ -576,7 +576,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Now, even though the red agent executes an attack, the reward stays at 0.8."
+    "Now, even though the red agent executes an attack, the reward will stay at 0.8."
    ]
   },
   {
@@ -616,12 +616,12 @@
     "    tries += 1\n",
     "    obs, reward, terminated, truncated, info = env.step(0)\n",
     "\n",
-    "    if obs['NODES'][6]['NETWORK_INTERFACES'][1]['nmne']['outbound'] == 1:\n",
+    "    if obs['NODES'][6]['NICS'][1]['NMNE']['outbound'] == 1:\n",
     "        # client 1 has NMNEs, let's block it\n",
     "        obs, reward, terminated, truncated, info = env.step(50) # block client 1\n",
     "        print(\"blocking client 1\")\n",
     "        break\n",
-    "    elif obs['NODES'][7]['NETWORK_INTERFACES'][1]['nmne']['outbound'] == 1:\n",
+    "    elif obs['NODES'][7]['NICS'][1]['NMNE']['outbound'] == 1:\n",
     "        # client 2 has NMNEs, so let's block it\n",
     "        obs, reward, terminated, truncated, info = env.step(51) # block client 2\n",
     "        print(\"blocking client 2\")\n",

src/primaite/simulator/network/airspace.py

@@ -157,7 +157,7 @@ class WirelessNetworkInterface(NetworkInterface, ABC):
             return
 
         if not self._connected_node:
-            _LOGGER.error(f"Interface {self} cannot be enabled as it is not connected to a Node")
+            _LOGGER.warning(f"Interface {self} cannot be enabled as it is not connected to a Node")
             return
 
         if self._connected_node.operating_state != NodeOperatingState.ON:

src/primaite/simulator/network/hardware/base.py

@@ -297,7 +297,7 @@ class WiredNetworkInterface(NetworkInterface, ABC):
             return True
 
         if not self._connected_node:
-            _LOGGER.error(f"Interface {self} cannot be enabled as it is not connected to a Node")
+            _LOGGER.warning(f"Interface {self} cannot be enabled as it is not connected to a Node")
             return False
 
         if self._connected_node.operating_state != NodeOperatingState.ON:
@@ -343,11 +343,11 @@ class WiredNetworkInterface(NetworkInterface, ABC):
         :param link: The Link instance to connect to this network interface.
         """
         if self._connected_link:
-            _LOGGER.error(f"Cannot connect Link to network interface {self} as it already has a connection")
+            _LOGGER.warning(f"Cannot connect Link to network interface {self} as it already has a connection")
             return
 
         if self._connected_link == link:
-            _LOGGER.error(f"Cannot connect Link to network interface {self} as it is already connected")
+            _LOGGER.warning(f"Cannot connect Link to network interface {self} as it is already connected")
             return
 
         self._connected_link = link

src/primaite/simulator/system/applications/application.py

@@ -83,7 +83,7 @@ class Application(IOSoftware):
 
         if self.operating_state is not self.operating_state.RUNNING:
             # service is not running
-            _LOGGER.error(f"Cannot perform action: {self.name} is {self.operating_state.name}")
+            _LOGGER.debug(f"Cannot perform action: {self.name} is {self.operating_state.name}")
             return False
 
         return True

src/primaite/simulator/system/services/service.py

@@ -59,7 +59,7 @@ class Service(IOSoftware):
 
         if self.operating_state is not ServiceOperatingState.RUNNING:
             # service is not running
-            _LOGGER.error(f"Cannot perform action: {self.name} is {self.operating_state.name}")
+            _LOGGER.debug(f"Cannot perform action: {self.name} is {self.operating_state.name}")
             return False
 
         return True