Update issue templates and env infos

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -48,7 +48,8 @@ body:
          * GPU models and configuration
          * Python version
          * PyTorch version
-         * Gym version
+         * Gymnasium version
+         * (if installed) OpenAI Gym version
          * Versions of any other relevant libraries
 
         You can use `sb3.get_system_info()` to print relevant packages info:

.github/ISSUE_TEMPLATE/custom_env.yml

@@ -34,9 +34,9 @@ body:
         Please use the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) for both code and stack traces.
       value: |
         ```python
-        import gym
+        import gymnasium as gym
         import numpy as np
-        from gym import spaces
+        from gymnasium import spaces
 
         from stable_baselines3 import A2C
         from stable_baselines3.common.env_checker import check_env
@@ -49,7 +49,7 @@ body:
                 self.observation_space = spaces.Box(low=-np.inf, high=np.inf, shape=(14,))
                 self.action_space = spaces.Box(low=-1, high=1, shape=(6,))
 
-            def reset(self, seed=None):
+            def reset(self, seed=None, options=None):
                 return self.observation_space.sample(), {}
 
             def step(self, action):
@@ -84,7 +84,8 @@ body:
          * GPU models and configuration
          * Python version
          * PyTorch version
-         * Gym version
+         * Gymnasium version
+         * (if installed) OpenAI Gym version
          * Versions of any other relevant libraries
 
         You can use `sb3.get_system_info()` to print relevant packages info:

docs/misc/changelog.rst

@@ -3,7 +3,7 @@
 Changelog
 ==========
 
-Release 2.0.0a4 (WIP)
+Release 2.0.0a5 (WIP)
 --------------------------
 
 **Gymnasium support**
@@ -51,6 +51,7 @@ Others:
 - Improve type annotation of wrappers
 - Tests envs are now checked too
 - Added render test for ``VecEnv``
+- Update issue templates and env info saved with the model
 
 Documentation:
 ^^^^^^^^^^^^^^

stable_baselines3/common/utils.py

@@ -8,6 +8,7 @@
 from itertools import zip_longest
 from typing import Dict, Iterable, List, Optional, Tuple, Union
 
+import cloudpickle
 import gymnasium as gym
 import numpy as np
 import torch as th
@@ -532,8 +533,16 @@ def get_system_info(print_info: bool = True) -> Tuple[Dict[str, str], str]:
         "PyTorch": th.__version__,
         "GPU Enabled": str(th.cuda.is_available()),
         "Numpy": np.__version__,
-        "Gym": gym.__version__,
+        "Cloudpickle": cloudpickle.__version__,
+        "Gymnasium": gym.__version__,
     }
+    try:
+        import gym as openai_gym  # pytype: disable=import-error
+
+        env_info.update({"OpenAI Gym": openai_gym.__version__})
+    except ImportError:
+        pass
+
     env_info_str = ""
     for key, value in env_info.items():
         env_info_str += f"- {key}: {value}\n"

stable_baselines3/version.txt

@@ -1 +1 @@
-2.0.0a4
+2.0.0a5