-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Feature Request] Remove eval_env
parameter
#925
Comments
Hey, |
Hello, However, you can of course work on such PR, please only deprecate the feature first (it should output a warning and remove the feature). |
) * 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 <[email protected]> Co-authored-by: Antonin RAFFIN <[email protected]> Co-authored-by: Quentin GALLOUÉDEC <[email protected]>
🚀 Feature
eval_env
andeval_freq
parameters were new in SB3 and were meant to facilitate evaluation in a separate env, by automatically creating evaluation env andEvalCallback
.However, they don't seem to be used that much and don't offer the flexibility of the
EvalCallback
at the cost of code duplication and maybe confusing parameters.The idea would be to first deprecate (next SB3 version) and then remove all the parameters related to that feature.
Main drawback is that this would be a breaking change for people implementing custom algorithms.
### Checklist
The text was updated successfully, but these errors were encountered: