inferno.trainers.callbacks package

Subpackages

• inferno.trainers.callbacks.logging package
  • Submodules
  • inferno.trainers.callbacks.logging.base module
  • inferno.trainers.callbacks.logging.tensorboard module
  • Module contents

Submodules

inferno.trainers.callbacks.base module

class inferno.trainers.callbacks.base.Callback

Bases: object

Recommended (but not required) base class for callbacks.

bind_trainer(trainer)

debug_print(message)

get_config()

classmethod get_instances()

classmethod register_instance(instance)

set_config(config_dict)

toggle_debug()

trainer

unbind_trainer()

class inferno.trainers.callbacks.base.CallbackEngine

Bases: object

Gathers and manages callbacks.

Callbacks are callables which are to be called by trainers when certain events (‘triggers’) occur. They could be any callable object, but if endowed with a bind_trainer method, it’s called when the callback is registered. It is recommended that callbacks (or their __call__ methods) use the double-star syntax for keyword arguments.

BEGIN_OF_EPOCH = 'begin_of_epoch'

BEGIN_OF_FIT = 'begin_of_fit'

BEGIN_OF_SAVE = 'begin_of_save'

BEGIN_OF_TRAINING_ITERATION = 'begin_of_training_iteration'

BEGIN_OF_TRAINING_RUN = 'begin_of_training_run'

BEGIN_OF_VALIDATION_ITERATION = 'begin_of_validation_iteration'

BEGIN_OF_VALIDATION_RUN = 'begin_of_validation_run'

END_OF_EPOCH = 'end_of_epoch'

END_OF_FIT = 'end_of_fit'

END_OF_SAVE = 'end_of_save'

END_OF_TRAINING_ITERATION = 'end_of_training_iteration'

END_OF_TRAINING_RUN = 'end_of_training_run'

END_OF_VALIDATION_ITERATION = 'end_of_validation_iteration'

END_OF_VALIDATION_RUN = 'end_of_validation_run'

TRIGGERS = {'begin_of_validation_run', 'end_of_epoch', 'end_of_validation_iteration', 'begin_of_save', 'end_of_training_iteration', 'end_of_save', 'begin_of_fit', 'end_of_validation_run', 'begin_of_validation_iteration', 'begin_of_training_iteration', 'begin_of_training_run', 'begin_of_epoch', 'end_of_fit', 'end_of_training_run'}

bind_trainer(trainer)

call(trigger, **kwargs)

get_config()

rebind_trainer_to_all_callbacks()

register_callback(callback, trigger='auto', bind_trainer=True)

register_new_trigger(trigger_name)

set_config(config_dict)

trainer_is_bound

unbind_trainer()

inferno.trainers.callbacks.console module

class inferno.trainers.callbacks.console.Console(printer=<inferno.trainers.callbacks.console.StdoutPrinter object>)

Bases: object

LEVEL_DEBUG = 4

LEVEL_INFO = 1

LEVEL_PROGRESS = 2

LEVEL_WARNING = 3

debug(message)

info(message)

print(message)

progress(message)

set_console(console)

toggle_info(state)

toggle_progress(state)

toggle_warning(state)

warning(message)

class inferno.trainers.callbacks.console.StdoutPrinter

Bases: object

print(message)

inferno.trainers.callbacks.essentials module

class inferno.trainers.callbacks.essentials.DumpHDF5Every(frequency, to_directory, filename_template='dump.{mode}.epoch{epoch_count}.iteration{iteration_count}.h5', force_dump=False, dump_after_every_validation_run=False)

Bases: inferno.trainers.callbacks.base.Callback

Dumps intermediate training states to a HDF5 file.

add_to_dump_cache(key, value)

clear_dump_cache()

dump(mode)

dump_every

dump_now

dump_state(key, dump_while='training')

dump_states(keys, dump_while='training')

end_of_training_iteration(**_)

end_of_validation_run(**_)

get_file_path(mode)

class inferno.trainers.callbacks.essentials.NaNDetector

Bases: inferno.trainers.callbacks.base.Callback

end_of_training_iteration(**_)

class inferno.trainers.callbacks.essentials.ParameterEMA(momentum)

Bases: inferno.trainers.callbacks.base.Callback

Maintain a moving average of network parameters.

apply()

end_of_training_iteration(**_)

maintain()

class inferno.trainers.callbacks.essentials.PersistentSave(template='checkpoint.pytorch.epoch{epoch_count}.iteration{iteration_count}')

Bases: inferno.trainers.callbacks.base.Callback

begin_of_save(**kwargs)

end_of_save(save_to_directory, **_)

class inferno.trainers.callbacks.essentials.SaveAtBestValidationScore(smoothness=0, verbose=False)

Bases: inferno.trainers.callbacks.base.Callback

Triggers a save at the best EMA (exponential moving average) validation score. The basic Trainer has built in support for saving at the best validation score, but this callback might eventually replace that functionality.

end_of_validation_run(**_)

inferno.trainers.callbacks.scheduling module

class inferno.trainers.callbacks.scheduling.AutoLR(factor, patience, required_minimum_relative_improvement=0, consider_improvement_with_respect_to='best', cooldown_duration=None, monitor='auto', monitor_momentum=0, monitor_while='auto', exclude_param_groups=None, verbose=False)

Bases: inferno.trainers.callbacks.scheduling._Scheduler

Callback to decay or hike the learning rate automatically when a specified monitor stops improving.

The monitor should be decreasing, i.e. lower value –> better performance.

cooldown_duration

decay()

duration_since_last_decay

duration_since_last_improvment

end_of_training_iteration(**_)

end_of_validation_run(**_)

in_cooldown

static is_significantly_less_than(x, y, min_relative_delta)

maintain_monitor_moving_average()

monitor_value_has_significantly_improved

out_of_patience

patience

class inferno.trainers.callbacks.scheduling.AutoLRDecay(factor, patience, required_minimum_relative_improvement=0, consider_improvement_with_respect_to='best', cooldown_duration=None, monitor='auto', monitor_momentum=0, monitor_while='auto', exclude_param_groups=None, verbose=False)

Bases: inferno.trainers.callbacks.scheduling.AutoLR

Callback to decay the learning rate automatically when a specified monitor stops improving.

The monitor should be decreasing, i.e. lower value –> better performance.

class inferno.trainers.callbacks.scheduling.DecaySpec(duration, factor)

Bases: object

A class to specify when to decay (or hike) LR and by what factor.

classmethod build_from(args)

match(iteration_count=None, epoch_count=None, when_equal_return=True)

new()

class inferno.trainers.callbacks.scheduling.ManualLR(decay_specs, exclude_param_groups=None)

Bases: inferno.trainers.callbacks.base.Callback

decay(factor)

end_of_training_iteration(**_)

match()

inferno.trainers.callbacks.tqdm module

class inferno.trainers.callbacks.tqdm.TQDMConsole

Bases: inferno.trainers.callbacks.console.Console

class inferno.trainers.callbacks.tqdm.TQDMPrinter(progress)

Bases: object

print(message)

class inferno.trainers.callbacks.tqdm.TQDMProgressBar(*args, **kwargs)

Bases: inferno.trainers.callbacks.base.Callback

begin_of_epoch(**_)

begin_of_fit(max_num_epochs, **_)

begin_of_training_iteration(**_)

begin_of_training_run(**_)

begin_of_validation_iteration(**_)

begin_of_validation_run(num_iterations, num_iterations_in_generator, last_validated_at_epoch, **_)

bind_trainer(*args, **kwargs)

end_of_epoch(**_)

end_of_fit(**_)

end_of_training_run(**_)

end_of_validation_run(**_)

print(message, **_)

inferno.trainers.callbacks.tqdmstub module

class inferno.trainers.callbacks.tqdmstub.TQDMProgressBar(*args, **kwargs)

Bases: inferno.trainers.callbacks.base.Callback

begin_of_fit(**_)

bind_trainer(*args, **kwargs)

Module contents

class inferno.trainers.callbacks.CallbackEngine

Bases: object

Gathers and manages callbacks.

Callbacks are callables which are to be called by trainers when certain events (‘triggers’) occur. They could be any callable object, but if endowed with a bind_trainer method, it’s called when the callback is registered. It is recommended that callbacks (or their __call__ methods) use the double-star syntax for keyword arguments.

BEGIN_OF_EPOCH = 'begin_of_epoch'

BEGIN_OF_FIT = 'begin_of_fit'

BEGIN_OF_SAVE = 'begin_of_save'

BEGIN_OF_TRAINING_ITERATION = 'begin_of_training_iteration'

BEGIN_OF_TRAINING_RUN = 'begin_of_training_run'

BEGIN_OF_VALIDATION_ITERATION = 'begin_of_validation_iteration'

BEGIN_OF_VALIDATION_RUN = 'begin_of_validation_run'

END_OF_EPOCH = 'end_of_epoch'

END_OF_FIT = 'end_of_fit'

END_OF_SAVE = 'end_of_save'

END_OF_TRAINING_ITERATION = 'end_of_training_iteration'

END_OF_TRAINING_RUN = 'end_of_training_run'

END_OF_VALIDATION_ITERATION = 'end_of_validation_iteration'

END_OF_VALIDATION_RUN = 'end_of_validation_run'

TRIGGERS = {'begin_of_validation_run', 'end_of_epoch', 'end_of_validation_iteration', 'begin_of_save', 'end_of_training_iteration', 'end_of_save', 'begin_of_fit', 'end_of_validation_run', 'begin_of_validation_iteration', 'begin_of_training_iteration', 'begin_of_training_run', 'begin_of_epoch', 'end_of_fit', 'end_of_training_run'}

bind_trainer(trainer)

call(trigger, **kwargs)

get_config()

rebind_trainer_to_all_callbacks()

register_callback(callback, trigger='auto', bind_trainer=True)

register_new_trigger(trigger_name)

set_config(config_dict)

trainer_is_bound

unbind_trainer()

class inferno.trainers.callbacks.Callback

Bases: object

Recommended (but not required) base class for callbacks.

bind_trainer(trainer)

debug_print(message)

get_config()

classmethod get_instances()

classmethod register_instance(instance)

set_config(config_dict)

toggle_debug()

trainer

unbind_trainer()

class inferno.trainers.callbacks.Console(printer=<inferno.trainers.callbacks.console.StdoutPrinter object>)

Bases: object

LEVEL_DEBUG = 4

LEVEL_INFO = 1

LEVEL_PROGRESS = 2

LEVEL_WARNING = 3

debug(message)

info(message)

print(message)

progress(message)

set_console(console)

toggle_info(state)

toggle_progress(state)

toggle_warning(state)

warning(message)

class inferno.trainers.callbacks.TQDMProgressBar(*args, **kwargs)

Bases: inferno.trainers.callbacks.base.Callback

begin_of_epoch(**_)

begin_of_fit(max_num_epochs, **_)

begin_of_training_iteration(**_)

begin_of_training_run(**_)

begin_of_validation_iteration(**_)

begin_of_validation_run(num_iterations, num_iterations_in_generator, last_validated_at_epoch, **_)

bind_trainer(*args, **kwargs)

end_of_epoch(**_)

end_of_fit(**_)

end_of_training_run(**_)

end_of_validation_run(**_)

print(message, **_)