From a84ad3aa7d756780cdafdd0e16fd5a74e189f6df Mon Sep 17 00:00:00 2001 From: Antonin RAFFIN Date: Sat, 8 Apr 2023 15:50:04 +0200 Subject: [PATCH] Release v1.8.0 (#173) --- docs/misc/changelog.rst | 13 +++++++++++-- sb3_contrib/common/maskable/policies.py | 6 ------ sb3_contrib/version.txt | 2 +- setup.py | 2 +- 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst index 7465acd..a53fd99 100644 --- a/docs/misc/changelog.rst +++ b/docs/misc/changelog.rst @@ -3,9 +3,17 @@ Changelog ========== -Release 1.8.0a14 (WIP) +Release 1.8.0 (2023-04-07) -------------------------- +.. warning:: + + Stable-Baselines3 (SB3) v1.8.0 will be the last one to use Gym as a backend. + Starting with v2.0.0, Gymnasium will be the default backend (though SB3 will have compatibility layers for Gym envs). + You can find a migration guide here: https://gymnasium.farama.org/content/migration-guide/. + If you want to try the SB3 v2.0 alpha version, you can take a look at `PR #1327 `_. + + Breaking Changes: ^^^^^^^^^^^^^^^^^ - Removed shared layers in ``mlp_extractor`` (@AlexPasqua) @@ -23,10 +31,11 @@ Deprecations: Others: ^^^^^^^ -- Moved to pyproject.toml (except flake8) +- Moved to pyproject.toml - Added github issue forms - Fixed Atari Roms download in CI - Fixed ``sb3_contrib/qrdqn/*.py`` type hints +- Switched from ``flake8`` to ``ruff`` Documentation: ^^^^^^^^^^^^^^ diff --git a/sb3_contrib/common/maskable/policies.py b/sb3_contrib/common/maskable/policies.py index 920449b..c3cfed6 100644 --- a/sb3_contrib/common/maskable/policies.py +++ b/sb3_contrib/common/maskable/policies.py @@ -270,12 +270,6 @@ class MaskableActorCriticPolicy(BasePolicy): :return: the model's action and the next state (used in recurrent policies) """ - # TODO (GH/1): add support for RNN policies - # if state is None: - # state = self.initial_state - # if episode_start is None: - # episode_start = [False for _ in range(self.n_envs)] - # Switch to eval mode (this affects batch norm / dropout) self.set_training_mode(False) diff --git a/sb3_contrib/version.txt b/sb3_contrib/version.txt index ee006ce..27f9cd3 100644 --- a/sb3_contrib/version.txt +++ b/sb3_contrib/version.txt @@ -1 +1 @@ -1.8.0a14 +1.8.0 diff --git a/setup.py b/setup.py index fd78860..ac81d5b 100644 --- a/setup.py +++ b/setup.py @@ -65,7 +65,7 @@ setup( packages=[package for package in find_packages() if package.startswith("sb3_contrib")], package_data={"sb3_contrib": ["py.typed", "version.txt"]}, install_requires=[ - "stable_baselines3>=1.8.0a14", + "stable_baselines3>=1.8.0,<2.0", ], description="Contrib package of Stable Baselines3, experimental code.", author="Antonin Raffin",