composer.callbacks.callback_hparams#

Hyperparameters for callbacks.

Hparams

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

`CallbackHparams`	Base class for callback hyperparameters.
`CheckpointSaverHparams`	`CheckpointSaver` hyperparameters.
`GradMonitorHparams`	`GradMonitor` hyperparamters.
`LRMonitorHparams`	`LRMonitor` hyperparameters.
`MemoryMonitorHparams`	`MemoryMonitor` hyperparameters.
`RunDirectoryUploaderHparams`	`RunDirectoryUploader` hyperparameters.
`SpeedMonitorHparams`	`SpeedMonitor` hyperparameters.

class composer.callbacks.callback_hparams.CallbackHparams[source]#

Bases: yahp.hparams.Hparams, abc.ABC

Base class for callback hyperparameters.

Callback parameters that are added to the callbacks argument of TrainerHparams (e.g., via YAML or the CLI). See Trainer with YAHP for more details. These are initialized in the training loop.

abstract initialize_object()[source]#

Initialize the callback.

Returns: Callback – An instance of the callback.

class composer.callbacks.callback_hparams.CheckpointSaverHparams(save_folder='checkpoints', name_format='ep{epoch}-ba{batch}/rank_{rank}', save_latest_format='latest/rank_{rank}', overwrite=False, weights_only=False, save_interval='1ep')[source]#

Bases: composer.callbacks.callback_hparams.CallbackHparams

CheckpointSaver hyperparameters.

Parameters

save_folder (str, optional) – See CheckpointSaver.
name_format (str, optional) – See CheckpointSaver.
save_latest_format (str, optional) – See CheckpointSaver.
overwrite (str, optional) – See CheckpointSaver.
weights_only (bool, optional) – See CheckpointSaver.
save_interval (str, optional) –
Either a time-string or a path to a function.

If a time-string, checkpoints will be saved according to this interval.

If a path to a function, it should be of the format 'path.to.function:function_name'. The function should take (State, Event) and return a boolean indicating whether a checkpoint should be saved given the current state and event. The event will be either BATCH_CHECKPOINT or EPOCH_CHECKPOINT.

class composer.callbacks.callback_hparams.GradMonitorHparams(log_layer_grad_norms=False)[source]#

Bases: composer.callbacks.callback_hparams.CallbackHparams

GradMonitor hyperparamters.

Parameters: log_layer_grad_norms (bool, optional) – See GradMonitor for documentation.

initialize_object()[source]#

Initialize the GradMonitor callback.

Returns: GradMonitor – An instance of GradMonitor.

class composer.callbacks.callback_hparams.LRMonitorHparams[source]#

Bases: composer.callbacks.callback_hparams.CallbackHparams

LRMonitor hyperparameters.

There are no parameters as LRMonitor does not take any parameters.

initialize_object()[source]#

Initialize the LRMonitor callback.

Returns: LRMonitor – An instance of LRMonitor.

class composer.callbacks.callback_hparams.MemoryMonitorHparams[source]#

Bases: composer.callbacks.callback_hparams.CallbackHparams

MemoryMonitor hyperparameters.

There are no parameters as MemoryMonitor does not take any parameters.

initialize_object()[source]#

Initialize the MemoryMonitor callback.

Returns: MemoryMonitor – An instance of MemoryMonitor.

class composer.callbacks.callback_hparams.RunDirectoryUploaderHparams(provider, container, key_environ=None, secret_environ=None, region=None, host=None, port=None, extra_init_kwargs=<factory>, object_name_prefix=None, num_concurrent_uploads=4, use_procs=True, upload_staging_folder=None, upload_every_n_batches=100)[source]#

Bases: composer.callbacks.callback_hparams.CallbackHparams, composer.utils.object_store.ObjectStoreProviderHparams

RunDirectoryUploader hyperparameters.

Parameters

provider (str) – See ObjectStoreProviderHparams for documentation.
container (str) – See ObjectStoreProviderHparams for documentation.
key_environ (str, optional) – See ObjectStoreProviderHparams for documentation.
secret_environ (str, optional) – See ObjectStoreProviderHparams for documentation.
region (str, optional) – See ObjectStoreProviderHparams for documentation.
host (str, optional) – See ObjectStoreProviderHparams for documentation.
port (int, optional) – See ObjectStoreProviderHparams for documentation.
extra_init_kwargs (Dict[str, Any], optional) – Extra keyword arguments to pass into the constructor See ObjectStoreProviderHparams for documentation.
object_name_prefix (str, optional) – See RunDirectoryUploader for documentation.
num_concurrent_uploads (int, optional) – See RunDirectoryUploader for documentation.
upload_staging_folder (str, optional) – See RunDirectoryUploader for documentation.
use_procs (bool, optional) – See RunDirectoryUploader for documentation.
upload_every_n_batches (int, optional) – See RunDirectoryUploader for documentation.

initialize_object()[source]#

Initialize the RunDirectoryUploader callback.

Returns: RunDirectoryUploader – An instance of RunDirectoryUploader.

class composer.callbacks.callback_hparams.SpeedMonitorHparams(window_size=100)[source]#

Bases: composer.callbacks.callback_hparams.CallbackHparams

SpeedMonitor hyperparameters.

Parameters: window_size (int, optional) – See SpeedMonitor for documentation.

initialize_object()[source]#

Initialize the SpeedMonitor callback.

Returns: SpeedMonitor – An instance of SpeedMonitor.