mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-11-16 08:49:07 +00:00
Update doc about Gymnasium support (#1382)
This commit is contained in:
parent
470771b5c2
commit
e5deeed16e
2 changed files with 13 additions and 3 deletions
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -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)
|
||||
--------------------------
|
||||
|
|
|
|||
Loading…
Reference in a new issue