Release v1.6.2 (#1103)

* Release v1.6.2 * Remove Gitlab CI, no more minutes
DLR-RM · Oct 10, 2022 · e2f81bb · e2f81bb
1 parent d8a430e
commit e2f81bb
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 <img src="docs/\_static/img/logo.png" align="right" width="40%"/>
 
-[![pipeline status](https://gitlab.com/araffin/stable-baselines3/badges/master/pipeline.svg)](https://gitlab.com/araffin/stable-baselines3/-/commits/master) [![Documentation Status](https://readthedocs.org/projects/stable-baselines/badge/?version=master)](https://stable-baselines3.readthedocs.io/en/master/?badge=master) [![coverage report](https://gitlab.com/araffin/stable-baselines3/badges/master/coverage.svg)](https://gitlab.com/araffin/stable-baselines3/-/commits/master)
+<!-- [![pipeline status](https://gitlab.com/araffin/stable-baselines3/badges/master/pipeline.svg)](https://gitlab.com/araffin/stable-baselines3/-/commits/master) -->
+![CI](https://github.com/DLR-RM/stable-baselines3/workflows/CI/badge.svg)
+[![Documentation Status](https://readthedocs.org/projects/stable-baselines/badge/?version=master)](https://stable-baselines3.readthedocs.io/en/master/?badge=master) [![coverage report](https://gitlab.com/araffin/stable-baselines3/badges/master/coverage.svg)](https://gitlab.com/araffin/stable-baselines3/-/commits/master)
 [![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 

diff --git a/docs/guide/rl_zoo.rst b/docs/guide/rl_zoo.rst
@@ -33,6 +33,11 @@ Installation
 	You can remove the ``--recursive`` option if you don't want to download the trained agents
 
 
+.. note::
+
+  If you only need the training/plotting scripts and additional callbacks/wrappers from the RL Zoo, you can also install it via pip: ``pip install rl_zoo3``
+
+
 2. Install dependencies
 ::
 
@@ -57,7 +62,7 @@ For example (with evaluation and checkpoints):
 
 ::
 
- python train.py --algo ppo2 --env CartPole-v1 --eval-freq 10000 --save-freq 50000
+ python train.py --algo ppo --env CartPole-v1 --eval-freq 10000 --save-freq 50000
 
 
 Continue training (here, load pretrained agent for Breakout and continue

diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst
@@ -2,8 +2,11 @@
 
 Changelog
 ==========
-Release 1.6.2a0 (WIP)
----------------------------
+
+Release 1.6.2 (2022-10-10)
+--------------------------
+
+**Progress bar in the learn() method, RL Zoo3 is now a package**
 
 Breaking Changes:
 ^^^^^^^^^^^^^^^^^
@@ -12,13 +15,15 @@ New Features:
 ^^^^^^^^^^^^^
 - Added ``progress_bar`` argument in the ``learn()`` method, displayed using TQDM and rich packages
 - Added progress bar callback
+- The `RL Zoo <https://github.com/DLR-RM/rl-baselines3-zoo>`_ can now be installed as a package (``pip install rl_zoo3``)
 
 SB3-Contrib
 ^^^^^^^^^^^
 
 Bug Fixes:
 ^^^^^^^^^^
 - ``self.num_timesteps`` was initialized properly only after the first call to ``on_step()`` for callbacks
+- Set importlib-metadata version to ``~=4.13`` to be compatible with ``gym=0.21``
 
 Deprecations:
 ^^^^^^^^^^^^^
@@ -32,6 +37,7 @@ Documentation:
 ^^^^^^^^^^^^^^
 - Extended docstring of the ``wrapper_class`` parameter in ``make_vec_env`` (@AlexPasqua)
 
+
 Release 1.6.1 (2022-09-29)
 ---------------------------
 

diff --git a/setup.py b/setup.py
@@ -82,6 +82,8 @@
         "pandas",
         # Plotting learning curves
         "matplotlib",
+        # gym and flake8 not compatible with importlib-metadata>5.0
+        "importlib-metadata~=4.13",
     ],
     extras_require={
         "tests": [
@@ -94,8 +96,6 @@
             "pytype",
             # Lint code
             "flake8>=3.8",
-            # flake8 not compatible with importlib-metadata>5.0
-            "importlib-metadata~=4.13",
             # Find likely bugs
             "flake8-bugbear",
             # Sort imports

diff --git a/stable_baselines3/version.txt b/stable_baselines3/version.txt
@@ -1 +1 @@
-1.6.2a0
+1.6.2