unienv_interface.func_wrapper.frame_stack

WrapperBArrayT module-attribute

WrapperBArrayT = TypeVar('WrapperBArrayT')

WrapperContextT module-attribute

WrapperContextT = TypeVar('WrapperContextT')

WrapperObsT module-attribute

WrapperObsT = TypeVar('WrapperObsT')

WrapperActT module-attribute

WrapperActT = TypeVar('WrapperActT')

WrapperBDeviceT module-attribute

WrapperBDeviceT = TypeVar('WrapperBDeviceT')

WrapperBDtypeT module-attribute

WrapperBDtypeT = TypeVar('WrapperBDtypeT')

WrapperBRngT module-attribute

WrapperBRngT = TypeVar('WrapperBRngT')

WrapperRenderFrame module-attribute

WrapperRenderFrame = TypeVar('WrapperRenderFrame')

WrapperStateT module-attribute

WrapperStateT = TypeVar('WrapperStateT')

WrapperRenderStateT module-attribute

WrapperRenderStateT = TypeVar('WrapperRenderStateT')

FuncEnvCommonRenderInfo dataclass

FuncEnvCommonRenderInfo(render_mode: Optional[str] = None, render_fps: Optional[int] = None)

Small metadata bundle returned by FuncEnv.render_init.

render_mode class-attribute instance-attribute

render_mode: Optional[str] = None

render_fps class-attribute instance-attribute

render_fps: Optional[int] = None

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.

Wrap a functional environment and optionally override its interface metadata.

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

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]]

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]

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.

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.

FuncFrameStackWrapperState

FuncFrameStackWrapperState(*args, **kwargs)

Bases: Generic[StateType], StateClass

env_state instance-attribute

env_state: StateType

obs_queue_state instance-attribute

obs_queue_state: Optional[SpaceDataQueueState]

action_queue_state instance-attribute

action_queue_state: Optional[SpaceDataQueueState]

replace

replace(**overrides) -> TNode

FuncFrameStackWrapper

FuncFrameStackWrapper(func_env: FuncEnv[StateType, RenderStateType, BArrayType, ContextType, ObsType, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType], obs_stack_size: int = 0, action_stack_size: int = 0, action_default_value: Optional[ActType] = None)

Bases: FuncEnvWrapper[FuncFrameStackWrapperState[StateType], RenderStateType, BArrayType, ContextType, ObsType, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType, StateType, RenderStateType, BArrayType, ContextType, ObsType, ActType, RenderFrame, BDeviceType, BDtypeType, BRNGType]

action_stack_size instance-attribute

action_stack_size = action_stack_size

obs_stack_size instance-attribute

obs_stack_size = obs_stack_size

action_deque instance-attribute

action_deque = FuncSpaceDataQueue(action_space, batch_size, action_stack_size)

action_default_value instance-attribute

action_default_value = action_default_value

obs_deque instance-attribute

obs_deque = None

observation_space instance-attribute

observation_space = new_obs_space

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

action_space: Space[WrapperActT, WrapperBDeviceT, Any, WrapperBRngT]

context_space property writable

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

unwrapped property

unwrapped: FuncEnv

prev_wrapper_layer property

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

func_env instance-attribute

func_env = func_env

map_observation

map_observation(state: FuncFrameStackWrapperState[StateType], observation: ObsType) -> ObsType

initial

initial(*, seed=None, **kwargs)

reset

reset(state, *args, seed=None, mask=None, **kwargs)

step

step(state, action)

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

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

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.