sinergym.utils.wrappers.IncrementalWrapper
- class sinergym.utils.wrappers.IncrementalWrapper(env: Env, incremental_variables_definition: Dict[str, Tuple[float, float]], initial_values: List[float])
A wrapper for an incremental values of desired action variables
- __init__(env: Env, incremental_variables_definition: Dict[str, Tuple[float, float]], initial_values: List[float])
- Parameters:
env (gym.Env) – Original Sinergym environment.
incremental_variables_definition (Dict[str, Tuple[float, float]]) – Dictionary defining incremental variables. Key: variable name, Value: Tuple with delta and step values. Delta: maximum range, Step: intermediate value jumps.
initial_values (List[float]) – Initial values for incremental variables. Length of this list and dictionary must match.
Methods
__init__
(env, ...)action
(action)Takes the continuous action and apply increment/decrement before to send to the next environment layer.
class_name
()Returns the class name of the wrapper.
close
()Closes the wrapper and
env
.get_wrapper_attr
(name)Gets an attribute from the wrapper and lower environments if name doesn't exist in this object.
has_wrapper_attr
(name)Checks if the given attribute is within the wrapper or its environment.
render
()Uses the
render()
of theenv
that can be overwritten to change the returned data.reset
(*[, seed, options])Uses the
reset()
of theenv
that can be overwritten to change the returned data.set_wrapper_attr
(name, value)Sets an attribute on this wrapper or lower environment if name is already defined.
step
(action)Runs the
env
env.step()
using the modifiedaction
fromself.action()
.wrapper_spec
(**kwargs)Generates a WrapperSpec for the wrappers.
Attributes
action_space
Return the
Env
action_space
unless overwritten then the wrapperaction_space
is used.metadata
Returns the
Env
metadata
.np_random
Returns the
Env
np_random
attribute.np_random_seed
Returns the base environment's
np_random_seed
.observation_space
Return the
Env
observation_space
unless overwritten then the wrapperobservation_space
is used.render_mode
Returns the
Env
render_mode
.spec
Returns the
Env
spec
attribute with the WrapperSpec if the wrapper inherits from EzPickle.unwrapped
Returns the base environment of the wrapper.
- action(action)
Takes the continuous action and apply increment/decrement before to send to the next environment layer.
- logger = <Logger WRAPPER IncrementalWrapper (INFO)>