From 510292224c487ac091322bee79ea8b4232f24a6a Mon Sep 17 00:00:00 2001 From: Antonin RAFFIN Date: Sun, 31 Mar 2024 20:39:46 +0200 Subject: [PATCH] Release v2.3.0 (#236) --- docs/conf.py | 3 ++- docs/misc/changelog.rst | 6 +++++- sb3_contrib/version.txt | 2 +- setup.py | 2 +- 4 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 7e987ca5..a4b238e5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,6 +11,7 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # +import datetime import os import sys from typing import Dict @@ -44,7 +45,7 @@ # -- Project information ----------------------------------------------------- project = "Stable Baselines3 - Contrib" -copyright = "2023, Stable Baselines3" +copyright = f"2021-{datetime.date.today().year}, Stable Baselines3" author = "Stable Baselines3 Contributors" # The short X.Y version diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst index 9dc49f63..dc2b4177 100644 --- a/docs/misc/changelog.rst +++ b/docs/misc/changelog.rst @@ -3,9 +3,11 @@ Changelog ========== -Release 2.3.0a4 (WIP) +Release 2.3.0 (2024-03-31) -------------------------- +**New defaults hyperparameters for QR-DQN** + Breaking Changes: ^^^^^^^^^^^^^^^^^ - Upgraded to Stable-Baselines3 >= 2.3.0 @@ -23,6 +25,8 @@ Breaking Changes: New Features: ^^^^^^^^^^^^^ - Added ``rollout_buffer_class`` and ``rollout_buffer_kwargs`` arguments to MaskablePPO +- Log success rate ``rollout/success_rate`` when available for on policy algorithms + Bug Fixes: ^^^^^^^^^^ diff --git a/sb3_contrib/version.txt b/sb3_contrib/version.txt index a3b489b5..276cbf9e 100644 --- a/sb3_contrib/version.txt +++ b/sb3_contrib/version.txt @@ -1 +1 @@ -2.3.0a5 +2.3.0 diff --git a/setup.py b/setup.py index 63be4a6f..49b24588 100644 --- a/setup.py +++ b/setup.py @@ -65,7 +65,7 @@ packages=[package for package in find_packages() if package.startswith("sb3_contrib")], package_data={"sb3_contrib": ["py.typed", "version.txt"]}, install_requires=[ - "stable_baselines3>=2.3.0a5,<3.0", + "stable_baselines3>=2.3.0,<3.0", ], description="Contrib package of Stable Baselines3, experimental code.", author="Antonin Raffin",