commonpower.control.wrappers.DeploymentWrapper

class DeploymentWrapper(env)[source]

Bases: Wrapper

Wrapper to standardize the deployment within CommonPower. Mainly takes care of transforming actions and observations such that they match the underlying wrappers (e.g., SingleAgentWrapper, MultiAgentWrapper, …).

Parameters:: env (gym.Environment) – potentially wrapped ControlEnv

Returns: DeploymentWrapper

Methods

`class_name`	Returns the class name of the wrapper.
`close`	Closes the wrapper and `env`.
`get_wrapper_attr`	Gets an attribute from the wrapper and lower environments if name doesn't exist in this object.
`render`	Uses the `render()` of the `env` that can be overwritten to change the returned data.
`reset`	Uses the `reset()` of the `env` that can be overwritten to change the returned data.
`step`	Uses the `step()` of the `env` that can be overwritten to change the returned data.
`wrapper_spec`	Generates a WrapperSpec for the wrappers.

Attributes

`action_space`	Return the `Env` `action_space` unless overwritten then the wrapper `action_space` is used.
`metadata`	Returns the `Env` `metadata`.
`np_random`	Returns the `Env` `np_random` attribute.
`observation_space`	Return the `Env` `observation_space` unless overwritten then the wrapper `observation_space` is used.
`render_mode`	Returns the `Env` `render_mode`.
`reward_range`	Return the `Env` `reward_range` unless overwritten then the wrapper `reward_range` is used.
`spec`	Returns the `Env` `spec` attribute with the WrapperSpec if the wrapper inherits from EzPickle.
`unwrapped`	Returns the base environment of the wrapper.

reset(*, seed: int | None = None, options: dict | None = None) → Tuple[dict, dict][source]: Uses the reset() of the env that can be overwritten to change the returned data.

step(action: OrderedDict | None) → Tuple[dict, dict, bool, bool, dict][source]: Uses the step() of the env that can be overwritten to change the returned data.