Table of Contents

Class AddRenderObservationOptions

Namespace
Gym.Wrappers
Assembly
Gym.dll

The keyword arguments of AddRenderObservation<TObs, TAct>'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 AddRenderObservationOptions : IGymOptions, IEquatable<AddRenderObservationOptions>
Inheritance
AddRenderObservationOptions
Implements
Inherited Members
Extension Methods

Properties

ObsKey

The observation's key when the env's space is no Dict. The obs_key keyword argument, passed on only once set.

public string ObsKey { get; init; }

Property Value

string

RenderKey

The frame's key in the dict. The render_key keyword argument, passed on only once set.

public string RenderKey { get; init; }

Property Value

string

RenderOnly

Whether the frame replaces the observation (the default) instead of joining it in a dict. The render_only keyword argument, passed on only once set.

public bool RenderOnly { 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.