Callback¶
-
class
pytorch_lightning.callbacks.
Callback
[source]¶ 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)[source]¶ Called after
loss.backward()
and before optimizers do anything.- Return type
-
on_before_accelerator_backend_setup
(trainer, pl_module)[source]¶ Called before accelerator is being setup
- Return type
-
on_before_zero_grad
(trainer, pl_module, optimizer)[source]¶ Called after
optimizer.step()
and beforeoptimizer.zero_grad()
.- Return type
-
on_epoch_end
(trainer, pl_module)[source]¶ Called when either of train/val/test epoch ends.
- Return type
-
on_epoch_start
(trainer, pl_module)[source]¶ Called when either of train/val/test epoch begins.
- Return type
-
on_init_end
(trainer)[source]¶ Called when the trainer initialization ends, model has not yet been set.
- Return type
-
on_init_start
(trainer)[source]¶ Called when the trainer initialization begins, model has not yet been set.
- Return type
-
on_keyboard_interrupt
(trainer, pl_module)[source]¶ Called when the training is interrupted by
KeyboardInterrupt
.- Return type
-
on_load_checkpoint
(callback_state)[source]¶ Called when loading a model checkpoint, use to reload state.
-
on_pretrain_routine_end
(trainer, pl_module)[source]¶ Called when the pretrain routine ends.
- Return type
-
on_pretrain_routine_start
(trainer, pl_module)[source]¶ Called when the pretrain routine begins.
- Return type
-
on_sanity_check_end
(trainer, pl_module)[source]¶ Called when the validation sanity check ends.
- Return type
-
on_sanity_check_start
(trainer, pl_module)[source]¶ Called when the validation sanity check starts.
- Return type
-
on_save_checkpoint
(trainer, pl_module, checkpoint)[source]¶ Called when saving a model checkpoint, use to persist state.
-
on_test_batch_end
(trainer, pl_module, outputs, batch, batch_idx, dataloader_idx)[source]¶ Called when the test batch ends.
- Return type
-
on_test_batch_start
(trainer, pl_module, batch, batch_idx, dataloader_idx)[source]¶ Called when the test batch begins.
- Return type
-
on_train_batch_end
(trainer, pl_module, outputs, batch, batch_idx, dataloader_idx)[source]¶ Called when the train batch ends.
- Return type
-
on_train_batch_start
(trainer, pl_module, batch, batch_idx, dataloader_idx)[source]¶ Called when the train batch begins.
- Return type
-
on_train_epoch_end
(trainer, pl_module, outputs)[source]¶ Called when the train epoch ends.
- Return type
-
on_validation_batch_end
(trainer, pl_module, outputs, batch, batch_idx, dataloader_idx)[source]¶ Called when the validation batch ends.
- Return type
-
on_validation_batch_start
(trainer, pl_module, batch, batch_idx, dataloader_idx)[source]¶ Called when the validation batch begins.
- Return type
-
on_validation_epoch_start
(trainer, pl_module)[source]¶ Called when the val epoch begins.
- Return type
-