Observation Filtering

This module implements a block transformation for filtering out some of the keys of the observation space of an environment that may be arbitrarily nested.

class gym_jiminy.common.wrappers.observation_filter.FilterObservation(env, nested_filter_keys)

Bases: BaseTransformObservation[NestedObsT, NestedObsT, ActT], Generic[NestedObsT, ActT]

Filter nested observation space.

This wrapper does nothing but providing an observation only exposing a subset of all the leaves of the original observation space. For flattening the observation space after filtering, you should wrap the environment with FlattenObservation as yet another layer.

Parameters:

• env (InterfaceJiminyEnv[NestedObsT, ActT]) – Base or already wrapped jiminy environment.

• kwargs – Extra keyword arguments for multiple inheritance.

• nested_filter_keys (Sequence[Sequence[str | int] | str | int])

transform_observation()

No-op transform since the transform observation is sharing memory with the wrapped one since it is just a partial view.

Return type:

None