xpag.wrappers.reset_done.ResetDoneWrapper

class ResetDoneWrapper(env)

Bases: Wrapper

Wraps an environment to allow a modular transformation of the step() and reset() methods.

Parameters:

env – The environment to wrap

Methods

class_name	Returns the class name of the wrapper.
close	Closes the wrapper and env.
get_wrapper_attr	Gets an attribute from the wrapper and lower environments if name doesn't exist in this object.
render	Uses the render() of the env that can be overwritten to change the returned data.
reset	Uses the reset() of the env that can be overwritten to change the returned data.
reset_done
step	Uses the step() of the env that can be overwritten to change the returned data.
wrapper_spec	Generates a WrapperSpec for the wrappers.

Attributes

action_space	Return the Env action_space unless overwritten then the wrapper action_space is used.
metadata	Returns the Env metadata.
np_random	Returns the Env np_random attribute.
observation_space	Return the Env observation_space unless overwritten then the wrapper observation_space is used.
render_mode	Returns the Env render_mode.
reward_range	Return the Env reward_range unless overwritten then the wrapper reward_range is used.
spec	Returns the Env spec attribute with the WrapperSpec if the wrapper inherits from EzPickle.
unwrapped	Returns the base environment of the wrapper.

property action_space: Space[ActType] | Space[WrapperActType]

Return the Env action_space unless overwritten then the wrapper action_space is used.

classmethod class_name()

Returns the class name of the wrapper.

Return type:

str

close()

Closes the wrapper and env.

get_wrapper_attr(name)

Gets an attribute from the wrapper and lower environments if name doesn’t exist in this object.

Parameters:

name (str) – The variable name to get

Return type:

Any

Returns:

The variable with name in wrapper or lower environments

property metadata: dict[str, Any]

Returns the Env metadata.

property np_random: Generator

Returns the Env np_random attribute.

property observation_space: Space[ObsType] | Space[WrapperObsType]

Return the Env observation_space unless overwritten then the wrapper observation_space is used.

render()

Uses the render() of the env that can be overwritten to change the returned data.

Return type:

Union[TypeVar(RenderFrame), list[TypeVar(RenderFrame)], None]

property render_mode: str | None

Returns the Env render_mode.

reset(**kwargs)

Uses the reset() of the env that can be overwritten to change the returned data.

property reward_range: tuple[SupportsFloat, SupportsFloat]

Return the Env reward_range unless overwritten then the wrapper reward_range is used.

property spec: EnvSpec | None

Returns the Env spec attribute with the WrapperSpec if the wrapper inherits from EzPickle.

step(action)

Uses the step() of the env that can be overwritten to change the returned data.

property unwrapped: Env[ObsType, ActType]

Returns the base environment of the wrapper.

This will be the bare gymnasium.Env environment, underneath all layers of wrappers.

classmethod wrapper_spec(**kwargs)

Generates a WrapperSpec for the wrappers.

Return type:

WrapperSpec