diff --git a/docs/content/multi-goal_api.md b/docs/content/multi-goal_api.md index 1c396ac8..d4458dfa 100644 --- a/docs/content/multi-goal_api.md +++ b/docs/content/multi-goal_api.md @@ -21,6 +21,9 @@ goal, e.g. state derived from the simulation. ```python import gymnasium as gym +import gymnasium_robotics + +gym.register_envs(gymnasium_robotics) env = gym.make("FetchReach-v2") env.reset() diff --git a/docs/envs/franka_kitchen/index.md b/docs/envs/franka_kitchen/index.md index 7a20ab2c..7b54c5f5 100644 --- a/docs/envs/franka_kitchen/index.md +++ b/docs/envs/franka_kitchen/index.md @@ -16,6 +16,9 @@ The tasks can be selected when the environment is initialized passing a list of ```python import gymnasium as gym +import gymnasium_robotics + +gym.register_envs(gymnasium_robotics) env = gym.make('FrankaKitchen-v1', tasks_to_complete=['microwave', 'kettle']) ``` diff --git a/docs/envs/shadow_dexterous_hand/index.md b/docs/envs/shadow_dexterous_hand/index.md index c874e348..ae93485e 100644 --- a/docs/envs/shadow_dexterous_hand/index.md +++ b/docs/envs/shadow_dexterous_hand/index.md @@ -22,6 +22,9 @@ These environments are instanceated by adding the following strings to the Hand ```python import gymnasium as gym +import gymnasium_robotics + +gym.register_envs(gymnasium_robotics) env = gym.make('HandManipulateEgg_BooleanTouchSensors-v1') ``` diff --git a/docs/index.md b/docs/index.md index 6294ee8d..f40b7a63 100644 --- a/docs/index.md +++ b/docs/index.md @@ -52,6 +52,10 @@ The creation and interaction with the robotic environments follow the Gymnasium ```{code-block} python import gymnasium as gym +import gymnasium_robotics + +gym.register_envs(gymnasium_robotics) + env = gym.make("FetchPickAndPlace-v2", render_mode="human") observation, info = env.reset(seed=42) for _ in range(1000): diff --git a/gymnasium_robotics/__init__.py b/gymnasium_robotics/__init__.py index f0fcd4c7..2def092c 100644 --- a/gymnasium_robotics/__init__.py +++ b/gymnasium_robotics/__init__.py @@ -7,6 +7,8 @@ __version__ = "1.2.4" +__version__ = "1.2.4" + def register_robotics_envs(): """Register all environment ID's to Gymnasium.""" diff --git a/gymnasium_robotics/envs/adroit_hand/adroit_door.py b/gymnasium_robotics/envs/adroit_hand/adroit_door.py index 323222ab..e2d02caa 100644 --- a/gymnasium_robotics/envs/adroit_hand/adroit_door.py +++ b/gymnasium_robotics/envs/adroit_hand/adroit_door.py @@ -163,6 +163,9 @@ class AdroitHandDoorEnv(MujocoEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('AdroitHandDoor-v1', max_episode_steps=400) ``` diff --git a/gymnasium_robotics/envs/adroit_hand/adroit_hammer.py b/gymnasium_robotics/envs/adroit_hand/adroit_hammer.py index 8d4c6c0d..af68a408 100644 --- a/gymnasium_robotics/envs/adroit_hand/adroit_hammer.py +++ b/gymnasium_robotics/envs/adroit_hand/adroit_hammer.py @@ -172,6 +172,9 @@ class AdroitHandHammerEnv(MujocoEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('AdroitHandHammer-v1', max_episode_steps=400) ``` diff --git a/gymnasium_robotics/envs/adroit_hand/adroit_pen.py b/gymnasium_robotics/envs/adroit_hand/adroit_pen.py index 5e0f6517..37e4e2e6 100644 --- a/gymnasium_robotics/envs/adroit_hand/adroit_pen.py +++ b/gymnasium_robotics/envs/adroit_hand/adroit_pen.py @@ -165,6 +165,9 @@ class AdroitHandPenEnv(MujocoEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('AdroitHandPen-v1', max_episode_steps=400) ``` diff --git a/gymnasium_robotics/envs/adroit_hand/adroit_relocate.py b/gymnasium_robotics/envs/adroit_hand/adroit_relocate.py index 8cb41138..db9031cf 100644 --- a/gymnasium_robotics/envs/adroit_hand/adroit_relocate.py +++ b/gymnasium_robotics/envs/adroit_hand/adroit_relocate.py @@ -165,6 +165,9 @@ class AdroitHandRelocateEnv(MujocoEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('AdroitHandRelocate-v1', max_episode_steps=400) ``` diff --git a/gymnasium_robotics/envs/fetch/pick_and_place.py b/gymnasium_robotics/envs/fetch/pick_and_place.py index b6d0673c..74b5ed21 100644 --- a/gymnasium_robotics/envs/fetch/pick_and_place.py +++ b/gymnasium_robotics/envs/fetch/pick_and_place.py @@ -92,6 +92,9 @@ class MujocoFetchPickAndPlaceEnv(MujocoFetchEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('FetchPickAndPlaceDense-v2') ``` @@ -118,6 +121,9 @@ class MujocoFetchPickAndPlaceEnv(MujocoFetchEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('FetchPickAndPlace-v2', max_episode_steps=100) ``` diff --git a/gymnasium_robotics/envs/fetch/push.py b/gymnasium_robotics/envs/fetch/push.py index 57545ac9..10a87282 100644 --- a/gymnasium_robotics/envs/fetch/push.py +++ b/gymnasium_robotics/envs/fetch/push.py @@ -120,6 +120,9 @@ class MujocoFetchPushEnv(MujocoFetchEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('FetchPushDense-v2') ``` @@ -146,6 +149,9 @@ class MujocoFetchPushEnv(MujocoFetchEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('FetchPush-v2', max_episode_steps=100) ``` diff --git a/gymnasium_robotics/envs/fetch/reach.py b/gymnasium_robotics/envs/fetch/reach.py index 19e2b6cf..962fd74d 100644 --- a/gymnasium_robotics/envs/fetch/reach.py +++ b/gymnasium_robotics/envs/fetch/reach.py @@ -82,6 +82,9 @@ class MujocoFetchReachEnv(MujocoFetchEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('FetchReachDense-v2') ``` @@ -104,6 +107,9 @@ class MujocoFetchReachEnv(MujocoFetchEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('FetchReach-v2', max_episode_steps=100) ``` diff --git a/gymnasium_robotics/envs/fetch/slide.py b/gymnasium_robotics/envs/fetch/slide.py index bc0dbf4e..1381b4a5 100644 --- a/gymnasium_robotics/envs/fetch/slide.py +++ b/gymnasium_robotics/envs/fetch/slide.py @@ -120,6 +120,9 @@ class MujocoFetchSlideEnv(MujocoFetchEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('FetchSlideDense-v2') ``` @@ -145,6 +148,9 @@ class MujocoFetchSlideEnv(MujocoFetchEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('FetchSlide-v2', max_episode_steps=100) ``` diff --git a/gymnasium_robotics/envs/franka_kitchen/kitchen_env.py b/gymnasium_robotics/envs/franka_kitchen/kitchen_env.py index beba0af9..a8c0c3cc 100644 --- a/gymnasium_robotics/envs/franka_kitchen/kitchen_env.py +++ b/gymnasium_robotics/envs/franka_kitchen/kitchen_env.py @@ -64,6 +64,10 @@ class KitchenEnv(GoalEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) + env = gym.make('FrankaKitchen-v1', tasks_to_complete=['microwave', 'kettle']) ``` diff --git a/gymnasium_robotics/envs/maze/ant_maze.py b/gymnasium_robotics/envs/maze/ant_maze.py index b586e9e8..d1395e78 100644 --- a/gymnasium_robotics/envs/maze/ant_maze.py +++ b/gymnasium_robotics/envs/maze/ant_maze.py @@ -122,3 +122,11 @@ def render(self): def close(self): super().close() self.ant_env.close() + + @property + def model(self): + return self.ant_env.model + + @property + def data(self): + return self.ant_env.data diff --git a/gymnasium_robotics/envs/maze/ant_maze_v4.py b/gymnasium_robotics/envs/maze/ant_maze_v4.py index bf8ec0f2..edcf7f5e 100644 --- a/gymnasium_robotics/envs/maze/ant_maze_v4.py +++ b/gymnasium_robotics/envs/maze/ant_maze_v4.py @@ -65,6 +65,9 @@ class AntMazeEnv(MazeEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) example_map = [[1, 1, 1, 1, 1], [1, C, 0, C, 1], @@ -158,6 +161,9 @@ class AntMazeEnv(MazeEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('AntMaze_UMaze-v4') ``` @@ -192,6 +198,9 @@ class AntMazeEnv(MazeEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('AntMaze_UMaze-v4', max_episode_steps=100) ``` @@ -319,3 +328,11 @@ def render(self): def close(self): super().close() self.ant_env.close() + + @property + def model(self): + return self.ant_env.model + + @property + def data(self): + return self.ant_env.data diff --git a/gymnasium_robotics/envs/maze/point_maze.py b/gymnasium_robotics/envs/maze/point_maze.py index 33b263e7..e655f628 100644 --- a/gymnasium_robotics/envs/maze/point_maze.py +++ b/gymnasium_robotics/envs/maze/point_maze.py @@ -196,6 +196,9 @@ class PointMazeEnv(MazeEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) example_map = [[1, 1, 1, 1, 1], [1, C, 0, C, 1], @@ -253,6 +256,9 @@ class PointMazeEnv(MazeEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('PointMaze_UMazeDense-v3') ``` @@ -286,6 +292,9 @@ class PointMazeEnv(MazeEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('PointMaze_UMaze-v3', max_episode_steps=100) ``` @@ -415,3 +424,11 @@ def render(self): def close(self): super().close() self.point_env.close() + + @property + def model(self): + return self.point_env.model + + @property + def data(self): + return self.point_env.data diff --git a/gymnasium_robotics/envs/shadow_dexterous_hand/manipulate_block.py b/gymnasium_robotics/envs/shadow_dexterous_hand/manipulate_block.py index f0ffe70c..bd82c3d4 100644 --- a/gymnasium_robotics/envs/shadow_dexterous_hand/manipulate_block.py +++ b/gymnasium_robotics/envs/shadow_dexterous_hand/manipulate_block.py @@ -166,6 +166,9 @@ class MujocoHandBlockEnv(MujocoManipulateEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('HandManipulateBlock-v1') ``` @@ -193,6 +196,9 @@ class MujocoHandBlockEnv(MujocoManipulateEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('HandManipulateBlock-v1', max_episode_steps=100) ``` @@ -203,7 +209,6 @@ class MujocoHandBlockEnv(MujocoManipulateEnv, EzPickle): * v1: the environment depends on the newest [mujoco python bindings](https://mujoco.readthedocs.io/en/latest/python.html) maintained by the MuJoCo team in Deepmind. * v0: the environment depends on `mujoco_py` which is no longer maintained. - """ def __init__( diff --git a/gymnasium_robotics/envs/shadow_dexterous_hand/manipulate_egg.py b/gymnasium_robotics/envs/shadow_dexterous_hand/manipulate_egg.py index fab89d99..d0f6f0d8 100644 --- a/gymnasium_robotics/envs/shadow_dexterous_hand/manipulate_egg.py +++ b/gymnasium_robotics/envs/shadow_dexterous_hand/manipulate_egg.py @@ -169,6 +169,9 @@ class MujocoHandEggEnv(MujocoManipulateEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('HandManipulateEgg-v1') ``` @@ -196,6 +199,9 @@ class MujocoHandEggEnv(MujocoManipulateEnv, EzPickle): ``` import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('HandManipulateEgg-v1', max_episode_steps=100) ``` diff --git a/gymnasium_robotics/envs/shadow_dexterous_hand/manipulate_pen.py b/gymnasium_robotics/envs/shadow_dexterous_hand/manipulate_pen.py index 03682268..b9f9fb35 100644 --- a/gymnasium_robotics/envs/shadow_dexterous_hand/manipulate_pen.py +++ b/gymnasium_robotics/envs/shadow_dexterous_hand/manipulate_pen.py @@ -168,6 +168,9 @@ class MujocoHandPenEnv(MujocoManipulateEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('HandManipulatePen-v1') ``` @@ -195,6 +198,9 @@ class MujocoHandPenEnv(MujocoManipulateEnv, EzPickle): ```python import gymnasium as gym + import gymnasium_robotics + + gym.register_envs(gymnasium_robotics) env = gym.make('HandManipulatePen-v1', max_episode_steps=100) ``` @@ -205,7 +211,6 @@ class MujocoHandPenEnv(MujocoManipulateEnv, EzPickle): * v1: the environment depends on the newest [mujoco python bindings](https://mujoco.readthedocs.io/en/latest/python.html) maintained by the MuJoCo team in Deepmind. * v0: the environment depends on `mujoco_py` which is no longer maintained. - """ def __init__( diff --git a/tests/envs/franka_kitchen/test_kitchen_env.py b/tests/envs/franka_kitchen/test_kitchen_env.py index e6616cf6..4c3f92b4 100644 --- a/tests/envs/franka_kitchen/test_kitchen_env.py +++ b/tests/envs/franka_kitchen/test_kitchen_env.py @@ -47,7 +47,7 @@ def test_task_completion(remove_task_when_completed, terminate_on_tasks_complete # Complete a task sequentially for each environment step for task in TASKS: # Force task to be achieved - env.data.qpos[OBS_ELEMENT_INDICES[task]] = OBS_ELEMENT_GOALS[task] + env.unwrapped.data.qpos[OBS_ELEMENT_INDICES[task]] = OBS_ELEMENT_GOALS[task] _, _, terminated, _, info = env.step(env.action_space.sample()) completed_tasks.add(task) @@ -91,7 +91,7 @@ def test_task_completion(remove_task_when_completed, terminate_on_tasks_complete # Complete a task sequentially for each environment step for task in TASKS: # Force task to be achieved - env.data.qpos[OBS_ELEMENT_INDICES[task]] = OBS_ELEMENT_GOALS[task] + env.unwrapped.data.qpos[OBS_ELEMENT_INDICES[task]] = OBS_ELEMENT_GOALS[task] completed_tasks.add(task) _, _, terminated, _, info = env.step(env.action_space.sample()) diff --git a/tests/envs/hand/test_manipulate.py b/tests/envs/hand/test_manipulate.py index e1afe251..c27b3d5a 100644 --- a/tests/envs/hand/test_manipulate.py +++ b/tests/envs/hand/test_manipulate.py @@ -16,7 +16,7 @@ def test_serialize_deserialize(environment_id): env1.reset() env2 = pickle.loads(pickle.dumps(env1)) - assert env1.target_position == env2.target_position, ( + assert env1.unwrapped.target_position == env2.unwrapped.target_position, ( env1.target_position, env2.target_position, ) diff --git a/tests/envs/hand/test_manipulate_touch_sensors.py b/tests/envs/hand/test_manipulate_touch_sensors.py index 4cda849d..f741e3f4 100644 --- a/tests/envs/hand/test_manipulate_touch_sensors.py +++ b/tests/envs/hand/test_manipulate_touch_sensors.py @@ -16,7 +16,7 @@ def test_serialize_deserialize(environment_id): env1.reset() env2 = pickle.loads(pickle.dumps(env1)) - assert env1.target_position == env2.target_position, ( + assert env1.unwrapped.target_position == env2.unwrapped.target_position, ( env1.target_position, env2.target_position, ) diff --git a/tests/envs/hand/test_reach.py b/tests/envs/hand/test_reach.py index 6596aa12..7cf93665 100644 --- a/tests/envs/hand/test_reach.py +++ b/tests/envs/hand/test_reach.py @@ -8,7 +8,7 @@ def test_serialize_deserialize(): env1.reset() env2 = pickle.loads(pickle.dumps(env1)) - assert env1.distance_threshold == env2.distance_threshold, ( + assert env1.unwrapped.distance_threshold == env2.unwrapped.distance_threshold, ( env1.distance_threshold, env2.distance_threshold, ) diff --git a/tests/test_envs.py b/tests/test_envs.py index 6fc05928..472652c3 100644 --- a/tests/test_envs.py +++ b/tests/test_envs.py @@ -14,7 +14,7 @@ for message in [ "This version of the mujoco environments depends on the mujoco-py bindings, which are no longer maintained and may stop working. Please upgrade to the v4 versions of the environments (which depend on the mujoco python bindings instead), unless you are trying to precisely replicate previous works).", "A Box observation space minimum value is -infinity. This is probably too low.", - "A Box observation space maximum value is -infinity. This is probably too high.", + "A Box observation space maximum value is infinity. This is probably too high.", "For Box action spaces, we recommend using a symmetric and normalized space (range=[-1, 1] or [0, 1]). See https://stable-baselines3.readthedocs.io/en/master/guide/rl_tips.html for more information.", ] ]