File tree 3 files changed +5
-2
lines changed
stable_baselines/common/vec_env
3 files changed +5
-2
lines changed Original file line number Diff line number Diff line change @@ -63,6 +63,7 @@ Others:
63
63
- Minor PEP8 fixes in dqn.py (@justinkterry)
64
64
- Add a message to the assert in `PPO2 `
65
65
- Update replay buffer doctring
66
+ - Fix `VecEnv ` docstrings
66
67
67
68
Documentation:
68
69
^^^^^^^^^^^^^^
Original file line number Diff line number Diff line change @@ -12,7 +12,8 @@ class DummyVecEnv(VecEnv):
12
12
multiprocess or multithread outweighs the environment computation time. This can also be used for RL methods that
13
13
require a vectorized environment, but that you want a single environments to train with.
14
14
15
- :param env_fns: ([Gym Environment]) the list of environments to vectorize
15
+ :param env_fns: ([callable]) A list of functions that will create the environments
16
+ (each callable return a `Gym.Env` instance when called).
16
17
"""
17
18
18
19
def __init__ (self , env_fns ):
Original file line number Diff line number Diff line change @@ -62,7 +62,8 @@ class SubprocVecEnv(VecEnv):
62
62
``if __name__ == "__main__":`` block.
63
63
For more information, see the multiprocessing documentation.
64
64
65
- :param env_fns: ([Gym Environment]) Environments to run in subprocesses
65
+ :param env_fns: ([callable]) A list of functions that will create the environments
66
+ (each callable return a `Gym.Env` instance when called).
66
67
:param start_method: (str) method used to start the subprocesses.
67
68
Must be one of the methods returned by multiprocessing.get_all_start_methods().
68
69
Defaults to 'forkserver' on available platforms, and 'spawn' otherwise.
You can’t perform that action at this time.
0 commit comments