composer.loggers.logger#
Base classes, functions, and variables for logger.
Functions
Recursively formats a given log data value into a string. |
Classes
LogLevel denotes when in the training loop log messages are generated. |
|
An interface to record training data. |
- class composer.loggers.logger.LogLevel(value)[source]#
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)[source]#
An interface to record training data.
The
Trainer
, instances ofCallback
, and instances ofAlgorithm
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 thedestinations
. Each destination (e.g. theFileLogger
,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)[source]#
Log data to the
destinations
.
- file_artifact(log_level, artifact_name, file_path, *, overwrite=False)[source]#
Log
file_path
as an artifact namedartifact_name
.Both
file_path
andartifact_name
can be specified as format strings. Seeformat_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
)