From 3b0d05e9c97433dd380fd02cf1301208d4735e01 Mon Sep 17 00:00:00 2001 From: Marek Wolan Date: Thu, 1 Jun 2023 11:02:10 +0100 Subject: [PATCH] More info in docstring --- src/primaite/environment/primaite_env.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/primaite/environment/primaite_env.py b/src/primaite/environment/primaite_env.py index 67ab5375..56893ee9 100644 --- a/src/primaite/environment/primaite_env.py +++ b/src/primaite/environment/primaite_env.py @@ -763,6 +763,7 @@ class Primaite(Env): def _update_env_obs_box(self): """Update the environment's observation state based on the current status of nodes and links. + The structure of the observation space is described in :func:`~_init_box_observations` This function can only be called if the observation space setting is set to BOX. :raises AssertionError: If this function is called when the environment has the incorrect ``observation_type`` @@ -813,6 +814,7 @@ class Primaite(Env): def _update_env_obs_multidiscrete(self): """Update the environment's observation state based on the current status of nodes and links. + The structure of the observation space is described in :func:`~_init_multidiscrete_observations` This function can only be called if the observation space setting is set to MULTIDISCRETE. :raises AssertionError: If this function is called when the environment has the incorrect ``observation_type``