logger_hparams_registry#

Logger Hyperparameter classes.

composer.loggers.logger_hparams_registry.logger_registry#

The registry of all known LoggerDestinationHparams.

Type

Dict[str, Type[LoggerDestinationHparams]]

Hparams

These classes are used with yahp for YAML-based configuration.

ObjectStoreLoggerHparams

Hyperparameters for the ObjectStoreLogger.

Attributes

class composer.loggers.logger_hparams_registry.ObjectStoreLoggerHparams(object_store_hparams, should_log_artifact=None, object_name='{artifact_name}', num_concurrent_uploads=4, use_procs=True, upload_staging_folder=None, num_attempts=3)[source]#

Bases: yahp.hparams.Hparams

Hyperparameters for the ObjectStoreLogger.

Parameters

  • object_store_hparams (ObjectStoreHparams) โ€“ The object store provider hparams.

  • should_log_artifact (str, optional) โ€“

    The path to a filter function which returns whether an artifact should be logged. The path should be of the format path.to.module:filter_function_name.

    The function should take (State, LogLevel, <artifact name>). The artifact name will be a string. The function should return a boolean indicating whether the artifact should be logged.

    Setting this parameter to None (the default) will log all artifacts.

  • object_name (str, optional) โ€“ See ObjectStoreLogger.

  • num_concurrent_uploads (int, optional) โ€“ See ObjectStoreLogger.

  • upload_staging_folder (str, optional) โ€“ See ObjectStoreLogger.

  • use_procs (bool, optional) โ€“ See ObjectStoreLogger.