unienv_interface.env_base.wrapper¶
Classes:
| Name | Description |
|---|---|
Wrapper |
Base class for stateful environment wrappers. |
ActionWrapper |
Wrapper that exposes a transformed action interface. |
ContextObservationWrapper |
Wrapper that transforms context and observation values. |
Attributes:
| Name | Type | Description |
|---|---|---|
WrapperBArrayT |
|
|
WrapperContextT |
|
|
WrapperObsT |
|
|
WrapperActT |
|
|
WrapperBDeviceT |
|
|
WrapperBDtypeT |
|
|
WrapperBRngT |
|
|
WrapperRenderFrame |
|
Wrapper
¶
Wrapper(
env: Env[
BArrayType,
ContextType,
ObsType,
ActType,
RenderFrame,
BDeviceType,
BDtypeType,
BRNGType,
],
)
Bases: Env[WrapperBArrayT, WrapperContextT, WrapperObsT, WrapperActT, WrapperRenderFrame, WrapperBDeviceT, WrapperBDtypeT, WrapperBRngT], Generic[WrapperBArrayT, WrapperContextT, WrapperObsT, WrapperActT, WrapperRenderFrame, WrapperBDeviceT, WrapperBDtypeT, WrapperBRngT, BArrayType, ContextType, ObsType, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType]
Base class for stateful environment wrappers.
The wrapper forwards all operations to env by default while allowing
subclasses to override spaces, RNG handling, and selected lifecycle methods.
Space-forwarding invariant¶
By default the wrapper exposes the wrapped env's action_space,
observation_space, and context_space unchanged. Because the
:class:Env contract guarantees that these spaces already include the
batch dimension when the env is batched, subclasses that do override
a space must ensure the replacement still matches the batching status
of the underlying env. Never wrap an already-batched env space in an
additional batch_space call.
Wrap env and optionally override spaces or metadata later.
Methods:
| Name | Description |
|---|---|
step |
|
reset |
|
render |
|
close |
|
has_wrapper_attr |
Checks if the given attribute is within the wrapper or its environment. |
get_wrapper_attr |
Gets an attribute from the wrapper and lower environments if |
set_wrapper_attr |
Sets an attribute on this wrapper or lower environment if |
sample_space |
Sample from |
sample_action |
Sample one action from |
sample_observation |
Sample one observation from |
sample_context |
Sample one context value if |
update_observation_post_reset |
Merge masked reset observations back into a full batched observation. |
update_context_post_reset |
Merge masked reset contexts back into a full batched context. |
Attributes:
| Name | Type | Description |
|---|---|---|
metadata |
Dict[str, Any]
|
Returns the :attr: |
render_mode |
Optional[WrapperRenderFrame]
|
|
render_fps |
Optional[int]
|
|
backend |
ComputeBackend[Any, WrapperBDeviceT, Any, WrapperBRngT]
|
|
device |
Optional[WrapperBDeviceT]
|
|
batch_size |
Optional[int]
|
|
action_space |
Space[WrapperActT, WrapperBDeviceT, Any, WrapperBRngT]
|
|
observation_space |
Space[WrapperObsT, WrapperBDeviceT, Any, WrapperBRngT]
|
|
context_space |
Optional[Space[WrapperContextT, WrapperBDeviceT, Any, WrapperBRngT]]
|
|
rng |
WrapperBRngT
|
Returns the :attr: |
env |
|
|
unwrapped |
Env
|
Returns the base environment of the wrapper. |
prev_wrapper_layer |
Env[BArrayType, ContextType, ObsType, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType]
|
|
action_space
property
writable
¶
action_space: Space[WrapperActT, WrapperBDeviceT, Any, WrapperBRngT]
observation_space
property
writable
¶
observation_space: Space[WrapperObsT, WrapperBDeviceT, Any, WrapperBRngT]
context_space
property
writable
¶
context_space: Optional[Space[WrapperContextT, WrapperBDeviceT, Any, WrapperBRngT]]
unwrapped
property
¶
unwrapped: Env
Returns the base environment of the wrapper.
This will be the bare :class:gymnasium.Env environment, underneath all layers of wrappers.
prev_wrapper_layer
property
¶
prev_wrapper_layer: Env[
BArrayType,
ContextType,
ObsType,
ActType,
RenderFrame,
BDeviceType,
BDtypeType,
BRNGType,
]
step
¶
step(
action: WrapperActT,
) -> Tuple[
WrapperObsT,
Union[SupportsFloat, WrapperBArrayT],
Union[bool, WrapperBArrayT],
Union[bool, WrapperBArrayT],
Dict[str, Any],
]
reset
¶
reset(
*args, mask: Optional[WrapperBArrayT] = None, seed: Optional[int] = None, **kwargs
) -> Tuple[WrapperContextT, WrapperObsT, Dict[str, Any]]
has_wrapper_attr
¶
Checks if the given attribute is within the wrapper or its environment.
get_wrapper_attr
¶
Gets an attribute from the wrapper and lower environments if name doesn't exist in this object.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The variable name to get |
required |
Returns:
| Type | Description |
|---|---|
Any
|
The variable with name in wrapper or lower environments |
set_wrapper_attr
¶
Sets an attribute on this wrapper or lower environment if name is already defined.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The variable name |
required |
value
|
Any
|
The new variable value |
required |
sample_context
¶
sample_context() -> Optional[ContextType]
Sample one context value if context_space is defined.
update_observation_post_reset
¶
update_observation_post_reset(
old_obs: ObsType, newobs_masked: ObsType, mask: BArrayType
) -> ObsType
Merge masked reset observations back into a full batched observation.
update_context_post_reset
¶
update_context_post_reset(
old_context: ContextType, new_context: ContextType, mask: BArrayType
) -> ContextType
Merge masked reset contexts back into a full batched context.
ActionWrapper
¶
ActionWrapper(
env: Env[
BArrayType,
ContextType,
ObsType,
ActType,
RenderFrame,
BDeviceType,
BDtypeType,
BRNGType,
],
)
Bases: Wrapper[BArrayType, ContextType, ObsType, WrapperActT, RenderFrame, BDeviceType, BDtypeType, BRNGType, BArrayType, ContextType, ObsType, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType], Generic[WrapperActT, BArrayType, ContextType, ObsType, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType]
Wrapper that exposes a transformed action interface.
Wrap env and optionally override spaces or metadata later.
Methods:
| Name | Description |
|---|---|
map_action |
Map an outer action into the wrapped environment's action space. |
reverse_map_action |
Map an inner action back to the wrapper-facing representation. |
step |
|
reset |
|
render |
|
close |
|
sample_space |
Sample from |
sample_action |
Sample one action from |
sample_observation |
Sample one observation from |
sample_context |
Sample one context value if |
update_observation_post_reset |
Merge masked reset observations back into a full batched observation. |
update_context_post_reset |
Merge masked reset contexts back into a full batched context. |
has_wrapper_attr |
Checks if the given attribute is within the wrapper or its environment. |
get_wrapper_attr |
Gets an attribute from the wrapper and lower environments if |
set_wrapper_attr |
Sets an attribute on this wrapper or lower environment if |
Attributes:
| Name | Type | Description |
|---|---|---|
metadata |
Dict[str, Any]
|
Returns the :attr: |
render_mode |
Optional[WrapperRenderFrame]
|
|
render_fps |
Optional[int]
|
|
backend |
ComputeBackend[Any, WrapperBDeviceT, Any, WrapperBRngT]
|
|
device |
Optional[WrapperBDeviceT]
|
|
batch_size |
Optional[int]
|
|
action_space |
Space[WrapperActT, WrapperBDeviceT, Any, WrapperBRngT]
|
|
observation_space |
Space[WrapperObsT, WrapperBDeviceT, Any, WrapperBRngT]
|
|
context_space |
Optional[Space[WrapperContextT, WrapperBDeviceT, Any, WrapperBRngT]]
|
|
rng |
WrapperBRngT
|
Returns the :attr: |
unwrapped |
Env
|
Returns the base environment of the wrapper. |
prev_wrapper_layer |
Env[BArrayType, ContextType, ObsType, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType]
|
|
env |
|
action_space
property
writable
¶
action_space: Space[WrapperActT, WrapperBDeviceT, Any, WrapperBRngT]
observation_space
property
writable
¶
observation_space: Space[WrapperObsT, WrapperBDeviceT, Any, WrapperBRngT]
context_space
property
writable
¶
context_space: Optional[Space[WrapperContextT, WrapperBDeviceT, Any, WrapperBRngT]]
unwrapped
property
¶
unwrapped: Env
Returns the base environment of the wrapper.
This will be the bare :class:gymnasium.Env environment, underneath all layers of wrappers.
prev_wrapper_layer
property
¶
prev_wrapper_layer: Env[
BArrayType,
ContextType,
ObsType,
ActType,
RenderFrame,
BDeviceType,
BDtypeType,
BRNGType,
]
map_action
abstractmethod
¶
map_action(action: WrapperActT) -> ActType
Map an outer action into the wrapped environment's action space.
reverse_map_action
¶
reverse_map_action(action: ActType) -> WrapperActT
Map an inner action back to the wrapper-facing representation.
step
¶
step(
action: WrapperActT,
) -> Tuple[
ObsType,
Union[SupportsFloat, BArrayType],
Union[bool, BArrayType],
Union[bool, BArrayType],
Dict[str, Any],
]
reset
¶
reset(
*args, mask: Optional[WrapperBArrayT] = None, seed: Optional[int] = None, **kwargs
) -> Tuple[WrapperContextT, WrapperObsT, Dict[str, Any]]
sample_context
¶
sample_context() -> Optional[ContextType]
Sample one context value if context_space is defined.
update_observation_post_reset
¶
update_observation_post_reset(
old_obs: ObsType, newobs_masked: ObsType, mask: BArrayType
) -> ObsType
Merge masked reset observations back into a full batched observation.
update_context_post_reset
¶
update_context_post_reset(
old_context: ContextType, new_context: ContextType, mask: BArrayType
) -> ContextType
Merge masked reset contexts back into a full batched context.
has_wrapper_attr
¶
Checks if the given attribute is within the wrapper or its environment.
get_wrapper_attr
¶
Gets an attribute from the wrapper and lower environments if name doesn't exist in this object.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The variable name to get |
required |
Returns:
| Type | Description |
|---|---|
Any
|
The variable with name in wrapper or lower environments |
set_wrapper_attr
¶
Sets an attribute on this wrapper or lower environment if name is already defined.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The variable name |
required |
value
|
Any
|
The new variable value |
required |
ContextObservationWrapper
¶
ContextObservationWrapper(
env: Env[
BArrayType,
ContextType,
ObsType,
ActType,
RenderFrame,
BDeviceType,
BDtypeType,
BRNGType,
],
)
Bases: Wrapper[BArrayType, WrapperContextT, WrapperObsT, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType, BArrayType, ContextType, ObsType, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType], Generic[WrapperContextT, WrapperObsT, BArrayType, ContextType, ObsType, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType]
Wrapper that transforms context and observation values.
Wrap env and optionally override spaces or metadata later.
Methods:
| Name | Description |
|---|---|
map_context |
Convert wrapped context into the wrapper-facing representation. |
reverse_map_context |
Convert wrapper-facing context back into the wrapped representation. |
map_observation |
Convert wrapped observations into the wrapper-facing representation. |
reverse_map_observation |
Convert wrapper-facing observations back into the wrapped representation. |
reset |
|
step |
|
render |
|
close |
|
sample_space |
Sample from |
sample_action |
Sample one action from |
sample_observation |
Sample one observation from |
sample_context |
Sample one context value if |
update_observation_post_reset |
Merge masked reset observations back into a full batched observation. |
update_context_post_reset |
Merge masked reset contexts back into a full batched context. |
has_wrapper_attr |
Checks if the given attribute is within the wrapper or its environment. |
get_wrapper_attr |
Gets an attribute from the wrapper and lower environments if |
set_wrapper_attr |
Sets an attribute on this wrapper or lower environment if |
Attributes:
| Name | Type | Description |
|---|---|---|
metadata |
Dict[str, Any]
|
Returns the :attr: |
render_mode |
Optional[WrapperRenderFrame]
|
|
render_fps |
Optional[int]
|
|
backend |
ComputeBackend[Any, WrapperBDeviceT, Any, WrapperBRngT]
|
|
device |
Optional[WrapperBDeviceT]
|
|
batch_size |
Optional[int]
|
|
action_space |
Space[WrapperActT, WrapperBDeviceT, Any, WrapperBRngT]
|
|
observation_space |
Space[WrapperObsT, WrapperBDeviceT, Any, WrapperBRngT]
|
|
context_space |
Optional[Space[WrapperContextT, WrapperBDeviceT, Any, WrapperBRngT]]
|
|
rng |
WrapperBRngT
|
Returns the :attr: |
unwrapped |
Env
|
Returns the base environment of the wrapper. |
prev_wrapper_layer |
Env[BArrayType, ContextType, ObsType, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType]
|
|
env |
|
action_space
property
writable
¶
action_space: Space[WrapperActT, WrapperBDeviceT, Any, WrapperBRngT]
observation_space
property
writable
¶
observation_space: Space[WrapperObsT, WrapperBDeviceT, Any, WrapperBRngT]
context_space
property
writable
¶
context_space: Optional[Space[WrapperContextT, WrapperBDeviceT, Any, WrapperBRngT]]
unwrapped
property
¶
unwrapped: Env
Returns the base environment of the wrapper.
This will be the bare :class:gymnasium.Env environment, underneath all layers of wrappers.
prev_wrapper_layer
property
¶
prev_wrapper_layer: Env[
BArrayType,
ContextType,
ObsType,
ActType,
RenderFrame,
BDeviceType,
BDtypeType,
BRNGType,
]
map_context
¶
map_context(context: WrapperContextT) -> ContextType
Convert wrapped context into the wrapper-facing representation.
reverse_map_context
¶
reverse_map_context(context: ContextType) -> WrapperContextT
Convert wrapper-facing context back into the wrapped representation.
map_observation
¶
map_observation(observation: WrapperObsT) -> ObsType
Convert wrapped observations into the wrapper-facing representation.
reverse_map_observation
¶
reverse_map_observation(observation: ObsType) -> WrapperObsT
Convert wrapper-facing observations back into the wrapped representation.
reset
¶
reset(
*args, mask: Optional[BArrayType] = None, seed: Optional[int] = None, **kwargs
) -> Tuple[WrapperContextT, WrapperObsT, Dict[str, Any]]
step
¶
step(
action: ActType,
) -> Tuple[
WrapperObsT,
Union[float, BArrayType],
Union[bool, BArrayType],
Union[bool, BArrayType],
Dict[str, Any],
]
sample_context
¶
sample_context() -> Optional[ContextType]
Sample one context value if context_space is defined.
update_observation_post_reset
¶
update_observation_post_reset(
old_obs: ObsType, newobs_masked: ObsType, mask: BArrayType
) -> ObsType
Merge masked reset observations back into a full batched observation.
update_context_post_reset
¶
update_context_post_reset(
old_context: ContextType, new_context: ContextType, mask: BArrayType
) -> ContextType
Merge masked reset contexts back into a full batched context.
has_wrapper_attr
¶
Checks if the given attribute is within the wrapper or its environment.
get_wrapper_attr
¶
Gets an attribute from the wrapper and lower environments if name doesn't exist in this object.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The variable name to get |
required |
Returns:
| Type | Description |
|---|---|
Any
|
The variable with name in wrapper or lower environments |
set_wrapper_attr
¶
Sets an attribute on this wrapper or lower environment if name is already defined.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The variable name |
required |
value
|
Any
|
The new variable value |
required |