stable-baselines3/tests
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
..
__init__.py Init: TD3 2019-09-05 17:29:41 +02:00
test_buffers.py Support for device=auto buffers and set it as default value (#1009) 2022-08-16 17:54:55 +02:00
test_callbacks.py Add progress bar callback and argument (#1095) 2022-10-06 18:17:31 +02:00
test_cnn.py Add skip option for VecTransposeImage and bug fix in frame stack (#700) 2021-12-23 17:12:49 +02:00
test_custom_policy.py Gym fixes - Follow up from #705 (#734) 2022-02-04 15:13:57 -08:00
test_deterministic.py Gym fixes - Follow up from #705 (#734) 2022-02-04 15:13:57 -08:00
test_dict_env.py Multiprocessing support for off policy algorithms (#439) 2021-12-01 22:30:09 +01:00
test_distributions.py Release v1.6.0 (#958) 2022-07-12 22:50:23 +02:00
test_env_checker.py Gym fixes - Follow up from #705 (#734) 2022-02-04 15:13:57 -08:00
test_envs.py Raise error when observation keys and observation space keys don't match (#1047) 2022-09-05 14:54:58 +02:00
test_gae.py Upgrade code to Python 3.7+ syntax using pyupgrade (#887) 2022-04-25 13:01:38 +03:00
test_her.py Upgrade code to Python 3.7+ syntax using pyupgrade (#887) 2022-04-25 13:01:38 +03:00
test_identity.py Add timeout handling for on-policy algorithms (#658) 2021-11-16 17:19:16 +01:00
test_logger.py Fix duplicate key error in HumanOutputFormat (#1079) 2022-09-28 12:06:07 +02:00
test_monitor.py Automatically create missing directories of `filenames passed to ResultsWriter` (#1072) 2022-09-21 13:14:38 +02:00
test_predict.py Deprecate create_eval_env, eval_env and eval_freq parameter (#1082) 2022-10-10 15:39:38 +02:00
test_run.py Deprecate create_eval_env, eval_env and eval_freq parameter (#1082) 2022-10-10 15:39:38 +02:00
test_save_load.py Fix loading a model with different number of environments (#1058) 2022-09-17 11:10:03 +02:00
test_sde.py Deprecate create_eval_env, eval_env and eval_freq parameter (#1082) 2022-10-10 15:39:38 +02:00
test_spaces.py Handling multi-dimensional action spaces (#971) 2022-08-06 14:19:20 +02:00
test_tensorboard.py Support hparams logging to tensorboard (#984) 2022-08-22 22:06:54 +02:00
test_train_eval_mode.py Include running_mean and running_val when updating target networks (#1004) 2022-08-23 10:20:43 +02:00
test_utils.py Fix advantage normalization with mini-batchsize of 1 (#1028) 2022-08-25 11:50:08 +02:00
test_vec_check_nan.py Upgrade code to Python 3.7+ syntax using pyupgrade (#887) 2022-04-25 13:01:38 +03:00
test_vec_envs.py Fixed unchecked None value in SubprocVecEnv (#808) 2022-04-12 16:05:40 +02:00
test_vec_extract_dict_obs.py Support for VecMonitor for gym3-style environments (#311) 2021-04-13 18:09:31 +02:00
test_vec_monitor.py Upgrade code to Python 3.7+ syntax using pyupgrade (#887) 2022-04-25 13:01:38 +03:00
test_vec_normalize.py Deprecate create_eval_env, eval_env and eval_freq parameter (#1082) 2022-10-10 15:39:38 +02:00