Skip to content

Sb3LoggingSettings

Full path: schola.scripts.sb3.train.settings.Sb3LoggingSettings

Dataclass for configuring logging settings for the training process.

Sb3LoggingSettings(schola_verbosity = 0, sb3_verbosity = 1,
                   enable_tensorboard = False, log_dir = WindowsPath('logs'),
                   log_freq = 10, callback_verbosity = 0)

Bases: Sb3BaseLoggingSettings

Parameters

  • schola_verbosity (Annotated)

  • sb3_verbosity (Annotated)

  • enable_tensorboard (bool)

  • log_dir (Any)

  • log_freq (Annotated)

  • callback_verbosity (Annotated)

Methods

init

__init__(schola_verbosity = 0, sb3_verbosity = 1, enable_tensorboard = False,
         log_dir = WindowsPath('logs'), log_freq = 10, callback_verbosity = 0)

Parameters

  • schola_verbosity (Annotated)

  • sb3_verbosity (Annotated)

  • enable_tensorboard (bool)

  • log_dir (Any)

  • log_freq (Annotated)

  • callback_verbosity (Annotated)

Attributes

callback_verbosity

callback_verbosity

Verbosity level for callbacks. This controls the level of detail in the output from any callbacks used during training.

enable_tensorboard

enable_tensorboard

Whether to enable TensorBoard logging.

log_dir

log_dir

Directory to save TensorBoard logs. (Will be created if it doesn’t exist when tensorboard is enabled.)

log_freq

log_freq

Frequency of logging training metrics to TensorBoard. This determines how often (in terms of training steps) the training metrics will be logged to TensorBoard. A value of 10 means that every 10 training steps, the metrics will be recorded.