Update metadata to autoreset_mode and add tests on it

Farama-Foundation · Nov 28, 2024 · d031c42 · d031c42
1 parent 781e6f5
commit d031c42
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 11 deletions.
diff --git a/gymnasium/envs/classic_control/cartpole.py b/gymnasium/envs/classic_control/cartpole.py
@@ -355,7 +355,7 @@ class CartPoleVectorEnv(VectorEnv):
     metadata = {
         "render_modes": ["rgb_array"],
         "render_fps": 50,
-        "autoreset-mode": AutoresetMode.NEXT_STEP,
+        "autoreset_mode": AutoresetMode.NEXT_STEP,
     }
 
     def __init__(

diff --git a/gymnasium/envs/functional_jax_env.py b/gymnasium/envs/functional_jax_env.py
@@ -116,7 +116,7 @@ def __init__(
         """Initialize the environment from a FuncEnv."""
         super().__init__()
         if metadata is None:
-            metadata = {"AutoresetMode": AutoresetMode.NEXT_STEP}
+            metadata = {"autoreset_mode": AutoresetMode.NEXT_STEP}
         self.func_env = func_env
         self.num_envs = num_envs
 

diff --git a/gymnasium/envs/phys2d/cartpole.py b/gymnasium/envs/phys2d/cartpole.py
@@ -277,7 +277,7 @@ class CartPoleJaxVectorEnv(FunctionalJaxVectorEnv, EzPickle):
         "render_modes": ["rgb_array"],
         "render_fps": 50,
         "jax": True,
-        "AutoresetMode": AutoresetMode.NEXT_STEP,
+        "autoreset_mode": AutoresetMode.NEXT_STEP,
     }
 
     def __init__(

diff --git a/gymnasium/envs/phys2d/pendulum.py b/gymnasium/envs/phys2d/pendulum.py
@@ -230,7 +230,7 @@ class PendulumJaxEnv(FunctionalJaxEnv, EzPickle):
         "render_modes": ["rgb_array"],
         "render_fps": 30,
         "jax": True,
-        "AutoresetMode": AutoresetMode.NEXT_STEP,
+        "autoreset_mode": AutoresetMode.NEXT_STEP,
     }
 
     def __init__(self, render_mode: str | None = None, **kwargs: Any):

diff --git a/gymnasium/envs/registration.py b/gymnasium/envs/registration.py
@@ -978,11 +978,13 @@ def create_single_env() -> Env:
         copied_id_spec.kwargs["wrappers"] = wrappers
     env.unwrapped.spec = copied_id_spec
 
-    if "AutoresetMode" not in env.metadata:
-        warn(f"The VectorEnv ({env}) is missing AutoresetMode metadata.")
-    elif not isinstance(env.metadata["AutoresetMode"], AutoresetMode):
+    if "autoreset_mode" not in env.metadata:
         warn(
-            f"The VectorEnv ({env}) AutoresetMode metadata is not an instance of AutoresetMode, {type(env.metadata['AutoresetMode'])}."
+            f"The VectorEnv ({env}) is missing AutoresetMode metadata, metadata={env.metadata}"
+        )
+    elif not isinstance(env.metadata["autoreset_mode"], AutoresetMode):
+        warn(
+            f"The VectorEnv ({env}) metadata['autoreset_mode'] is not an instance of AutoresetMode, {type(env.metadata['autoreset_mode'])}."
         )
 
     return env

diff --git a/gymnasium/envs/tabular/blackjack.py b/gymnasium/envs/tabular/blackjack.py
@@ -240,7 +240,7 @@ class BlackjackFunctional(
     metadata = {
         "render_modes": ["rgb_array"],
         "render_fps": 4,
-        "AutoresetMode": AutoresetMode.NEXT_STEP,
+        "autoreseet-mode": AutoresetMode.NEXT_STEP,
     }
 
     def transition(

diff --git a/gymnasium/envs/tabular/cliffwalking.py b/gymnasium/envs/tabular/cliffwalking.py
@@ -137,7 +137,7 @@ class CliffWalkingFunctional(
     metadata = {
         "render_modes": ["rgb_array"],
         "render_fps": 4,
-        "AutoresetMode": AutoresetMode.NEXT_STEP,
+        "autoreset_mode": AutoresetMode.NEXT_STEP,
     }
 
     def transition(

diff --git a/tests/envs/registration/test_make_vec.py b/tests/envs/registration/test_make_vec.py
@@ -2,14 +2,15 @@
 
 import multiprocessing
 import re
+import warnings
 
 import pytest
 
 import gymnasium as gym
 from gymnasium import VectorizeMode, error, wrappers
 from gymnasium.envs.classic_control import CartPoleEnv
 from gymnasium.envs.classic_control.cartpole import CartPoleVectorEnv
-from gymnasium.vector import AsyncVectorEnv, SyncVectorEnv
+from gymnasium.vector import AsyncVectorEnv, SyncVectorEnv, VectorEnv
 from gymnasium.wrappers import TimeLimit, TransformObservation
 from tests.wrappers.utils import has_wrapper
 
@@ -282,3 +283,44 @@ def test_make_vec_with_spec_additional_wrappers():
 
     del gym.registry["TestEnv-v0"]
     del gym.registry["TestEnv-v1"]
+
+
+class MissingMetadataVecEnv(VectorEnv):
+    metadata = {"render_fps": 1}
+
+    def __init__(self, num_envs: int):
+        self.num_envs = num_envs
+
+
+class IncorrectMetadataVecEnv(VectorEnv):
+    metadata = {"autoreset_mode": "next_step"}
+
+    def __init__(self, num_envs: int):
+        self.num_envs = num_envs
+
+
+def test_missing_autoreset_mode_metadata():
+    gym.register("MissingMetadataVecEnv-v0", vector_entry_point=MissingMetadataVecEnv)
+    gym.register(
+        "IncorrectMetadataVecEnv-v0", vector_entry_point=IncorrectMetadataVecEnv
+    )
+
+    with warnings.catch_warnings():
+        with pytest.warns(
+            UserWarning,
+            match=re.escape(
+                "The VectorEnv (MissingMetadataVecEnv(MissingMetadataVecEnv-v0, num_envs=1)) is missing AutoresetMode metadata, metadata={'render_fps': 1}"
+            ),
+        ):
+            gym.make_vec("MissingMetadataVecEnv-v0")
+
+        with pytest.warns(
+            UserWarning,
+            match=re.escape(
+                "The VectorEnv (IncorrectMetadataVecEnv(IncorrectMetadataVecEnv-v0, num_envs=1)) metadata['autoreset_mode'] is not an instance of AutoresetMode, <class 'str'>."
+            ),
+        ):
+            gym.make_vec("IncorrectMetadataVecEnv-v0")
+
+    gym.registry.pop("MissingMetadataVecEnv-v0")
+    gym.registry.pop("IncorrectMetadataVecEnv-v0")