Class VectorizeTransformReward<TObs, TAct>
Vectorizes a single-env reward transform (Gymnasium's VectorizeTransformReward): the wrapper class is built
over a bare stand-in env, and its function is applied to each sub-env's reward, in place.
public class VectorizeTransformReward<TObs, TAct> : VectorRewardWrapper<TObs, TAct>, IVectorEnv, IDisposable
Type Parameters
TObsThe batched observation type, passed through.
TActThe batched action type, passed through.
- Inheritance
-
VectorEnv<TObs, TAct>VectorWrapper<TObs, TAct, TObs, TAct>VectorRewardWrapper<TObs, TAct>VectorizeTransformReward<TObs, TAct>
- Implements
- Derived
- Inherited Members
- Extension Methods
Remarks
The rewards are a float64 array, updated in place: rewards[i] = wrapper.func(rewards[i]).
Reference: gymnasium/wrappers/vector/vectorize_reward.py.
Constructors
VectorizeTransformReward(VectorEnv<TObs, TAct>, Type, object?)
Wraps env, building wrapper over a bare stand-in env.
public VectorizeTransformReward(VectorEnv<TObs, TAct> env, Type wrapper, object? kwargs = null)
Parameters
envVectorEnv<TObs, TAct>The vector env.
wrapperTypeThe single-env transform wrapper class (
typeof(ClipReward<,>)).kwargsobjectThe wrapper's other arguments by Python name, or null.
Exceptions
- TypeError
Thrown when the class cannot be vectorized or built.
- InvalidBound
Thrown for what the wrapper's constructor refuses.
Properties
Wrapper
The single-env wrapper whose function is applied (wrapper); owned.
public IEnv Wrapper { get; }
Property Value
Methods
Dispose(bool)
Releases the single-env wrapper, then disposes as every vector wrapper does.
protected override void Dispose(bool disposing)
Parameters
Rewards(NDArray)
Each reward through the wrapper's function, written back into the array.
public override NDArray Rewards(NDArray rewards)
Parameters
rewardsNDArrayThe env's float64 rewards; updated in place.
Returns
- NDArray
rewards.