BaseLoggerBackend

class composer.core.logging.base_backend.BaseLoggerBackend[source]

Bases: composer.core.callback.Callback, abc.ABC

Base class for logging backends.

log_metric(epoch: int, step: int, log_level: LogLevel, data: TLogData)[source]

Called by the Logger for metrics where will_log() returned True.

The logging backend should override this function to log the data (e.g. write it to a file, send it to a server, etc…).

Parameters
  • epoch (int) – The epoch for the logged data.

  • step (int) – The global step for the logged data.

  • log_level (LogLevel) – The log level.

  • data (TLogData) – The metric to log.

will_log(state: State, log_level: LogLevel) bool[source]

Called by the Logger to determine whether to log a metric.

By default, it always returns True, but this method can be overridden.

Parameters
  • state (State) – The global state object.

  • log_level (LogLevel) – The log level

Returns
  • bool – Whether to log a metric call, given the

  • :class:`~composer.core.state.State` and

  • :class:`~composer.core.logging.logger.LogLevel`.