From ea83bca45605d4511308bae0d409b15b2ca28f6b Mon Sep 17 00:00:00 2001 From: conorheins Date: Sun, 13 Mar 2022 17:35:27 +0100 Subject: [PATCH] added reference to env.rst in index.rst --- docs/env.rst | 24 ++++++++++++++++++++++++ docs/index.rst | 2 +- 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 docs/env.rst diff --git a/docs/env.rst b/docs/env.rst new file mode 100644 index 00000000..93b1b5bd --- /dev/null +++ b/docs/env.rst @@ -0,0 +1,24 @@ +Env +======== + +The OpenAIGym-inspired ``Env`` base class is the main API that represents the environmental dynamics or "generative process" with +which agents exchange observations and actions + +Base class +---------- +.. autoclass:: pymdp.envs.Env + +Specific environment implementations +---------- + +All of the following dynamics inherit from ``Env`` and have the +same general usage as above. + +.. autosummary:: + :nosignatures: + + pymdp.envs.GridWorldEnv + pymdp.envs.DGridWorldEnv + pymdp.envs.VisualForagingEnv + pymdp.envs.TMazeEnv + pymdp.envs.TMazeEnvNullOutcome diff --git a/docs/index.rst b/docs/index.rst index a79d290b..c4314f97 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -42,7 +42,7 @@ specificity to a given task. :caption: Agent and environment API agent - env/index + env Indices and tables ==================