lit_sb3.vec_env.vec_frame_stack

source module lit_sb3.vec_env.vec_frame_stack

Classes

• VecFrameStack — Frame stacking wrapper for vectorized environment. Designed for image observations.

source class VecFrameStack(venv: VecEnv, n_stack: int, channels_order: str | Mapping[str, str] | None = None)

Bases : VecEnvWrapper

Frame stacking wrapper for vectorized environment. Designed for image observations.

Parameters

• venv : VecEnv — Vectorized environment to wrap

• n_stack : int — Number of frames to stack

• channels_order : str | Mapping[str, str] | None — If "first", stack on first image dimension. If "last", stack on last dimension. If None, automatically detect channel to stack over in case of image observation or default to "last" (default). Alternatively channels_order can be a dictionary which can be used with environments with Dict observation spaces

Methods

• step_wait

• reset — Reset all environments.

source method VecFrameStack.step_wait() → tuple[np.ndarray | dict[str, np.ndarray], np.ndarray, np.ndarray, list[dict[str, Any]]]

source method VecFrameStack.reset() → np.ndarray | dict[str, np.ndarray]

Reset all environments.