stable-baselines3/stable_baselines3/common
tobirohrer d8a430e088
Deprecate create_eval_env, eval_env and eval_freq parameter (#1082)
* Adds deprecation warning if `eval_env` or `eval_freq` parameters are used. See #925

* added changelog entry

* added missing backtick

* deprecating `create_eval_env` parameter as well and adding comments to explain the `stacklevel` parameter used

* Updated tests to ignore DeprecationWarnings

* Updated changelog entry

* - Removed the `create_eval_env` parameter from the examples in the docs
- Removed information about the `create_eval_env` parameter from the migration docs
- Added information about deprecation of the `create_eval_env` parameter in the docs

* Add alternative in docstring

* Update docstrings

* `eval_freq` warning in docstring

* Add deprecation comments in tests

Co-authored-by: Quentin Gallouédec <45557362+qgallouedec@users.noreply.github.com>
Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
Co-authored-by: Quentin GALLOUÉDEC <gallouedec.quentin@gmail.com>
2022-10-10 15:39:38 +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 Deprecate create_eval_env, eval_env and eval_freq parameter (#1082) 2022-10-10 15:39:38 +02:00
buffers.py Automatically create missing directories of `filenames passed to ResultsWriter` (#1072) 2022-09-21 13:14:38 +02:00
callbacks.py Add progress bar callback and argument (#1095) 2022-10-06 18:17:31 +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 Add progress bar callback and argument (#1095) 2022-10-06 18:17:31 +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 Deprecate create_eval_env, eval_env and eval_freq parameter (#1082) 2022-10-10 15:39:38 +02:00
on_policy_algorithm.py Deprecate create_eval_env, eval_env and eval_freq parameter (#1082) 2022-10-10 15:39:38 +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