Checkpoint logging

Checkpoint logging#

Defines exported symbols for package orbax.checkpoint.logging.

AbstractLogger#

class orbax.checkpoint.logging.AbstractLogger[source][source]#

Abstract base class for structured loggers.

abstractmethod log_entry(msg, *args, **kwargs)[source][source]#

Logs an informational message.

Parameters:

  • msg (Any) – The main log message.

  • *args (Any) – Additional data to be included in the log record.

  • **kwargs – Additional structured data to be included in the log record.

CompositeLogger#

class orbax.checkpoint.logging.CompositeLogger(*loggers)[source][source]#

Composite logger implementation.

__init__(*loggers)[source][source]#

CompositeLogger constructor.

Parameters:

*loggers – List of loggers to be used.

log_entry(entry)[source][source]#

Logs an informational message.

Parameters:

entry (Any) – Additional structured data to be included in the log record.

StandardLogger#

class orbax.checkpoint.logging.StandardLogger[source][source]#

Logging implementation utilizing an absl logging API.

log_entry(msg, *args, **kwargs)[source][source]#

Logs an informational message.

Parameters:

  • msg (Any) – The main log message.

  • *args (Any) – Additional data to be included in the log record.

  • **kwargs – Additional structured data to be included in the log record.

CloudLogger#

class orbax.checkpoint.logging.CloudLogger(options=CloudLoggerOptions(job_name='checkpoint_job', logger_name='checkpoint_logger', client=None, checkpoint_metadata=None))[source][source]#

Logging implementation utilizing a cloud logging API.

__init__(options=CloudLoggerOptions(job_name='checkpoint_job', logger_name='checkpoint_logger', client=None, checkpoint_metadata=None))[source][source]#

CloudLogger constructor.

Parameters:

options (CloudLoggerOptions) – Options for the logger.

log_entry(entry, severity='INFO')[source][source]#

Logs a structured message at the given severity.

Parameters:

  • entry (dict[str, Any]) – Dictionary to be logged.

  • severity (Optional[str, None]) – The severity of the log message.

Return type:

None

CloudLoggerOptions#

class orbax.checkpoint.logging.CloudLoggerOptions(job_name='checkpoint_job', logger_name='checkpoint_logger', client=None, checkpoint_metadata=None)[source][source]#

Logger options for Checkpoint loggers.

__eq__(other)#

Return self==value.

__hash__ = None#
__init__(job_name='checkpoint_job', logger_name='checkpoint_logger', client=None, checkpoint_metadata=None)#
Contents