Release 1.4.0 (DLR-RM#729)

* Release 1.4.0 * Add integration section in the readme
squalidux · Jan 19, 2022 · 21f6a47 · 21f6a47
1 parent cd6e047
commit 21f6a47
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -49,6 +49,11 @@ A migration guide from SB2 to SB3 can be found in the [documentation](https://st
 
 Documentation is available online: [https://stable-baselines3.readthedocs.io/](https://stable-baselines3.readthedocs.io/)
 
+## Integrations
+
+Stable-Baselines3 has some integration with other libraries/services like Weights & Biases for experiment tracking or Hugging Face for storing/sharing trained models. You can find out more in the [dedicated section](https://stable-baselines3.readthedocs.io/en/master/guide/integrations.html) of the documentation. 
+
+
 ## RL Baselines3 Zoo: A Training Framework for Stable Baselines3 Reinforcement Learning Agents
 
 [RL Baselines3 Zoo](https://github.com/DLR-RM/rl-baselines3-zoo) is a training framework for Reinforcement Learning (RL).

diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst
@@ -4,9 +4,11 @@ Changelog
 ==========
 
 
-Release 1.3.1a9 (WIP)
+Release 1.4.0 (2022-01-18)
 ---------------------------
 
+*TRPO, ARS and multi env training for off-policy algorithms*
+
 Breaking Changes:
 ^^^^^^^^^^^^^^^^^
 - Dropped python 3.6 support (as announced in previous release)
@@ -15,6 +17,15 @@ Breaking Changes:
   this may affect custom callbacks.
 - Removed ``episode_reward`` field from ``RolloutReturn()`` type
 
+
+.. warning::
+
+    An update to the ``HER`` algorithm is planned to support multi-env training and remove the max episode length constrain.
+    (see `PR #704 <https://github.com/DLR-RM/stable-baselines3/pull/704>`_)
+    This will be a backward incompatible change (model trained with previous version of ``HER`` won't work with the new version).
+
+
+
 New Features:
 ^^^^^^^^^^^^^
 - Added ``norm_obs_keys`` param for ``VecNormalize`` wrapper to configure which observation keys to normalize (@kachayev)
@@ -27,6 +38,7 @@ SB3-Contrib
 ^^^^^^^^^^^
 - Added Trust Region Policy Optimization (TRPO) (@cyprienc)
 - Added Augmented Random Search (ARS) (@sgillen)
+- Coming soon: PPO LSTM, see https://github.com/Stable-Baselines-Team/stable-baselines3-contrib/pull/53
 
 Bug Fixes:
 ^^^^^^^^^^

diff --git a/stable_baselines3/version.txt b/stable_baselines3/version.txt
@@ -1 +1 @@
-1.3.1a9
+1.4.0