Merge remote-tracking branch 'origin/dev' into feature/2317-refactor-reset

src/primaite/notebooks/uc2_demo.ipynb

@@ -127,7 +127,7 @@
     "                - FILES\n",
     "                    - <file_id 1-1>\n",
     "                    - health_status\n",
-    "        - NICS\n",
+    "        - NETWORK_INTERFACES\n",
     "            - <nic_id 1-2>\n",
     "                - nic_status\n",
     "        - operating_status\n",
@@ -181,7 +181,7 @@
     "\n",
     "The ACL rules in the observation space appear in the same order that they do in the actual ACL. Though, only the first 10 rules are shown, there are default rules lower down that cannot be changed by the agent. The extra rules just allow the network to function normally, by allowing pings, ARP traffic, etc.\n",
     "\n",
-    "Most nodes have only 1 nic, so the observation for those is placed at NIC index 1 in the observation space. Only the security suite has 2 NICs, the second NIC in the observation space is the one that connects the security suite with swtich_2.\n",
+    "Most nodes have only 1 network_interface, so the observation for those is placed at NIC index 1 in the observation space. Only the security suite has 2 NICs, the second NIC in the observation space is the one that connects the security suite with swtich_2.\n",
     "\n",
     "The meaning of the services' operating_state is:\n",
     "|operating_state|label|\n",
@@ -314,7 +314,8 @@
     "The blue agent's reward is calculated using two measures:\n",
     "1. Whether the database file is in a good state (+1 for good, -1 for corrupted, 0 for any other state)\n",
     "2. Whether each green agents' most recent webpage request was successful (+1 for a `200` return code, -1 for a `404` return code and 0 otherwise).\n",
-    "The file status reward and the two green-agent-related reward are averaged to get a total step reward.\n"
+    "\n",
+    "The file status reward and the two green-agent-related rewards are averaged to get a total step reward.\n"
    ]
   },
   {
@@ -334,7 +335,9 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "%load_ext autoreload\n",
@@ -344,7 +347,9 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "# Imports\n",
@@ -367,7 +372,9 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "# create the env\n",
@@ -415,7 +422,9 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "for step in range(35):\n",
@@ -433,7 +442,9 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "pprint(obs['NODES'])"
@@ -449,7 +460,9 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "obs, reward, terminated, truncated, info = env.step(9)  # scan database file\n",
@@ -475,7 +488,9 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "obs, reward, terminated, truncated, info = env.step(13)  # patch the database\n",
@@ -500,7 +515,9 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "obs, reward, terminated, truncated, info = env.step(0)  # patch the database\n",
@@ -523,7 +540,9 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "env.step(13)  # Patch the database\n",
@@ -573,7 +592,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "venv",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -587,9 +606,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.12"
+   "version": "3.8.10"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }