Table of Contents

Class FrozenLakeEnvOptions

Namespace
Gym.Environments.Envs.ToyText
Assembly
Gym.Environments.dll

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

Properties

Desc

Gymnasium's desc: the map's rows (S start, F frozen, H hole, G goal), all of one length. The desc keyword argument, passed on only once set.

public IReadOnlyList<string>? Desc { get; init; }

Property Value

IReadOnlyList<string>

IsSlippery

Gymnasium's is_slippery: moves may slide perpendicular, each with probability (1 - success_rate) / 2. The is_slippery keyword argument, passed on only once set.

public bool IsSlippery { get; init; }

Property Value

bool

MapName

Gymnasium's map_name: "4x4" or "8x8" (Maps), used when Desc is null; with both null, GenerateRandomMap(int, double, BigInteger?) makes an 8x8 map from fresh entropy (not reproducible). The map_name keyword argument, passed on only once set.

public string? MapName { get; init; }

Property Value

string

RenderMode

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

public string? RenderMode { get; init; }

Property Value

string

RewardSchedule

Gymnasium's reward_schedule: the rewards for reaching the goal, a hole and any other tile; null is (1, 0, 0). The reward_schedule keyword argument, passed on only once set.

public IReadOnlyList<double>? RewardSchedule { get; init; }

Property Value

IReadOnlyList<double>

SuccessRate

Gymnasium's success_rate: the probability of moving as intended on slippery ice, 1/3 by default. The success_rate keyword argument, passed on only once set.

public double SuccessRate { get; init; }

Property Value

double

ViewerFactory

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

public EnvViewerFactory? ViewerFactory { get; init; }

Property Value

EnvViewerFactory

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.