ENH: allow metadata["render_modes"] to be a set (openai#248)

RetroAI · Jan 8, 2023 · 3413b04 · 3413b04
1 parent 8b37145
commit 3413b04
Show file tree

Hide file tree

Showing 57 changed files with 103 additions and 103 deletions.
diff --git a/docs/tutorials/environment_creation.py b/docs/tutorials/environment_creation.py
@@ -100,7 +100,7 @@
 
 
 class GridWorldEnv(gym.Env):
-    metadata = {"render_modes": ["human", "rgb_array"], "render_fps": 4}
+    metadata = {"render_modes": {"human", "rgb_array"}, "render_fps": 4}
 
     def __init__(self, render_mode=None, size=5):
         self.size = size  # The size of the square grid
@@ -130,7 +130,6 @@ def __init__(self, render_mode=None, size=5):
             3: np.array([0, -1]),
         }
 
-        assert render_mode is None or render_mode in self.metadata["render_modes"]
         self.render_mode = render_mode
 
         """

diff --git a/gymnasium/core.py b/gymnasium/core.py
@@ -47,7 +47,7 @@ class Env(Generic[ObsType, ActType]):
     """
 
     # Set this in SOME subclasses
-    metadata: dict[str, Any] = {"render_modes": []}
+    metadata: dict[str, Any] = {"render_modes": {}}
     # define render_mode if your environment supports rendering
     render_mode: str | None = None
     reward_range = (-float("inf"), float("inf"))

diff --git a/gymnasium/envs/box2d/bipedal_walker.py b/gymnasium/envs/box2d/bipedal_walker.py
@@ -166,7 +166,7 @@ class BipedalWalker(gym.Env, EzPickle):
     """
 
     metadata = {
-        "render_modes": ["human", "rgb_array"],
+        "render_modes": {"human", "rgb_array"},
         "render_fps": FPS,
     }
 

diff --git a/gymnasium/envs/box2d/car_racing.py b/gymnasium/envs/box2d/car_racing.py
@@ -193,11 +193,11 @@ class CarRacing(gym.Env, EzPickle):
     """
 
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "state_pixels",
-        ],
+        },
         "render_fps": FPS,
     }
 

diff --git a/gymnasium/envs/box2d/lunar_lander.py b/gymnasium/envs/box2d/lunar_lander.py
@@ -190,7 +190,7 @@ class LunarLander(gym.Env, EzPickle):
     """
 
     metadata = {
-        "render_modes": ["human", "rgb_array"],
+        "render_modes": {"human", "rgb_array"},
         "render_fps": FPS,
     }
 

diff --git a/gymnasium/envs/classic_control/acrobot.py b/gymnasium/envs/classic_control/acrobot.py
@@ -141,7 +141,7 @@ class AcrobotEnv(Env):
     """
 
     metadata = {
-        "render_modes": ["human", "rgb_array"],
+        "render_modes": {"human", "rgb_array"},
         "render_fps": 15,
     }
 

diff --git a/gymnasium/envs/classic_control/cartpole.py b/gymnasium/envs/classic_control/cartpole.py
@@ -82,7 +82,7 @@ class CartPoleEnv(gym.Env[np.ndarray, Union[int, np.ndarray]]):
     """
 
     metadata = {
-        "render_modes": ["human", "rgb_array"],
+        "render_modes": {"human", "rgb_array"},
         "render_fps": 50,
     }
 

diff --git a/gymnasium/envs/classic_control/continuous_mountain_car.py b/gymnasium/envs/classic_control/continuous_mountain_car.py
@@ -105,7 +105,7 @@ class Continuous_MountainCarEnv(gym.Env):
     """
 
     metadata = {
-        "render_modes": ["human", "rgb_array"],
+        "render_modes": {"human", "rgb_array"},
         "render_fps": 30,
     }
 

diff --git a/gymnasium/envs/classic_control/mountain_car.py b/gymnasium/envs/classic_control/mountain_car.py
@@ -97,7 +97,7 @@ class MountainCarEnv(gym.Env):
     """
 
     metadata = {
-        "render_modes": ["human", "rgb_array"],
+        "render_modes": {"human", "rgb_array"},
         "render_fps": 30,
     }
 

diff --git a/gymnasium/envs/classic_control/pendulum.py b/gymnasium/envs/classic_control/pendulum.py
@@ -93,7 +93,7 @@ class PendulumEnv(gym.Env):
     """
 
     metadata = {
-        "render_modes": ["human", "rgb_array"],
+        "render_modes": {"human", "rgb_array"},
         "render_fps": 30,
     }
 

diff --git a/gymnasium/envs/mujoco/ant.py b/gymnasium/envs/mujoco/ant.py
@@ -7,11 +7,11 @@
 
 class AntEnv(MuJocoPyEnv, utils.EzPickle):
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 20,
     }
 

diff --git a/gymnasium/envs/mujoco/ant_v3.py b/gymnasium/envs/mujoco/ant_v3.py
@@ -12,11 +12,11 @@
 
 class AntEnv(MuJocoPyEnv, utils.EzPickle):
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 20,
     }
 

diff --git a/gymnasium/envs/mujoco/ant_v4.py b/gymnasium/envs/mujoco/ant_v4.py
@@ -182,11 +182,11 @@ class AntEnv(MujocoEnv, utils.EzPickle):
     """
 
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 20,
     }
 

diff --git a/gymnasium/envs/mujoco/half_cheetah.py b/gymnasium/envs/mujoco/half_cheetah.py
@@ -7,11 +7,11 @@
 
 class HalfCheetahEnv(MuJocoPyEnv, utils.EzPickle):
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 20,
     }
 

diff --git a/gymnasium/envs/mujoco/half_cheetah_v3.py b/gymnasium/envs/mujoco/half_cheetah_v3.py
@@ -14,11 +14,11 @@
 
 class HalfCheetahEnv(MuJocoPyEnv, utils.EzPickle):
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 20,
     }
 

diff --git a/gymnasium/envs/mujoco/half_cheetah_v4.py b/gymnasium/envs/mujoco/half_cheetah_v4.py
@@ -136,11 +136,11 @@ class HalfCheetahEnv(MujocoEnv, utils.EzPickle):
     """
 
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 20,
     }
 

diff --git a/gymnasium/envs/mujoco/hopper.py b/gymnasium/envs/mujoco/hopper.py
@@ -7,11 +7,11 @@
 
 class HopperEnv(MuJocoPyEnv, utils.EzPickle):
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 125,
     }
 

diff --git a/gymnasium/envs/mujoco/hopper_v3.py b/gymnasium/envs/mujoco/hopper_v3.py
@@ -17,11 +17,11 @@
 
 class HopperEnv(MuJocoPyEnv, utils.EzPickle):
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 125,
     }
 

diff --git a/gymnasium/envs/mujoco/hopper_v4.py b/gymnasium/envs/mujoco/hopper_v4.py
@@ -142,11 +142,11 @@ class HopperEnv(MujocoEnv, utils.EzPickle):
     """
 
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 125,
     }
 

diff --git a/gymnasium/envs/mujoco/humanoid.py b/gymnasium/envs/mujoco/humanoid.py
@@ -13,11 +13,11 @@ def mass_center(model, sim):
 
 class HumanoidEnv(MuJocoPyEnv, utils.EzPickle):
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 67,
     }
 

diff --git a/gymnasium/envs/mujoco/humanoid_v3.py b/gymnasium/envs/mujoco/humanoid_v3.py
@@ -21,11 +21,11 @@ def mass_center(model, sim):
 
 class HumanoidEnv(MuJocoPyEnv, utils.EzPickle):
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 67,
     }
 

diff --git a/gymnasium/envs/mujoco/humanoid_v4.py b/gymnasium/envs/mujoco/humanoid_v4.py
@@ -216,11 +216,11 @@ class HumanoidEnv(MujocoEnv, utils.EzPickle):
     """
 
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 67,
     }
 

diff --git a/gymnasium/envs/mujoco/humanoidstandup.py b/gymnasium/envs/mujoco/humanoidstandup.py
@@ -7,11 +7,11 @@
 
 class HumanoidStandupEnv(MuJocoPyEnv, utils.EzPickle):
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 67,
     }
 

diff --git a/gymnasium/envs/mujoco/humanoidstandup_v4.py b/gymnasium/envs/mujoco/humanoidstandup_v4.py
@@ -192,11 +192,11 @@ class HumanoidStandupEnv(MujocoEnv, utils.EzPickle):
     """
 
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 67,
     }
 

diff --git a/gymnasium/envs/mujoco/inverted_double_pendulum.py b/gymnasium/envs/mujoco/inverted_double_pendulum.py
@@ -7,11 +7,11 @@
 
 class InvertedDoublePendulumEnv(MuJocoPyEnv, utils.EzPickle):
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 20,
     }
 

diff --git a/gymnasium/envs/mujoco/inverted_double_pendulum_v4.py b/gymnasium/envs/mujoco/inverted_double_pendulum_v4.py
@@ -125,11 +125,11 @@ class InvertedDoublePendulumEnv(MujocoEnv, utils.EzPickle):
     """
 
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 20,
     }
 

diff --git a/gymnasium/envs/mujoco/inverted_pendulum.py b/gymnasium/envs/mujoco/inverted_pendulum.py
@@ -7,11 +7,11 @@
 
 class InvertedPendulumEnv(MuJocoPyEnv, utils.EzPickle):
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 25,
     }
 

diff --git a/gymnasium/envs/mujoco/inverted_pendulum_v4.py b/gymnasium/envs/mujoco/inverted_pendulum_v4.py
@@ -94,11 +94,11 @@ class InvertedPendulumEnv(MujocoEnv, utils.EzPickle):
     """
 
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 25,
     }
 

diff --git a/gymnasium/envs/mujoco/mujoco_env.py b/gymnasium/envs/mujoco/mujoco_env.py
@@ -56,11 +56,11 @@ def __init__(
 
         self.frame_skip = frame_skip
 
-        assert self.metadata["render_modes"] == [
+        assert self.metadata["render_modes"] == {
             "human",
             "rgb_array",
             "depth_array",
-        ], self.metadata["render_modes"]
+        }, self.metadata["render_modes"]
         assert (
             int(np.round(1.0 / self.dt)) == self.metadata["render_fps"]
         ), f'Expected value: {int(np.round(1.0 / self.dt))}, Actual value: {self.metadata["render_fps"]}'

diff --git a/gymnasium/envs/mujoco/pusher.py b/gymnasium/envs/mujoco/pusher.py
@@ -7,11 +7,11 @@
 
 class PusherEnv(MuJocoPyEnv, utils.EzPickle):
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 20,
     }
 

diff --git a/gymnasium/envs/mujoco/pusher_v4.py b/gymnasium/envs/mujoco/pusher_v4.py
@@ -140,11 +140,11 @@ class PusherEnv(MujocoEnv, utils.EzPickle):
     """
 
     metadata = {
-        "render_modes": [
+        "render_modes": {
             "human",
             "rgb_array",
             "depth_array",
-        ],
+        },
         "render_fps": 20,
     }