stable-baselines3/docs/guide
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
..
algos.rst Update doc: SB3 Contrib RecurrentPPO (#927) 2022-05-31 18:11:16 +02:00
callbacks.rst Add progress bar callback and argument (#1095) 2022-10-06 18:17:31 +02:00
checking_nan.rst Standardized the use of `"` for string representation (#1086) 2022-10-03 15:15:39 +02:00
custom_env.rst Standardized the use of `"` for string representation (#1086) 2022-10-03 15:15:39 +02:00
custom_policy.rst Updated custom policy docs (#1067) 2022-09-18 09:17:57 +02:00
developer.rst Stable-Baselines3 v1.0 (#354) 2021-03-17 14:20:31 +01:00
examples.rst Deprecate create_eval_env, eval_env and eval_freq parameter (#1082) 2022-10-10 15:39:38 +02:00
export.rst Update export doc (fixes + add torch jit) (#1074) 2022-09-30 14:30:40 +02:00
imitation.rst Add imitation library docs (#200) 2020-10-24 17:33:26 +01:00
install.rst Fix url in docs (#1000) 2022-08-05 17:54:48 +02:00
integrations.rst Update doc and add check for unbounded action space (#918) 2022-05-25 16:24:21 +02:00
migration.rst Deprecate create_eval_env, eval_env and eval_freq parameter (#1082) 2022-10-10 15:39:38 +02:00
quickstart.rst Add progress bar callback and argument (#1095) 2022-10-06 18:17:31 +02:00
rl.rst Add base doc 2020-05-07 10:10:51 +02:00
rl_tips.rst Updated minor grammar error (#1041) 2022-08-31 18:04:15 +02:00
rl_zoo.rst Stable-Baselines3 v1.0 (#354) 2021-03-17 14:20:31 +01:00
save_format.rst System info helper (#613) 2021-10-18 10:43:56 +02:00
sb3_contrib.rst Update doc: SB3 Contrib RecurrentPPO (#927) 2022-05-31 18:11:16 +02:00
tensorboard.rst Standardized the use of `"` for string representation (#1086) 2022-10-03 15:15:39 +02:00
vec_envs.rst Documentation fixes (#514) 2021-07-18 20:51:41 +02:00