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.
`SpeedMonitorHparams`	`SpeedMonitor` hyperparameters.

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

Bases: yahp.hparams.Hparams, abc.ABC

Base class for Callback hyperparameters.

abstract initialize_object()[source]#

Initialize the callback.

Returns: Callback – An instance of the callback.

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

Bases: composer.callbacks.callback_hparams.CallbackHparams

CheckpointSaver hyperparameters.

Parameters

save_folder (str, optional) – See CheckpointSaver.
filename (str, optional) – See CheckpointSaver.
artifact_name (str, optional) – See CheckpointSaver.
latest_filename (str, optional) – See CheckpointSaver.
overwrite (str, optional) – See CheckpointSaver.
weights_only (bool, optional) – See CheckpointSaver.
num_checkpoints_to_keep (int, 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.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.