Skip to content
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.

Sign up for GitHub

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

Update doc about Gymnasium support #1382

Merged
merged 1 commit into from
Mar 14, 2023
Merged

Update doc about Gymnasium support #1382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/guide/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,15 @@ Bleeding-edge version

.. note::

If you want to use latest gym version (0.24+), you have to use
If you want to use Gymnasium (or the latest Gym version 0.24+), you have to use

.. code-block:: bash

pip install git+https://github.com/carlosluis/stable-baselines3@fix_tests
pip install git+https://github.com/DLR-RM/stable-baselines3@feat/gymnasium-support
pip install git+https://github.com/Stable-Baselines-Team/stable-baselines3-contrib@feat/gymnasium-support

See `PR #780 <https://github.com/DLR-RM/stable-baselines3/pull/780>`_ for more information.

See `PR #1327 <https://github.com/DLR-RM/stable-baselines3/pull/1327>`_ for more information.


Development version
Expand Down
8 changes: 8 additions & 0 deletions docs/misc/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ Changelog
Release 1.8.0a9 (WIP)
--------------------------

.. 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 <https://github.com/DLR-RM/stable-baselines3/pull/1327>`_.


Breaking Changes:
^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -56,6 +63,7 @@ Documentation:
- Renamed timesteps to episodes for ``log_interval`` description (@theSquaredError)
- Removed note about gif creation for Atari games (@harveybellini)
- Added information about default network architecture
- Update information about Gymnasium support

Release 1.7.0 (2023-01-10)
--------------------------
Expand Down