Table of Contents

Class CartPoleVectorEnvOptions

Namespace
Gym.Environments.Envs.Classic
Assembly
Gym.Environments.dll

The keyword arguments of CartPoleVectorEnv'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 CartPoleVectorEnvOptions : IGymOptions, IEquatable<CartPoleVectorEnvOptions>
Inheritance
CartPoleVectorEnvOptions
Implements
Inherited Members
Extension Methods

Properties

MaxEpisodeSteps

Gymnasium's max_episode_steps: the steps after which a cart's episode is truncated (MakeVec passes the spec's, 500 for CartPole-v1). The max_episode_steps keyword argument, passed on only once set.

public long MaxEpisodeSteps { get; init; }

Property Value

long

NumEnvs

Gymnasium's num_envs: the number of carts. The num_envs keyword argument, passed on only once set.

public int NumEnvs { get; init; }

Property Value

int

RenderMode

Gymnasium's render_mode: null, or a mode under which Render() draws every cart (rgb_array). The render_mode keyword argument, passed on only once set.

public string? RenderMode { get; init; }

Property Value

string

SuttonBartoReward

Gymnasium's sutton_barto_reward: reward -1 at termination and 0 otherwise, instead of 1 per step. The sutton_barto_reward keyword argument, passed on only once set.

public bool SuttonBartoReward { get; init; }

Property Value

bool

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.