composer.loggers.logger_hparams#
Logger Hyperparameter classes.
Hparams
These classes are used with yahp
for YAML
-based configuration.
|
|
|
|
Base class for logger callback hyperparameters. |
|
|
|
|
|
|
Attributes
- class composer.loggers.logger_hparams.FileLoggerHparams(log_level=LogLevel.EPOCH, filename='{run_name}/logs-rank{rank}.txt', artifact_name=None, capture_stdout=True, capture_stderr=True, buffer_size=1, flush_interval=100, log_interval=1)[source]#
Bases:
composer.loggers.logger_hparams.LoggerDestinationHparams
FileLogger
hyperparameters.See
FileLogger
for documentation.- Parameters
filename (str, optional) โ See
FileLogger
.artifact_name (str, optional) โ See
FileLogger
.capture_stdout (bool, optional) โ See
FileLogger
.capture_stderr (bool, optional) โ See
FileLogger
.buffer_size (int, optional) โ See
FileLogger
.log_level (LogLevel, optional) โ See
FileLogger
.log_interval (int, optional) โ See
FileLogger
.flush_interval (int, optional) โ See
FileLogger
.
- class composer.loggers.logger_hparams.InMemoryLoggerHparams(log_level=LogLevel.BATCH)[source]#
Bases:
composer.loggers.logger_hparams.LoggerDestinationHparams
InMemoryLogger
hyperparameters.- Parameters
log_level (str or LogLevel, optional) โ See
InMemoryLogger
.
- class composer.loggers.logger_hparams.LoggerDestinationHparams[source]#
Bases:
yahp.hparams.Hparams
,abc.ABC
Base class for logger callback hyperparameters.
Logger parameters that are added to
TrainerHparams
(e.g. via YAML or the CLI) are initialized in the training loop.
- class composer.loggers.logger_hparams.ObjectStoreLoggerHparams(object_store_hparams, should_log_artifact=None, object_name='{artifact_name}', config_artifact_name='{run_name}/config.yaml', num_concurrent_uploads=4, use_procs=True, upload_staging_folder=None)[source]#
Bases:
composer.loggers.logger_hparams.LoggerDestinationHparams
InMemoryLogger
hyperparameters.- 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
.config_artifact_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
.
- class composer.loggers.logger_hparams.ProgressBarLoggerHparams(progress_bar=True, log_to_console=None, console_log_level=LogLevel.EPOCH, stream='stderr')[source]#
Bases:
composer.loggers.logger_hparams.LoggerDestinationHparams
ProgressBarLogger
hyperparameters.Deprecated since version 0.6.0: This class is deprecated. Instead, please specify the
ProgressBarLogger
arguments directly in theTrainerHparams
. This class will be removed in v0.7.0.- Parameters
progress_bar (bool, optional) โ See
ProgressBarLogger
.log_to_console (bool, optional) โ See
ProgressBarLogger
.console_log_level (bool, optional) โ See
ProgressBarLogger
.stream (bool, optional) โ See
ProgressBarLogger
.
- class composer.loggers.logger_hparams.WandBLoggerHparams(project=None, group=None, name=None, entity=None, tags=None, log_artifacts=False, rank_zero_only=True, extra_init_params=<factory>, config=<factory>, flatten_config=False)[source]#
Bases:
composer.loggers.logger_hparams.LoggerDestinationHparams
WandBLogger
hyperparameters.- Parameters
project (str, optional) โ WandB project name.
group (str, optional) โ WandB group name.
name (str, optional) โ WandB run name. If not specified, the
Logger.run_name
will be used.entity (str, optional) โ WandB entity name.
tags (str, optional) โ WandB tags, comma-separated.
config (Dict[str, Any], optional) โ WandB run configuration.
flatten_config (bool, optional) โ Whether to flatten the run config. (default:
False
)log_artifacts (bool, optional) โ See
WandBLogger
.rank_zero_only (bool, optional) โ See
WandBLogger
.extra_init_params (dict, optional) โ See
WandBLogger
.
- composer.loggers.logger_hparams.logger_registry = {'file': <class 'composer.loggers.logger_hparams.FileLoggerHparams'>, 'in_memory': <class 'composer.loggers.logger_hparams.InMemoryLoggerHparams'>, 'object_store': <class 'composer.loggers.logger_hparams.ObjectStoreLoggerHparams'>, 'progress_bar': <class 'composer.loggers.logger_hparams.ProgressBarLoggerHparams'>, 'wandb': <class 'composer.loggers.logger_hparams.WandBLoggerHparams'>}#
The registry of all known
LoggerDestinationHparams
.