Table of Contents

Class SwimmerEnvV5Options

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

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.

public sealed record SwimmerEnvV5Options : IGymOptions, IEquatable<SwimmerEnvV5Options>
Inheritance
SwimmerEnvV5Options
Implements
Inherited Members
Extension Methods

Properties

CameraId

The camera to render from (camera_id). The camera_id keyword argument, passed on only once set.

public int? CameraId { get; init; }

Property Value

int?

CameraName

The camera to render from by name (camera_name). The camera_name keyword argument, passed on only once set.

public string? CameraName { get; init; }

Property Value

string

CtrlCostWeight

The weight of the squared torques (ctrl_cost_weight). The ctrl_cost_weight keyword argument, passed on only once set.

public double CtrlCostWeight { get; init; }

Property Value

double

DefaultCameraConfig

The free camera's settings (default_camera_config); none by default. The default_camera_config keyword argument, passed on only once set.

public IReadOnlyDictionary<string, object?>? DefaultCameraConfig { get; init; }

Property Value

IReadOnlyDictionary<string, object>

ExcludeCurrentPositionsFromObservation

Whether the root's x and y leave the observation (exclude_current_positions_from_observation). The exclude_current_positions_from_observation keyword argument, passed on only once set.

public bool ExcludeCurrentPositionsFromObservation { get; init; }

Property Value

bool

ForwardRewardWeight

The weight of the forward velocity (forward_reward_weight). The forward_reward_weight keyword argument, passed on only once set.

public double ForwardRewardWeight { get; init; }

Property Value

double

FrameSkip

Physics steps per env step (frame_skip). The frame_skip keyword argument, passed on only once set.

public int FrameSkip { get; init; }

Property Value

int

Height

The rendered frame's height (height). The height keyword argument, passed on only once set.

public int Height { get; init; }

Property Value

int

MaxGeom

The most geoms a frame draws (max_geom). The max_geom keyword argument, passed on only once set.

public int MaxGeom { get; init; }

Property Value

int

RenderMode

Gymnasium's render_mode: human, rgb_array, depth_array, rgbd_tuple or null. The render_mode keyword argument, passed on only once set.

public string? RenderMode { get; init; }

Property Value

string

ResetNoiseScale

The scale of the reset's noise (reset_noise_scale). The reset_noise_scale keyword argument, passed on only once set.

public double ResetNoiseScale { get; init; }

Property Value

double

ViewerFactory

Gym.NET's viewer_factory (DR-20) for human mode. The viewer_factory keyword argument, passed on only once set.

public EnvViewerFactory? ViewerFactory { get; init; }

Property Value

EnvViewerFactory

VisualOptions

MuJoCo visual flags to switch (visual_options). The visual_options keyword argument, passed on only once set.

public IReadOnlyDictionary<int, bool>? VisualOptions { get; init; }

Property Value

IReadOnlyDictionary<int, bool>

Width

The rendered frame's width (width). The width keyword argument, passed on only once set.

public int Width { get; init; }

Property Value

int

XmlFile

The model: a bundled file name (xml_file, DR-63). The xml_file keyword argument, passed on only once set.

public string XmlFile { get; init; }

Property Value

string

Methods

ToKwargs()

The set properties as keyword arguments by Python name, in constructor order.

public Info ToKwargs()

Returns

Info

A new dict the caller owns.