commonpower.control.logging_utils.loggers.TensorboardLogger

class TensorboardLogger(log_dir: str, callback: ~stable_baselines3.common.callbacks.BaseCallback = <class 'commonpower.control.logging_utils.callbacks.SafetyCallback'>)

Bases: BaseLogger

Class for using tensorboard logging in single-agent stable-baselines3 algorithms.

Parameters:

• log_dir (str) – relative path to logging directory

• callback (BaseCallback, optional) – object that implements actual logging during training. By defining a customized callback, additional information can be logged (apart from standard metrics like mean_eps_reward)

Methods

finish_logging
get_log_dir
log_function	Hands over the callback so it can be used by the stable-baselines3 internal logging.

log_function() → BaseCallback

Hands over the callback so it can be used by the stable-baselines3 internal logging.

Returns:

BaseCallback – callback which is used during training to log additional information