pytorch_lightning.callbacks.base module
Subclass this class and override any of the relevant hooks
-
class
pytorch_lightning.callbacks.base.
Callback
[source]
Bases: abc.ABC
Abstract base class used to build new callbacks.
-
on_batch_end
(trainer, pl_module)[source]
Called when the training batch ends.
-
on_batch_start
(trainer, pl_module)[source]
Called when the training batch begins.
-
on_epoch_end
(trainer, pl_module)[source]
Called when the epoch ends.
-
on_epoch_start
(trainer, pl_module)[source]
Called when the epoch begins.
-
on_fit_end
(trainer, pl_module)[source]
Called when fit ends
-
on_fit_start
(trainer, pl_module)[source]
Called when fit begins
-
on_init_end
(trainer)[source]
Called when the trainer initialization ends, model has not yet been set.
-
on_init_start
(trainer)[source]
Called when the trainer initialization begins, model has not yet been set.
-
on_keyboard_interrupt
(trainer, pl_module)[source]
Called when the training is interrupted by KeyboardInterrupt.
-
on_pretrain_routine_end
(trainer, pl_module)[source]
Called when the pretrain routine ends.
-
on_pretrain_routine_start
(trainer, pl_module)[source]
Called when the pretrain routine begins.
-
on_sanity_check_end
(trainer, pl_module)[source]
Called when the validation sanity check ends.
-
on_sanity_check_start
(trainer, pl_module)[source]
Called when the validation sanity check starts.
-
on_test_batch_end
(trainer, pl_module, batch, batch_idx, dataloader_idx)[source]
Called when the test batch ends.
-
on_test_batch_start
(trainer, pl_module, batch, batch_idx, dataloader_idx)[source]
Called when the test batch begins.
-
on_test_end
(trainer, pl_module)[source]
Called when the test ends.
-
on_test_epoch_end
(trainer, pl_module)[source]
Called when the test epoch ends.
-
on_test_epoch_start
(trainer, pl_module)[source]
Called when the test epoch begins.
-
on_test_start
(trainer, pl_module)[source]
Called when the test begins.
-
on_train_batch_end
(trainer, pl_module, batch, batch_idx, dataloader_idx)[source]
Called when the train batch ends.
-
on_train_batch_start
(trainer, pl_module, batch, batch_idx, dataloader_idx)[source]
Called when the train batch begins.
-
on_train_end
(trainer, pl_module)[source]
Called when the train ends.
-
on_train_epoch_end
(trainer, pl_module)[source]
Called when the train epoch ends.
-
on_train_epoch_start
(trainer, pl_module)[source]
Called when the train epoch begins.
-
on_train_start
(trainer, pl_module)[source]
Called when the train begins.
-
on_validation_batch_end
(trainer, pl_module, batch, batch_idx, dataloader_idx)[source]
Called when the validation batch ends.
-
on_validation_batch_start
(trainer, pl_module, batch, batch_idx, dataloader_idx)[source]
Called when the validation batch begins.
-
on_validation_end
(trainer, pl_module)[source]
Called when the validation loop ends.
-
on_validation_epoch_end
(trainer, pl_module)[source]
Called when the val epoch ends.
-
on_validation_epoch_start
(trainer, pl_module)[source]
Called when the val epoch begins.
-
on_validation_start
(trainer, pl_module)[source]
Called when the validation loop begins.
-
setup
(trainer, pl_module, stage)[source]
Called when fit or test begins
-
teardown
(trainer, pl_module, stage)[source]
Called when fit or test ends