Table of Contents

Namespace Gym.Environments.Envs.MuJoCo

Classes

AntEnvV4

Ant-v4: the four-legged ant of AntEnvV5 with v4's frame skip, the torso's velocity as the forward reward (unweighted), v4's healthy reward (paid on every step while terminate_when_unhealthy is set), no contact forces unless use_contact_forces=True, and an empty reset info. Byte for byte what Gymnasium's Ant-v4 computes on MuJoCo 4.0.0 (DR-61, DR-64).

AntEnvV4Options

The keyword arguments of AntEnvV4's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

AntEnvV5

Ant-v5: a four-legged ant (a torso and four two-link legs on a free joint) driven by 8 hip and ankle torques in [-1, 1]. The reward pays the main body's forward velocity and staying healthy, and charges the squared torques and the clipped contact forces; a non-finite state or a torso height outside [0.2, 1.0] ends the episode. Byte for byte what Gymnasium's Ant-v5 computes on MuJoCo 4.0.0 (DR-61, DR-64).

AntEnvV5Options

The keyword arguments of AntEnvV5's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

AntInfoV4

Ant-v4's info (AntEnvV4), typed (DR-91): a step's nine keys; a v4 reset sends {}, so every member is nullable.

AntInfoV5

Ant-v5's info (AntEnvV5), typed (DR-91): a reset sends the first three keys, a step all nine.

HalfCheetahEnvV4

HalfCheetah-v4: the planar cheetah of HalfCheetahEnvV5 with v4's fixed model and frame skip, the same dynamics and reward, an info of x_position, x_velocity, reward_run and reward_ctrl, and an empty reset info. Byte for byte what Gymnasium's HalfCheetah-v4 computes on MuJoCo 4.0.0 (DR-61, DR-64).

HalfCheetahEnvV4Options

The keyword arguments of HalfCheetahEnvV4's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

HalfCheetahEnvV5

HalfCheetah-v5: a planar cheetah (a torso and two legs of thigh, shin and foot) driven by 6 joint torques in [-1, 1]. The reward pays the forward velocity and charges the squared torques; the episode never ends on its own (make's 1000-step limit truncates it). Byte for byte what Gymnasium's HalfCheetah-v5 computes on MuJoCo 4.0.0 (DR-61, DR-64): observations, rewards, infos and the generator's draws.

HalfCheetahEnvV5Options

The keyword arguments of HalfCheetahEnvV5's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

HalfCheetahInfoV4

HalfCheetah-v4's info (HalfCheetahEnvV4), typed (DR-91): a step's four keys; a v4 reset sends {}.

HalfCheetahInfoV5

HalfCheetah-v5's info (HalfCheetahEnvV5), typed (DR-91): a reset sends x_position, a step all four keys.

HopperEnvV4

Hopper-v4: the one-legged hopper of HopperEnvV5 with v4's fixed model and frame skip, an info of x_position and x_velocity only, and v4's healthy reward, paid on every step while terminate_when_unhealthy is set. Byte for byte what Gymnasium's Hopper-v4 computes on MuJoCo 4.0.0 (DR-61, DR-64).

HopperEnvV4Options

The keyword arguments of HopperEnvV4's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

HopperEnvV5

Hopper-v5: a planar one-legged hopper (torso, thigh, leg, foot) driven by 3 joint torques in [-1, 1]. The reward pays the forward velocity and staying healthy, and charges the squared torques; an unhealthy state (too low, too tilted, or any coordinate beyond ±100) ends the episode. Byte for byte what Gymnasium's Hopper-v5 computes on MuJoCo 4.0.0 (DR-61, DR-64).

HopperEnvV5Options

The keyword arguments of HopperEnvV5's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

HopperInfoV4

Hopper-v4's info (HopperEnvV4), typed (DR-91): a step's two keys; a v4 reset sends {}.

HopperInfoV5

Hopper-v5's info (HopperEnvV5), typed (DR-91): a reset sends the first two keys, a step all six.

HumanoidEnvV4

Humanoid-v4: the humanoid of HumanoidEnvV5 with v4's fixed model and frame skip, every body's rows observed (the world's included), no contact cost, v4's healthy reward (paid on every step while terminate_when_unhealthy is set) and the center of mass in the info. Byte for byte what Gymnasium's Humanoid-v4 computes on MuJoCo 4.0.0 (DR-61, DR-64).

HumanoidEnvV4Options

The keyword arguments of HumanoidEnvV4's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

HumanoidEnvV5

Humanoid-v5: a 3D humanoid (torso, abdomen, legs and arms on a free joint) driven by 17 joint torques in [-0.4, 0.4]. The reward pays the center of mass's forward velocity and staying healthy, and charges the squared controls and the external contact forces; a torso height outside (1, 2) ends the episode. Byte for byte what Gymnasium's Humanoid-v5 computes on MuJoCo 4.0.0 (DR-61, DR-64).

HumanoidEnvV5Options

The keyword arguments of HumanoidEnvV5's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

HumanoidInfoV4

Humanoid-v4's info (HumanoidEnvV4), typed (DR-91): a step's nine keys; a v4 reset sends {}.

HumanoidInfoV5

Humanoid-v5's info (HumanoidEnvV5), typed (DR-91): a reset sends the first five keys, a step all eleven.

HumanoidStandupEnvV4

HumanoidStandup-v4: the lying humanoid of HumanoidStandupEnvV5 with v4's fixed model, frame skip and weights, every body's rows observed (the world's included) and v4's three-entry info. Byte for byte what Gymnasium's HumanoidStandup-v4 computes on MuJoCo 4.0.0 (DR-61, DR-64).

HumanoidStandupEnvV4Options

The keyword arguments of HumanoidStandupEnvV4's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

HumanoidStandupEnvV5

HumanoidStandup-v5: the humanoid lying on the ground, rewarded for raising its torso. The reward pays the torso's height over the time step plus 1, and charges the squared controls and the external contact forces; the episode never ends on its own (make's 1000-step limit truncates it). Byte for byte what Gymnasium's HumanoidStandup-v5 computes on MuJoCo 4.0.0 (DR-61, DR-64).

HumanoidStandupEnvV5Options

The keyword arguments of HumanoidStandupEnvV5's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

HumanoidStandupInfoV4

HumanoidStandup-v4's info (HumanoidStandupEnvV4), typed (DR-91): a step's three keys; a v4 reset sends {}.

HumanoidStandupInfoV5

HumanoidStandup-v5's info (HumanoidStandupEnvV5), typed (DR-91): a reset sends the first five keys, a step all eight.

InvertedDoublePendulumEnvV4

InvertedDoublePendulum-v4: the double pendulum of InvertedDoublePendulumEnvV5 with v4's fixed model, frame skip and noise, an alive bonus of 10 on every step (the falling one included), every constraint force in the observation and an empty info. Byte for byte what Gymnasium's InvertedDoublePendulum-v4 computes on MuJoCo 4.0.0 (DR-61, DR-64).

InvertedDoublePendulumEnvV4Options

The keyword arguments of InvertedDoublePendulumEnvV4's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

InvertedDoublePendulumEnvV5

InvertedDoublePendulum-v5: two poles chained on a cart, kept upright by a force on the cart in [-1, 1]. Each step pays the healthy reward while the tip stays above 1 m and charges its distance from the top position and the poles' angular velocities; the tip falling to 1 m ends the episode. Byte for byte what Gymnasium's InvertedDoublePendulum-v5 computes on MuJoCo 4.0.0 (DR-61, DR-64).

InvertedDoublePendulumEnvV5Options

The keyword arguments of InvertedDoublePendulumEnvV5's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

InvertedDoublePendulumInfoV5

InvertedDoublePendulum-v5's info (InvertedDoublePendulumEnvV5), typed (DR-91): a step's three keys; a reset sends {}.

InvertedPendulumEnvV4

InvertedPendulum-v4: the cart and pole of InvertedPendulumEnvV5 with v4's fixed model, frame skip and noise, a reward of 1.0 on every step (the step the pole falls included) and an empty info. Byte for byte what Gymnasium's InvertedPendulum-v4 computes on MuJoCo 4.0.0 (DR-61, DR-64).

InvertedPendulumEnvV4Options

The keyword arguments of InvertedPendulumEnvV4's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

InvertedPendulumEnvV5

InvertedPendulum-v5: a pole hinged on a cart that slides on a rail, kept upright by a force on the cart in [-3, 3]. Each step pays 1 while the pole stays within 0.2 rad of upright and 0 on the step it falls, which ends the episode (as does a non-finite state). Byte for byte what Gymnasium's InvertedPendulum-v5 computes on MuJoCo 4.0.0 (DR-61, DR-64).

InvertedPendulumEnvV5Options

The keyword arguments of InvertedPendulumEnvV5's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

InvertedPendulumInfoV5

InvertedPendulum-v5's info (InvertedPendulumEnvV5), typed (DR-91): a step's one key; a reset sends {}.

MujocoEnv

The base of Gymnasium's MuJoCo envs (MujocoEnv): one embedded model (DR-63) and its simulation, stepped by Gym.NET's own engine bit for bit as MuJoCo 4.0.0 steps it on win-x64 (DR-61, DR-64); the action space from the actuators' control ranges; SetState(NDArray, NDArray), DoSimulation(NDArray, int), StateVector() and GetBodyCom(string) for the envs; the reset that clears the data and lets the env draw its start.

MujocoInfo

The base of the MuJoCo envs' typed info records (DR-91, DR-95), as MujocoEnv is the base of the envs: each env class has its record (HalfCheetahInfoV5 info = step.Info; for HalfCheetahEnvV5). It holds no member of its own, since no key is common to every MuJoCo env.

MujocoRenderer

Draws a MuJoCo env's frames (MujocoRenderer): the camera resolved as Gymnasium resolves it (a named camera, an id, or the free camera with the env's default configuration), and the render modes rgb_array, depth_array, rgbd_tuple and human. Gym.NET draws the scene itself (DR-62); its frames are compared with Gymnasium's and the differences measured, not required equal (DR-67).

MujocoUtils

Gymnasium's MuJoCo utilities (gymnasium.envs.mujoco.utils), mainly for tests: a MuJoCo env's whole state as one vector, restoring it, and the check that a seeded reset is deterministic. They reach the simulation through the env's unwrapped MujocoEnv, so any wrapper stack works.

PusherEnvV4

Pusher-v4: refuses to be built, with Gymnasium's ImportError. Gymnasium supports this version only on MuJoCo below 3 (Gymnasium issue #950), so on MuJoCo 3 and later its constructor raises before anything else, and Gym.NET's engine follows MuJoCo 4.0.0 (DR-64). Pusher-v5 is the pusher to use.

PusherEnvV4Options

The keyword arguments of PusherEnvV4's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

PusherEnvV5

Pusher-v5: a 7-joint arm that pushes a cylinder to a goal on a table, driven by 7 joint torques in [-2, 2]. The reward charges the cylinder's distance to the goal, half the fingertip's distance to the cylinder and the squared torques; the episode never ends on its own (make's 100-step limit truncates it). Byte for byte what Gymnasium's Pusher-v5 computes on MuJoCo 4.0.0 (DR-61, DR-64).

PusherEnvV5Options

The keyword arguments of PusherEnvV5's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

PusherInfoV5

Pusher-v5's info (PusherEnvV5), typed (DR-91): a step's three keys; a reset sends {}.

ReacherEnvV4

Reacher-v4: the two-joint arm of ReacherEnvV5 with v4's fixed model and frame skip, a reward measured before the step (the distance and the action's cost as they stand when the action arrives), unweighted, and the fingertip's full 3D offset in the observation. Byte for byte what Gymnasium's Reacher-v4 computes on MuJoCo 4.0.0 (DR-61, DR-64).

ReacherEnvV4Options

The keyword arguments of ReacherEnvV4's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

ReacherEnvV5

Reacher-v5: a two-joint planar arm that reaches for a random target, driven by 2 joint torques in [-1, 1]. The reward charges the fingertip's distance to the target and the squared torques; the episode never ends on its own (make's 50-step limit truncates it). Byte for byte what Gymnasium's Reacher-v5 computes on MuJoCo 4.0.0 (DR-61, DR-64).

ReacherEnvV5Options

The keyword arguments of ReacherEnvV5's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

ReacherInfoV4

Reacher-v4's info (ReacherEnvV4), typed (DR-91): a step's two keys; a v4 reset sends {}.

ReacherInfoV5

Reacher-v5's info (ReacherEnvV5), typed (DR-91): a step's two keys; a reset sends {}.

SwimmerEnvV4

Swimmer-v4: the three-link swimmer of SwimmerEnvV5 with v4's fixed model and frame skip, the same dynamics and reward, v4's info (reward_fwd, reward_ctrl, x_position, y_position, distance_from_origin, x_velocity, y_velocity, forward_reward) and an empty reset info. Byte for byte what Gymnasium's Swimmer-v4 computes on MuJoCo 4.0.0 (DR-61, DR-64).

SwimmerEnvV4Options

The keyword arguments of SwimmerEnvV4's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

SwimmerEnvV5

Swimmer-v5: a three-link swimmer in a viscous fluid, driven by 2 joint torques in [-1, 1]. The reward pays the forward velocity and charges the squared torques; the episode never ends on its own (make's 1000-step limit truncates it). Byte for byte what Gymnasium's Swimmer-v5 computes on MuJoCo 4.0.0 (DR-61, DR-64).

SwimmerEnvV5Options

The keyword arguments of SwimmerEnvV5's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

SwimmerInfoV4

Swimmer-v4's info (SwimmerEnvV4), typed (DR-91): a step's eight keys; a v4 reset sends {}.

SwimmerInfoV5

Swimmer-v5's info (SwimmerEnvV5), typed (DR-91): a reset sends the first three keys, a step all seven.

Walker2dEnvV4

Walker2d-v4: the two-legged walker of Walker2dEnvV5 on v4's model (walker2d.xml, whose feet differ in friction) with a frame skip of 4, an info of x_position and x_velocity only, and v4's healthy reward, paid on every step while terminate_when_unhealthy is set. Byte for byte what Gymnasium's Walker2d-v4 computes on MuJoCo 4.0.0 (DR-61, DR-64).

Walker2dEnvV4Options

The keyword arguments of Walker2dEnvV4's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

Walker2dEnvV5

Walker2d-v5: a planar two-legged walker (torso, and per leg a thigh, leg and foot) driven by 6 joint torques in [-1, 1]. The reward pays the forward velocity and staying healthy, and charges the squared torques; a torso outside the healthy height or angle ends the episode. Byte for byte what Gymnasium's Walker2d-v5 computes on MuJoCo 4.0.0 (DR-61, DR-64).

Walker2dEnvV5Options

The keyword arguments of Walker2dEnvV5's constructor as a typed record (DR-34), generated from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.

Walker2dInfoV4

Walker2d-v4's info (Walker2dEnvV4), typed (DR-91): a step's two keys; a v4 reset sends {}.

Walker2dInfoV5

Walker2d-v5's info (Walker2dEnvV5), typed (DR-91): a reset sends the first two keys, a step all six.