commonpower.control.wrappers.RecordTransitionsWrapper

class RecordTransitionsWrapper(env: ControlEnv, scenario_id: str, run_config: dict, seed: int, tuple_db: TupleDB, buffer_size: int = 100, write_buffer_on_done: bool = True)[source]

Bases: Wrapper

Wrapper for recording transition tuples (s,a,s’,r) either to current disk or to a data base. NOTE: Currently only available for single-agent RL!

Parameters:

env (gym.Env) – The gym environment to be wrapped.
tuple_db (TupleDB) – The database for storing the transition tuples.
buffer_size (int, optional) – The maximum size of the tuple buffer. Defaults to 100.
write_buffer_on_done (bool, optional) – Whether to always write out the buffer on a done state. Defaults to True.

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(**kwargs)[source]: Uses the reset() of the env that can be overwritten to change the returned data.

step(action)[source]: Uses the step() of the env that can be overwritten to change the returned data.