Table of Contents

Class SwimmerEnvV4

Namespace
Gym.Environments.Envs.MuJoCo
Assembly
Gym.Environments.dll

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).

[PyName("SwimmerEnv")]
public class SwimmerEnvV4 : MujocoEnv, IEnv, IDisposable, IDynamicAttributes
Inheritance
SwimmerEnvV4
Implements
Inherited Members
Extension Methods

Remarks

The observation space is 8 (10 with the root's x and y) float64 values. Unlike the other v4 envs it takes a default_camera_config, as Gymnasium's passes its keyword arguments on. make warns that the id is out of date.

Not thread-safe. Reference: gymnasium/envs/mujoco/swimmer_v4.py.

Its info reads typed (DR-91): SwimmerInfoV4 info = step.Info; (SwimmerInfoV4), with the dict's own values still behind the indexer.

Constructors

SwimmerEnvV4(SwimmerEnvV4Options)

Builds the instance from its options record: the properties set, the constructor's defaults for the rest.

public SwimmerEnvV4(SwimmerEnvV4Options options)

Parameters

options SwimmerEnvV4Options

The options.

Exceptions

ArgumentNullException

Thrown when options is null.

SwimmerEnvV4(RenderMode, double, double, double, bool, int, int, int?, string?, IReadOnlyDictionary<string, object?>?, int, IReadOnlyDictionary<int, bool>?, EnvViewerFactory?)

Builds the env with the render mode given as the RenderMode enum (DR-84, DR-93), as SwimmerEnvV4(double, double, double, bool, string?, int, int, int?, string?, IReadOnlyDictionary<string, object?>?, int, IReadOnlyDictionary<int, bool>?, EnvViewerFactory?) builds it from the mode's string: new SwimmerEnvV4(RenderMode.RgbArray) builds what new SwimmerEnvV4(renderMode: "rgb_array") builds, the member reaching the env as Gymnasium's string (Name(RenderMode)), which its RenderMode property then holds.

public SwimmerEnvV4(RenderMode renderMode, double forwardRewardWeight = 1, double ctrlCostWeight = 0.0001, double resetNoiseScale = 0.1, bool excludeCurrentPositionsFromObservation = true, int width = 480, int height = 480, int? cameraId = null, string? cameraName = null, IReadOnlyDictionary<string, object?>? defaultCameraConfig = null, int maxGeom = 1000, IReadOnlyDictionary<int, bool>? visualOptions = null, EnvViewerFactory? viewerFactory = null)

Parameters

renderMode RenderMode

The render mode, which the env must list in its metadata["render_modes"] as for the string; it behaves exactly as its Gymnasium string does in the other constructor.

forwardRewardWeight double

The weight of the forward velocity (forward_reward_weight).

ctrlCostWeight double

The weight of the squared torques (ctrl_cost_weight).

resetNoiseScale double

The scale of the reset's noise (reset_noise_scale).

excludeCurrentPositionsFromObservation bool

Whether the root's x and y leave the observation (exclude_current_positions_from_observation).

width int

The rendered frame's width (width).

height int

The rendered frame's height (height).

cameraId int?

The camera to render from (camera_id).

cameraName string

The camera to render from by name (camera_name).

defaultCameraConfig IReadOnlyDictionary<string, object>

The free camera's settings (default_camera_config); none by default.

maxGeom int

The most geoms a frame draws (max_geom).

visualOptions IReadOnlyDictionary<int, bool>

MuJoCo visual flags to switch (visual_options).

viewerFactory EnvViewerFactory

Gym.NET's viewer_factory (DR-20) for human mode.

Remarks

The mode is required and comes first, so new SwimmerEnvV4() keeps meaning the other constructor, without a mode; leave the mode out there for no rendering. Every other parameter means what it means there.

Exceptions

ArgumentOutOfRangeException

Thrown for a value RenderMode does not declare (a cast integer such as (RenderMode)99).

ValueError

Both a camera id and a camera name.

SwimmerEnvV4(double, double, double, bool, string?, int, int, int?, string?, IReadOnlyDictionary<string, object?>?, int, IReadOnlyDictionary<int, bool>?, EnvViewerFactory?)

Creates the env (Gymnasium's SwimmerEnv.init): swimmer.xml with a frame skip of 4.

public SwimmerEnvV4(double forwardRewardWeight = 1, double ctrlCostWeight = 0.0001, double resetNoiseScale = 0.1, bool excludeCurrentPositionsFromObservation = true, string? renderMode = null, int width = 480, int height = 480, int? cameraId = null, string? cameraName = null, IReadOnlyDictionary<string, object?>? defaultCameraConfig = null, int maxGeom = 1000, IReadOnlyDictionary<int, bool>? visualOptions = null, EnvViewerFactory? viewerFactory = null)

Parameters

forwardRewardWeight double

The weight of the forward velocity (forward_reward_weight).

ctrlCostWeight double

The weight of the squared torques (ctrl_cost_weight).

resetNoiseScale double

The scale of the reset's noise (reset_noise_scale).

excludeCurrentPositionsFromObservation bool

Whether the root's x and y leave the observation (exclude_current_positions_from_observation).

renderMode string

Gymnasium's render_mode: human, rgb_array, depth_array, rgbd_tuple or null.

width int

The rendered frame's width (width).

height int

The rendered frame's height (height).

cameraId int?

The camera to render from (camera_id).

cameraName string

The camera to render from by name (camera_name).

defaultCameraConfig IReadOnlyDictionary<string, object>

The free camera's settings (default_camera_config); none by default.

maxGeom int

The most geoms a frame draws (max_geom).

visualOptions IReadOnlyDictionary<int, bool>

MuJoCo visual flags to switch (visual_options).

viewerFactory EnvViewerFactory

Gym.NET's viewer_factory (DR-20) for human mode.

Exceptions

ValueError

Both a camera id and a camera name.

Properties

ClassMetadata

Gymnasium's class attribute metadata: the four render modes at 25 frames per second. A new dict on every read.

public static Metadata ClassMetadata { get; }

Property Value

Metadata

CtrlCostWeight

The weight of the squared torques (_ctrl_cost_weight), read every step.

[PyName("_ctrl_cost_weight")]
public double CtrlCostWeight { get; set; }

Property Value

double

ExcludeCurrentPositionsFromObservation

Whether the root's x and y leave the observation (_exclude_current_positions_from_observation). Footgun: changing it after construction changes the observation's length but not the observation space, as in Gymnasium.

[PyName("_exclude_current_positions_from_observation")]
public bool ExcludeCurrentPositionsFromObservation { get; set; }

Property Value

bool

ForwardRewardWeight

The weight of the forward velocity (_forward_reward_weight), read every step.

[PyName("_forward_reward_weight")]
public double ForwardRewardWeight { get; set; }

Property Value

double

ResetNoiseScale

The scale of the reset's noise (_reset_noise_scale), read every reset.

[PyName("_reset_noise_scale")]
public double ResetNoiseScale { get; set; }

Property Value

double

Methods

ControlCost(NDArray)

The control cost of action (control_cost): ctrl_cost_weight * sum(action**2), computed in the action's dtype and returned widened exactly.

[PyName("control_cost")]
public double ControlCost(NDArray action)

Parameters

action NDArray

The action.

Returns

double

The cost.

Exceptions

ArgumentNullException

action is null.

NotSupportedException

An action of a dtype whose cost NumPy keeps in that dtype (float16, complex).

ResetModel()

The episode's start (reset_model): positions init_qpos + uniform(-scale, scale, nq), then velocities init_qvel + uniform(-scale, scale, nv), drawn in that order.

protected override NDArray ResetModel()

Returns

NDArray

The first observation.

Step(NDArray)

Applies action for 4 physics steps and reports the transition (step).

public override StepResult<NDArray> Step(NDArray action)

Parameters

action NDArray

The 2 torques, float32 (the action space's samples) or any real dtype.

Returns

StepResult<NDArray>

The observation, the float64 reward, terminated=False, truncated=False and the info.

Exceptions

ArgumentNullException

action is null.

ValueError

The action is not of shape (2,), with Gymnasium's message.

NotSupportedException

An action of a dtype whose cost NumPy keeps in that dtype (float16, complex).