Fix outdated load_parameters to set_parameters (#1270)

* Update examples.rst * Update changelog Co-authored-by: Antonin Raffin <antonin.raffin@ensta.org>
DLR-RM · Jan 11, 2023 · 9bb1538 · 9bb1538
1 parent 6b8905a
commit 9bb1538
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 2 deletions.
diff --git a/docs/guide/examples.rst b/docs/guide/examples.rst
@@ -606,7 +606,7 @@ However, SB3 provides a ``save_replay_buffer()`` and ``load_replay_buffer()`` me
 Accessing and modifying model parameters
 ----------------------------------------
 
-You can access model's parameters via ``load_parameters`` and ``get_parameters`` functions,
+You can access model's parameters via ``set_parameters`` and ``get_parameters`` functions,
 or via ``model.policy.state_dict()`` (and ``load_state_dict()``),
 which use dictionaries that map variable names to PyTorch tensors.
 

diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst
@@ -4,6 +4,36 @@ Changelog
 ==========
 
 
+Release 1.8.0a0 (WIP)
+--------------------------
+
+
+Breaking Changes:
+^^^^^^^^^^^^^^^^^
+
+New Features:
+^^^^^^^^^^^^^
+
+`SB3-Contrib`_
+^^^^^^^^^^^^^^
+
+`RL Zoo`_
+^^^^^^^^^
+
+Bug Fixes:
+^^^^^^^^^^
+
+Deprecations:
+^^^^^^^^^^^^^
+
+Others:
+^^^^^^^
+
+Documentation:
+^^^^^^^^^^^^^^
+- Renamed ``load_parameters`` to ``set_parameters`` (@DavyMorgan)
+
+
 Release 1.7.0 (2023-01-10)
 --------------------------
 
@@ -1184,3 +1214,4 @@ And all the contributors:
 @Gregwar @ycheng517 @quantitative-technologies @bcollazo @git-thor @TibiGG @cool-RR @MWeltevrede
 @Melanol @qgallouedec @francescoluciano @jlp-ue @burakdmb @timothe-chaumont @honglu2875 @yuanmingqi
 @anand-bala @hughperkins @sidney-tio @AlexPasqua @dominicgkerr @Akhilez @Rocamonde @tobirohrer @ZikangXiong
+@DavyMorgan
diff --git a/stable_baselines3/version.txt b/stable_baselines3/version.txt
@@ -1 +1 @@
-1.7.0
+1.8.0a0