Table of Contents

Class RewardWrapper<TObs, TAct>

Namespace
Gym.Envs
Assembly
Gym.dll

Transforms every reward Step(TAct) returns through Reward(double).

public abstract class RewardWrapper<TObs, TAct> : Wrapper<TObs, TAct, TObs, TAct>, IDynamicAttributes, IWrapper, IEnv, IDisposable

Type Parameters

TObs

The observation type, passed through.

TAct

The action type, passed through.

Inheritance
Env<TObs, TAct>
Wrapper<TObs, TAct, TObs, TAct>
RewardWrapper<TObs, TAct>
Implements
Derived
Inherited Members
Extension Methods

Remarks

Reference: gymnasium/core.py.

Constructors

RewardWrapper(Env<TObs, TAct>)

Wraps env.

protected RewardWrapper(Env<TObs, TAct> env)

Parameters

env Env<TObs, TAct>

The env whose rewards are transformed.

Exceptions

TypeError

Thrown when env is null.

Methods

Reward(double)

The transformation (reward(reward)).

public abstract double Reward(double reward)

Parameters

reward double

The env's reward.

Returns

double

The transformed reward.

Step(TAct)

Steps the env and returns its transition with the reward transformed.

public override StepResult<TObs> Step(TAct action)

Parameters

action TAct

The action, passed on.

Returns

StepResult<TObs>

(observation, self.reward(reward), terminated, truncated, info).