base

Classes

Callback

Abstract base class used to build new callbacks.

Abstract base class used to build new callbacks.

class pytorch_lightning.callbacks.base.Callback

Bases: abc.ABC

Abstract base class used to build new callbacks.

Subclass this class and override any of the relevant hooks

on_after_backward(trainer, pl_module)

Called after loss.backward() and before optimizers do anything.

on_batch_end(trainer, pl_module)

Called when the training batch ends.

on_batch_start(trainer, pl_module)

Called when the training batch begins.

on_before_zero_grad(trainer, pl_module, optimizer)

Called after optimizer.step() and before optimizer.zero_grad().

on_epoch_end(trainer, pl_module)

Called when the epoch ends.

on_epoch_start(trainer, pl_module)

Called when the epoch begins.

on_fit_end(trainer, pl_module)

Called when fit ends

on_fit_start(trainer, pl_module)

Called when fit begins

on_init_end(trainer)

Called when the trainer initialization ends, model has not yet been set.

on_init_start(trainer)

Called when the trainer initialization begins, model has not yet been set.

on_keyboard_interrupt(trainer, pl_module)

Called when the training is interrupted by KeyboardInterrupt.

on_load_checkpoint(checkpointed_state)

Called when loading a model checkpoint, use to reload state.

on_pretrain_routine_end(trainer, pl_module)

Called when the pretrain routine ends.

on_pretrain_routine_start(trainer, pl_module)

Called when the pretrain routine begins.

on_sanity_check_end(trainer, pl_module)

Called when the validation sanity check ends.

on_sanity_check_start(trainer, pl_module)

Called when the validation sanity check starts.

on_save_checkpoint(trainer, pl_module)

Called when saving a model checkpoint, use to persist state.

on_test_batch_end(trainer, pl_module, outputs, batch, batch_idx, dataloader_idx)

Called when the test batch ends.

on_test_batch_start(trainer, pl_module, batch, batch_idx, dataloader_idx)

Called when the test batch begins.

on_test_end(trainer, pl_module)

Called when the test ends.

on_test_epoch_end(trainer, pl_module)

Called when the test epoch ends.

on_test_epoch_start(trainer, pl_module)

Called when the test epoch begins.

on_test_start(trainer, pl_module)

Called when the test begins.

on_train_batch_end(trainer, pl_module, outputs, batch, batch_idx, dataloader_idx)

Called when the train batch ends.

on_train_batch_start(trainer, pl_module, batch, batch_idx, dataloader_idx)

Called when the train batch begins.

on_train_end(trainer, pl_module)

Called when the train ends.

on_train_epoch_end(trainer, pl_module, outputs)

Called when the train epoch ends.

on_train_epoch_start(trainer, pl_module)

Called when the train epoch begins.

on_train_start(trainer, pl_module)

Called when the train begins.

on_validation_batch_end(trainer, pl_module, outputs, batch, batch_idx, dataloader_idx)

Called when the validation batch ends.

on_validation_batch_start(trainer, pl_module, batch, batch_idx, dataloader_idx)

Called when the validation batch begins.

on_validation_end(trainer, pl_module)

Called when the validation loop ends.

on_validation_epoch_end(trainer, pl_module)

Called when the val epoch ends.

on_validation_epoch_start(trainer, pl_module)

Called when the val epoch begins.

on_validation_start(trainer, pl_module)

Called when the validation loop begins.

setup(trainer, pl_module, stage)

Called when fit or test begins

teardown(trainer, pl_module, stage)

Called when fit or test ends