sinergym.utils.wrappers.CSVLogger
- class sinergym.utils.wrappers.CSVLogger(env: Env, info_excluded_keys: List[str] = ['reward', 'action', 'timestep', 'month', 'day', 'hour', 'time_elapsed(hours)', 'reward_weight', 'is_raining'])
- __init__(env: Env, info_excluded_keys: List[str] = ['reward', 'action', 'timestep', 'month', 'day', 'hour', 'time_elapsed(hours)', 'reward_weight', 'is_raining'])
Logger to save logger data in CSV files while is running. It is required to be wrapped by a BaseLoggerWrapper child class previously.
- Parameters:
env (Env) – Original Gym environment in Sinergym.
info_excluded_keys (List[str], optional) – List of keys in info dictionary to be excluded from CSV files. Defaults to [‘reward’, ‘action’, ‘timestep’, ‘month’, ‘day’, ‘hour’, ‘time_elapsed(hours)’, ‘reward_weight’, ‘is_raining’].
Methods
__init__
(env[, info_excluded_keys])Logger to save logger data in CSV files while is running.
class_name
()Returns the class name of the wrapper.
close
()Recording last episode summary and close env.
Dump all logger data in CSV files.
get_wrapper_attr
(name)Gets an attribute from the wrapper and lower environments if name doesn't exist in this object.
render
()Uses the
render()
of theenv
that can be overwritten to change the returned data.reset
([seed, options])Reset the environment.
step
(action)Uses the
step()
of theenv
that can be overwritten to change the returned data.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.observation_space
Return the
Env
observation_space
unless overwritten then the wrapperobservation_space
is used.render_mode
Returns the
Env
render_mode
.reward_range
Return the
Env
reward_range
unless overwritten then the wrapperreward_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.
- close() None
Recording last episode summary and close env.
- dump_log_files() None
Dump all logger data in CSV files.
- logger = <Logger WRAPPER CSVLogger (INFO)>
- reset(seed: int | None = None, options: Dict[str, Any] | None = None) Tuple[ndarray, Dict[str, Any]]
Reset the environment. Saving current logger episode summary and interaction in CSV files.
Args: seed (Optional[int]): The seed that is used to initialize the environment’s episode (np_random). If value is None, a seed will be chosen from some source of entropy. Defaults to None. options (Optional[Dict[str, Any]]): Additional information to specify how the environment is reset. Defaults to None.
Returns: Tuple[np.ndarray, Dict[str, Any]]: Current observation and info context with additional information.