Table of Contents

Class InvertedPendulumEnvV5

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

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

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

Remarks

Observation (float64): the cart's position, the pole's angle, then their velocities. The reward is Gymnasium's Python int (1 or 0), so the info's reward_survive is a long; the step's reward is its float64 value, as every Gym.NET reward. The reset's info is empty.

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

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

Constructors

InvertedPendulumEnvV5(InvertedPendulumEnvV5Options)

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

public InvertedPendulumEnvV5(InvertedPendulumEnvV5Options options)

Parameters

options InvertedPendulumEnvV5Options

The options.

Exceptions

ArgumentNullException

Thrown when options is null.

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

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

public InvertedPendulumEnvV5(RenderMode renderMode, string xmlFile = "inverted_pendulum.xml", int frameSkip = 2, IReadOnlyDictionary<string, object?>? defaultCameraConfig = null, double resetNoiseScale = 0.01, int width = 480, int height = 480, int? cameraId = null, string? cameraName = 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.

xmlFile string

The model: a bundled file name (xml_file, DR-63).

frameSkip int

Physics steps per env step (frame_skip).

defaultCameraConfig IReadOnlyDictionary<string, object>

The free camera's settings (default_camera_config); null is Gymnasium's default (tracking body 0 from 2.04 m), and an empty dictionary leaves MuJoCo's camera as it is.

resetNoiseScale double

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

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

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

NotSupportedException

xmlFile is not a bundled model.

OverflowError

A frame skip of 0 (Python's OverflowError deriving the frame rate).

ValueError

Both a camera id and a camera name.

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

Creates the env (Gymnasium's InvertedPendulumEnv.init): the model, its spaces and the frame rate the time step gives.

public InvertedPendulumEnvV5(string xmlFile = "inverted_pendulum.xml", int frameSkip = 2, IReadOnlyDictionary<string, object?>? defaultCameraConfig = null, double resetNoiseScale = 0.01, string? renderMode = null, int width = 480, int height = 480, int? cameraId = null, string? cameraName = null, int maxGeom = 1000, IReadOnlyDictionary<int, bool>? visualOptions = null, EnvViewerFactory? viewerFactory = null)

Parameters

xmlFile string

The model: a bundled file name (xml_file, DR-63).

frameSkip int

Physics steps per env step (frame_skip).

defaultCameraConfig IReadOnlyDictionary<string, object>

The free camera's settings (default_camera_config); null is Gymnasium's default (tracking body 0 from 2.04 m), and an empty dictionary leaves MuJoCo's camera as it is.

resetNoiseScale double

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

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

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

NotSupportedException

xmlFile is not a bundled model.

OverflowError

A frame skip of 0 (Python's OverflowError deriving the frame rate).

ValueError

Both a camera id and a camera name.

Properties

ClassMetadata

Gymnasium's class attribute metadata: the four render modes, the frame rate set per instance. A new dict on every read.

public static Metadata ClassMetadata { get; }

Property Value

Metadata

ObservationStructure

How the observation is laid out (observation_structure): the qpos and qvel counts.

public Info ObservationStructure { get; }

Property Value

Info

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

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 FrameSkip physics steps and reports the transition (step).

public override StepResult<NDArray> Step(NDArray action)

Parameters

action NDArray

The force on the cart, shape (1,), any real dtype (stored as float64).

Returns

StepResult<NDArray>

The observation, the reward 1 or 0, whether the pole fell, truncated=False and the info.

Exceptions

ArgumentNullException

action is null.

ValueError

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