diff --git a/README.md b/README.md index 973a180..d7c9261 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -[![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) + +![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 index 9b25573..ea15832 100644 --- 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 index c2ac341..9abe1e0 100644 --- 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,6 +15,7 @@ New Features: ^^^^^^^^^^^^^ - Added ``progress_bar`` argument in the ``learn()`` method, displayed using TQDM and rich packages - Added progress bar callback +- The `RL Zoo `_ can now be installed as a package (``pip install rl_zoo3``) SB3-Contrib ^^^^^^^^^^^ @@ -19,6 +23,7 @@ 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 index 7e40c44..58c04fa 100644 --- a/setup.py +++ b/setup.py @@ -82,6 +82,8 @@ setup( "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 @@ setup( "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 index 2f7c3d4..fdd3be6 100644 --- a/stable_baselines3/version.txt +++ b/stable_baselines3/version.txt @@ -1 +1 @@ -1.6.2a0 +1.6.2