From 2954ca966f1f655f0927b161ff67306294a4b676 Mon Sep 17 00:00:00 2001 From: "Archer.Bowen" Date: Fri, 7 Jun 2024 16:35:33 +0100 Subject: [PATCH] Updated core user guide to match exactly that of 3.0.0/internal. --- docs/index.rst | 2 +- docs/source/example_notebooks.rst | 2 +- .../notebooks/Data-Manipulation-Customising-Red-Agent.ipynb | 2 +- src/primaite/notebooks/multi-processing.ipynb | 2 +- .../simulator/_package_data/create-simulation_demo.ipynb | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 729cdc17..289d05cf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,7 +54,7 @@ It is agnostic to the number of agents, their action / observation spaces, and t It presents a public API providing a method for describing the current state of the simulation, a method that accepts action requests and provides responses, and a method that triggers a timestep advancement. The Game Layer converts the simulation into a playable game for the agent(s). -it translates between simulation state and Gymnasium.Spaces to pass action / observation data between the agent(s) and the simulation. It is responsible for calculating rewards, managing Multi-Agent RL (MARL) action turns, and via a single agent interface can interact with Blue, Red and Green agents. +It translates between simulation state and Gymnasium.Spaces to pass action / observation data between the agent(s) and the simulation. It is responsible for calculating rewards, managing Multi-Agent RL (MARL) action turns, and via a single agent interface can interact with Blue, Red and Green agents. Agents can either generate their own scripted behaviour or accept input behaviour from an RL agent. diff --git a/docs/source/example_notebooks.rst b/docs/source/example_notebooks.rst index f207c601..e961da73 100644 --- a/docs/source/example_notebooks.rst +++ b/docs/source/example_notebooks.rst @@ -77,6 +77,6 @@ The following extensions should now be installed :width: 300 :align: center -VSCode will then ask for a Python environment version to use. PrimAITE is compatible with Python versions 3.8 - 3.10 +VSCode will then ask for a Python environment version to use. PrimAITE is compatible with Python versions 3.8 - 3.11 You should now be able to interact with the notebook. diff --git a/src/primaite/notebooks/Data-Manipulation-Customising-Red-Agent.ipynb b/src/primaite/notebooks/Data-Manipulation-Customising-Red-Agent.ipynb index 2f4c58e7..35cc4f58 100644 --- a/src/primaite/notebooks/Data-Manipulation-Customising-Red-Agent.ipynb +++ b/src/primaite/notebooks/Data-Manipulation-Customising-Red-Agent.ipynb @@ -12,7 +12,7 @@ "\n", "First, let's load the standard Data Manipulation config file, and see what the red agent does.\n", "\n", - "*(For a full explanation of the scenario, check out the data manipulation scenario notebook)*" + "*(For a full explanation of the Data Manipulation scenario, check out the data manipulation scenario notebook)*" ] }, { diff --git a/src/primaite/notebooks/multi-processing.ipynb b/src/primaite/notebooks/multi-processing.ipynb index 4880b48c..dd996901 100644 --- a/src/primaite/notebooks/multi-processing.ipynb +++ b/src/primaite/notebooks/multi-processing.ipynb @@ -8,7 +8,7 @@ "\n", "© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK\n", "\n", - "This note book uses SubprocVecEnv from SB3 for multi-processing." + "This notebook uses SubprocVecEnv from SB3" ] }, { diff --git a/src/primaite/simulator/_package_data/create-simulation_demo.ipynb b/src/primaite/simulator/_package_data/create-simulation_demo.ipynb index 6786125b..9f4abbf3 100644 --- a/src/primaite/simulator/_package_data/create-simulation_demo.ipynb +++ b/src/primaite/simulator/_package_data/create-simulation_demo.ipynb @@ -8,7 +8,7 @@ "\n", "© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK\n", "\n", - "Currently, this notebook manipulates the simulation by directly placing objects inside of the attributes of the network and domain. It should be refactored when proper methods exist for adding these objects.\n" + "Currently, this notebook manipulates the simulation by directly placing objects inside of the attributes of the network and domain. It should be refactored when proper methods exist for adding these objects." ] }, {