fix docstrings to reflect new env_info changes

This commit is contained in:
robcaulk 2022-12-15 16:50:08 +01:00
parent 7b4abd5ef5
commit 581a5296cc
2 changed files with 3 additions and 1 deletions

View File

@ -56,7 +56,8 @@ class BaseEnvironment(gym.Env):
:param id: string id of the environment (used in backend for multiprocessed env)
:param seed: Sets the seed of the environment higher in the gym.Env object
:param config: Typical user configuration file
:param env_info: Environment info dictionary, used to pass live status, fee, etc.
:param live: Whether or not this environment is active in dry/live/backtesting
:param fee: The fee to use for environmental interactions.
"""
self.config = config
self.rl_config = config['freqai']['rl_config']

View File

@ -402,6 +402,7 @@ def make_env(MyRLEnv: Type[gym.Env], env_id: str, rank: int,
:param num_env: (int) the number of environment you wish to have in subprocesses
:param seed: (int) the inital seed for RNG
:param rank: (int) index of the subprocess
:param env_info: (dict) all required arguments to instantiate the environment.
:return: (Callable)
"""