Release v1.8.0 (#374)

Author: araffin

CHANGELOG.md

@@ -1,4 +1,12 @@
-## Release 1.8.0a13 (WIP)
+## Release 1.8.0 (2023-04-07)
+
+**New Documentation, Multi-Env HerReplayBuffer**
+
+> **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
 - Upgraded to SB3 >= 1.8.0

requirements.txt

@@ -1,6 +1,6 @@
 gym==0.21
-stable-baselines3[extra_no_roms,tests,docs]>=1.8.0a13,<2.0
-sb3-contrib>=1.8.0a13,<2.0
+stable-baselines3[extra_no_roms,tests,docs]>=1.8.0,<2.0
+sb3-contrib>=1.8.0,<2.0
 box2d-py==2.3.8
 pybullet
 gym-minigrid

rl_zoo3/train.py

@@ -130,13 +130,6 @@ def train() -> None:
         help="Custom yaml file or python package from which the hyperparameters will be loaded."
         "We expect that python packages contain a dictionary called 'hyperparams' which contains a key for each environment.",
     )
-    parser.add_argument(
-        "-yaml",
-        "--yaml-file",
-        type=str,
-        default=None,
-        help="This parameter is deprecated, please use `--conf-file` instead",
-    )
     parser.add_argument("-uuid", "--uuid", action="store_true", default=False, help="Ensure that the run has a unique ID")
     parser.add_argument(
         "--track",
@@ -166,11 +159,6 @@ def train() -> None:
     env_id = args.env
     registered_envs = set(gym.envs.registry.env_specs.keys())  # pytype: disable=module-attr
 
-    if args.yaml_file is not None:
-        raise ValueError(
-            "The`--yaml-file` parameter is deprecated and will be removed in RL Zoo3 v1.8, please use `--conf-file` instead",
-        )
-
     # If the environment is not found, suggest the closest match
     if env_id not in registered_envs:
         try:

rl_zoo3/version.txt

@@ -1 +1 @@
-1.8.0a13
+1.8.0

setup.py

@@ -27,7 +27,7 @@
     },
     entry_points={"console_scripts": ["rl_zoo3=rl_zoo3.cli:main"]},
     install_requires=[
-        "sb3-contrib>=1.8.0a13,<2.0",
+        "sb3-contrib>=1.8.0,<2.0",
         "huggingface_sb3>=2.2.1",
         "tqdm",
         "rich",