composer.loggers.logger

Base classes, functions, and variables for logger.

Functions

format_log_data_value

Recursively formats a given log data value into a string.

Classes

LogLevel	LogLevel denotes when in the training loop log messages are generated.
Logger	An interface to record training data.

class composer.loggers.logger.LogLevel(value)

Bases: enum.IntEnum

LogLevel denotes when in the training loop log messages are generated.

Logging destinations use the LogLevel to determine whether to record a given metric or state change.

FIT

Logged once per training run.

EPOCH

Logged once per epoch.

BATCH

Logged once per batch.

class composer.loggers.logger.Logger(state, destinations=None)

An interface to record training data.

The Trainer, instances of Callback, and instances of Algorithm invoke the logger to record data such as the epoch, training loss, and custom metrics as provided by individual callbacks and algorithms. This class does not store any data itself; instead, it routes all data to the destinations. Each destination (e.g. the FileLogger, InMemoryLogger) is responsible for storing the data itself (e.g. writing it to a file or storing it in memory).

Parameters

• state (State) – The training state.

• destinations (LoggerDestination | Sequence[LoggerDestination], optional) – The logger destinations, to where logging data will be sent. (default: None)

destinations

A sequence of LoggerDestination to where logging calls will be sent.

Type

Sequence[LoggerDestination]

data(log_level, data)

Log data to the destinations.

Parameters

• log_level (str | int | LogLevel) – The log level, which can be a name, value, or instance of LogLevel.

• data (Dict[str, Any]) – The data to log.

data_batch(data)

Helper function for self.data(LogLevel.BATCH, data).

data_epoch(data)

Helper function for self.data(LogLevel.EPOCH, data).

data_fit(data)

Helper function for self.data(LogLevel.FIT, data).

file_artifact(log_level, artifact_name, file_path, *, overwrite=False)

Log file_path as an artifact named artifact_name.

Both file_path and artifact_name can be specified as format strings. See format_name_with_dist() for more information.

Parameters

• log_level (str | int | LogLevel) – The log level, which can be a name, value, or instance of LogLevel.

• artifact_name (str) – A format string for the name of the artifact.

• file_path (str | Path) – A format string for the file path.

• overwrite (bool, optional) – Whether to overwrite an existing artifact with the same artifact_name. (default: False)

composer.loggers.logger.format_log_data_value(data)

Recursively formats a given log data value into a string.

Parameters

data – Data to format.

Returns

str – data as a string.