stable-baselines3/stable_baselines3/common
Alex Pasquali 6a8c9ddc8b
Updated type hint and extended docstring in make_vec_env and make_atari_env (#1085)
* Updated type hint and extended docstring in make_vec_env

The function itself was already working with callables, but it wasn't considerent in the type hint of the function's signature.

Extended the description of the wrapper_class parameter with a link to a Github issue containing more details on the matter.

* Updated type hint in make_atari_env

The function itself was already working with callables, but it wasn't considerent in the type hint of the function's signature.

* Updated docstring in make_atari_env

When modifying the type hint of the parameter 'env_id' (in this commit: fda6872f73c11075901ba88f2520f6316f818d1d), I forgot to update its description in the docstrig.
Doing it now.

* Removed redundant type in env_id's type hint in make_vec_env and make_atari_env

Callable[..., gym.Env] already includes Type[gym.Env], as pointed out here: https://github.com/DLR-RM/stable-baselines3/pull/1085#issuecomment-1269685218

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2022-10-06 13:36:06 +02:00
..
envs Upgrade code to Python 3.7+ syntax using pyupgrade (#887) 2022-04-25 13:01:38 +03:00
sb2_compat Upgrade code to Python 3.7+ syntax using pyupgrade (#887) 2022-04-25 13:01:38 +03:00
vec_env Automatically create missing directories of `filenames passed to ResultsWriter` (#1072) 2022-09-21 13:14:38 +02:00
__init__.py Update docs (custom policy, type hints) (#167) 2020-09-29 20:41:14 +03:00
atari_wrappers.py Upgrade code to Python 3.7+ syntax using pyupgrade (#887) 2022-04-25 13:01:38 +03:00
base_class.py Fix return type for load, learn in BaseAlgorithm (#1043) 2022-09-26 12:13:56 +02:00
buffers.py Automatically create missing directories of `filenames passed to ResultsWriter` (#1072) 2022-09-21 13:14:38 +02:00
callbacks.py Clarify and standardize verbosity documentation (#1056) 2022-09-09 16:46:28 +02:00
distributions.py Handling multi-dimensional action spaces (#971) 2022-08-06 14:19:20 +02:00
env_checker.py Raise error when observation keys and observation space keys don't match (#1047) 2022-09-05 14:54:58 +02:00
env_util.py Updated type hint and extended docstring in make_vec_env and make_atari_env (#1085) 2022-10-06 13:36:06 +02:00
evaluation.py Fix evaluation script for recurrent policies (#678) 2021-11-30 13:49:06 +01:00
logger.py Fix duplicate key error in HumanOutputFormat (#1079) 2022-09-28 12:06:07 +02:00
monitor.py Automatically create missing directories of `filenames passed to ResultsWriter` (#1072) 2022-09-21 13:14:38 +02:00
noise.py Fix exception cause in base_class.py (#940) 2022-06-21 20:58:02 +01:00
off_policy_algorithm.py Fix return type for load, learn in BaseAlgorithm (#1043) 2022-09-26 12:13:56 +02:00
on_policy_algorithm.py Fixed typos (#1076) 2022-09-28 14:57:46 +02:00
policies.py Fix return type for load, learn in BaseAlgorithm (#1043) 2022-09-26 12:13:56 +02:00
preprocessing.py Documentation update (#450) 2021-05-23 13:13:11 +02:00
results_plotter.py Fix default arguments + add bugbear (#363) 2021-03-25 11:35:21 +02:00
running_mean_std.py Upgrade code to Python 3.7+ syntax using pyupgrade (#887) 2022-04-25 13:01:38 +03:00
save_util.py Clarify and standardize verbosity documentation (#1056) 2022-09-09 16:46:28 +02:00
torch_layers.py Replace "nature" with "Nature" (magazine) to reduce confusion (#965) 2022-07-15 22:48:27 +02:00
type_aliases.py Fix DictReplayBuffer.next_observations type (#1013) 2022-08-16 10:53:22 +02:00
utils.py Clarify and standardize verbosity documentation (#1056) 2022-09-09 16:46:28 +02:00