Skip to content

unienv_interface.env_base.funcenv_wrapper

Classes:

Name Description
FuncEnvWrapper

Base wrapper for FuncEnv implementations.

Attributes:

Name Type Description
WrapperStateT
WrapperRenderStateT

WrapperStateT module-attribute

WrapperStateT = TypeVar('WrapperStateT')

WrapperRenderStateT module-attribute

WrapperRenderStateT = TypeVar('WrapperRenderStateT')

FuncEnvWrapper

FuncEnvWrapper(
    func_env: FuncEnv[
        StateType,
        RenderStateType,
        BArrayType,
        ContextType,
        ObsType,
        ActType,
        RenderFrame,
        BDeviceType,
        BDtypeType,
        BRNGType,
    ],
)

Bases: Generic[WrapperStateT, WrapperRenderStateT, WrapperBArrayT, WrapperContextT, WrapperObsT, WrapperActT, WrapperRenderFrame, WrapperBDeviceT, WrapperBDtypeT, WrapperBRngT, StateType, RenderStateType, BArrayType, ContextType, ObsType, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType], FuncEnv[WrapperStateT, WrapperRenderStateT, WrapperBArrayT, WrapperContextT, WrapperObsT, WrapperActT, WrapperRenderFrame, WrapperBDeviceT, WrapperBDtypeT, WrapperBRngT]

Base wrapper for FuncEnv implementations.

This mirrors :class:Wrapper but preserves the explicit state-passing style of the functional environment API.

Space-forwarding invariant

By default the wrapper forwards the wrapped FuncEnv's action_space, observation_space, and context_space unchanged. Because the :class:FuncEnv contract guarantees that these spaces already include the batch dimension when the env is batched, subclasses that 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 a functional environment and optionally override its interface metadata.

Methods:

Name Description
initial
reset
step
close
render_init
render_image
render_close
has_wrapper_attr

Checks if the attribute name exists in the environment.

get_wrapper_attr

Gets the attribute name from the environment.

set_wrapper_attr

Sets the attribute name on the environment with value.

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:Env :attr:metadata.

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]]
func_env
unwrapped FuncEnv
prev_wrapper_layer FuncEnv[StateType, RenderStateType, BArrayType, ContextType, ObsType, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType]

metadata property writable

metadata: Dict[str, Any]

Returns the :attr:Env :attr:metadata.

backend property

backend: ComputeBackend[Any, WrapperBDeviceT, Any, WrapperBRngT]

device property

device: Optional[WrapperBDeviceT]

batch_size property

batch_size: Optional[int]

action_space property writable

observation_space property writable

observation_space: Space[WrapperObsT, WrapperBDeviceT, Any, WrapperBRngT]

context_space property writable

context_space: Optional[Space[WrapperContextT, WrapperBDeviceT, Any, WrapperBRngT]]

func_env instance-attribute

func_env = func_env

unwrapped property

unwrapped: FuncEnv

prev_wrapper_layer property

prev_wrapper_layer: FuncEnv[
    StateType,
    RenderStateType,
    BArrayType,
    ContextType,
    ObsType,
    ActType,
    RenderFrame,
    BDeviceType,
    BDtypeType,
    BRNGType,
]

initial

initial(
    *, seed: Optional[int] = None, **kwargs
) -> Tuple[WrapperStateT, WrapperContextT, WrapperObsT, Dict[str, Any]]

reset

reset(
    state: WrapperStateT,
    *args,
    seed: Optional[int] = None,
    mask: Optional[WrapperBArrayT] = None,
    **kwargs,
) -> Tuple[WrapperStateT, WrapperContextT, WrapperObsT, Dict[str, Any]]

step

step(
    state: WrapperStateT, action: WrapperActT
) -> Tuple[
    WrapperStateT,
    WrapperObsT,
    Union[SupportsFloat, WrapperBArrayT],
    Union[bool, WrapperBArrayT],
    Union[bool, WrapperBArrayT],
    Dict[str, Any],
]

close

close(state: WrapperStateT) -> None

render_init

render_init(
    state: WrapperStateT,
    *,
    seed: Optional[int] = None,
    render_mode: Optional[str] = None,
    **kwargs,
) -> Tuple[WrapperStateT, WrapperRenderStateT, FuncEnvCommonRenderInfo]

render_image

render_image(
    state: WrapperStateT, render_state: WrapperRenderStateT
) -> Tuple[
    WrapperRenderFrame | Sequence[WrapperRenderFrame] | None,
    WrapperStateT,
    WrapperRenderStateT,
]

render_close

render_close(state: WrapperStateT, render_state: WrapperRenderStateT) -> WrapperStateT

has_wrapper_attr

has_wrapper_attr(name: str) -> bool

Checks if the attribute name exists in the environment.

get_wrapper_attr

get_wrapper_attr(name: str) -> Any

Gets the attribute name from the environment.

set_wrapper_attr

set_wrapper_attr(name: str, value: Any)

Sets the attribute name on the environment with value.

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.