oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated core user guide to match exactly that of 3.0.0/internal.

Browse Source
This commit is contained in:
Archer.Bowen
2024-06-07 16:35:33 +01:00
parent 29d42a88dc
commit 2954ca966f
5 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/index.rst
View File

@@ -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. 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). 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. Agents can either generate their own scripted behaviour or accept input behaviour from an RL agent.

2
docs/source/example_notebooks.rst
View File

@@ -77,6 +77,6 @@ The following extensions should now be installed
:width: 300 :width: 300
:align: center :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. You should now be able to interact with the notebook.

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

@@ -12,7 +12,7 @@
"\n", "\n",
"First, let's load the standard Data Manipulation config file, and see what the red agent does.\n", "First, let's load the standard Data Manipulation config file, and see what the red agent does.\n",
"\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)*"
] ]
}, },
{ {

2
src/primaite/notebooks/multi-processing.ipynb
View File

@@ -8,7 +8,7 @@
"\n", "\n",
"© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK\n", "© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK\n",
"\n", "\n",
"This note book uses SubprocVecEnv from SB3 for multi-processing." "This notebook uses SubprocVecEnv from SB3"
] ]
}, },
{ {

2
src/primaite/simulator/_package_data/create-simulation_demo.ipynb
View File

@@ -8,7 +8,7 @@
"\n", "\n",
"© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK\n", "© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK\n",
"\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."
] ]
}, },
{ {