Sourced from stable-baselines3's releases.

v2.6.0: New LogEveryNTimesteps callback and has_attr method, refactored hyperparameter optimization

SB3 Contrib (more algorithms): https://github.com/Stable-Baselines-Team/stable-baselines3-contrib RL Zoo3 (training framework): https://github.com/DLR-RM/rl-baselines3-zoo Stable-Baselines Jax (SBX): https://github.com/araffin/sbx

To upgrade:

pip install stable_baselines3 sb3_contrib rl_zoo3 --upgrade

New Features:

• Added has_attr method for VecEnv to check if an attribute exists
• Added LogEveryNTimesteps callback to dump logs every N timesteps (note: you need to pass log_interval=None to avoid any interference)
• Added Gymnasium v1.1 support

Bug fixes:

• SubProcVecEnv will now exit gracefully (without big traceback) when using KeyboardInterrupt

SB3-Contrib

• Renamed _dump_logs() to dump_logs()
• Fixed issues with SubprocVecEnv and MaskablePPO by using vec_env.has_attr() (pickling issues, mask function not present)

RL Zoo

• Refactored hyperparameter optimization. The Optuna Journal storage backend is now supported (recommended default) and you can easily load tuned hyperparameter via the new --trial-id argument of train.py.
• Save the exact command line used to launch a training
• Added support for special vectorized env (e.g. Brax, IsaacSim) by allowing to override the VecEnv class use to instantiate the env in the ExperimentManager
• Allow to disable auto-logging by passing --log-interval -2 (useful when logging things manually)
• Added Gymnasium v1.1 support
• Fixed use of old HF api in get_hf_trained_models()

SBX (SB3 + Jax)

• Updated PPO to support net_arch, and additional fixes
• Fixed entropy coeff wrongly logged for SAC and derivatives.
• Fixed PPO predict() for env that were not normalized (action spaces with limits != [-1, 1])
• PPO now logs the standard deviation

Deprecations:

• algo._dump_logs() is deprecated in favor of algo.dump_logs() and will be removed in SB3 v2.7.0

Others:

• Updated black from v24 to v25
• Improved error messages when checking Box space equality (loading VecNormalize)
• Updated test to reflect how set_wrapper_attr should be used now

Documentation:

• Clarify the use of Gym wrappers with make_vec_env in the section on Vectorized Environments (@​pstahlhofen)
• Updated callback doc for EveryNTimesteps
• Added doc on how to set env attributes via VecEnv calls
• Added ONNX export example for MultiInputPolicy (@​darkopetrovic)

... (truncated)

• ea913a8 Release v2.6.0 (#2109)
• 656de97 Add ONNX export example for MultiInputPolicy (#2098)
• 55d6f18 Add support for Gymnasium v1.1.0 (#2095)
• fa21bce Clarifying the documentation for custom env using images as observations (#2085)
• 8c78653 Add LogEveryNTimesteps callback (#2083)
• c5c29a3 Clarify the use of Gym wrappers with make_vec_env (#2079)
• b8b2d30 Add has_attr for VecEnv (#2077)
• ee8a77d Release v2.5.0 (#2074)
• f8ea299 Doc update: custom envs, IsaacLab, Brax and dm_control (#2072)
• d055a2e fix docs atari example by import ale_py (#2071)
• Additional commits viewable in compare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)