From 736408f8b4b0ac070be6e49544ed5feb2ccccb16 Mon Sep 17 00:00:00 2001 From: Marek Wolan Date: Thu, 25 Apr 2024 15:12:46 +0100 Subject: [PATCH] Reference the episode schedule notebook in docs --- docs/source/config.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/source/config.rst b/docs/source/config.rst index b334d99b..57948ae2 100644 --- a/docs/source/config.rst +++ b/docs/source/config.rst @@ -5,7 +5,7 @@ PrimAITE |VERSION| Configuration ******************************** -PrimAITE uses a single configuration file to define everything needed to create the training environment for RL agents, including the network, the scripted agents, and the RL agent's action space, observation space, and reward function. +PrimAITE uses YAML configuration files to define everything needed to create the training environment for RL agents, including the network, the scripted agents, and the RL agent's action space, observation space, and reward function. Example Configuration Hierarchy ############################### @@ -34,3 +34,8 @@ Configurable items configuration/game.rst configuration/agents.rst configuration/simulation.rst + +Varying The Configuration Each Episode +###################################### + +PrimAITE allows for the configuration to be varied each episode. This is done by specifying a configuration folder instead of a single file. A full explanation is provided in the notebook `Using-Episode-Schedules.ipynb`. Please find the notebook in the user notebooks directory.