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

Fix docstrings to use ReST format

Browse Source
This commit is contained in:
Marek Wolan
2023-06-01 09:54:45 +01:00
parent 76ec9683cb
commit a0960555fc
1 changed files with 6 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/primaite/environment/primaite_env.py
View File

@@ -648,12 +648,10 @@ class Primaite(Env):
`OBSERVATION_SPACE_FIXED_PARAMETERS`, `OBSERVATION_SPACE_HIGH_VALUE`, and `observation_type` `OBSERVATION_SPACE_FIXED_PARAMETERS`, `OBSERVATION_SPACE_HIGH_VALUE`, and `observation_type`
attributes to figure out the correct shape and format for the observation space. attributes to figure out the correct shape and format for the observation space.
Returns :return: Gym observation space
------- :rtype: gym.spaces.Space
gym.spaces.Space :return: Initial observation with all entires set to 0
Gym observation space :rtype: numpy.Array
numpy.Array
Initial observation with all entries set to 0
""" """
if self.observation_type == ObservationType.BOX: if self.observation_type == ObservationType.BOX:
_LOGGER.info("Observation space type BOX selected") _LOGGER.info("Observation space type BOX selected")
@@ -1179,10 +1177,8 @@ class Primaite(Env):
def get_observation_info(self, observation_info): def get_observation_info(self, observation_info):
"""Extracts observation_info. """Extracts observation_info.
Parameters :param observation_info: Config item that defines which type of observation space to use
---------- :type observation_info: str
observation_info : str
Config item that defines which type of observation space to use
""" """
self.observation_type = ObservationType[observation_info["type"]] self.observation_type = ObservationType[observation_info["type"]]