Files
pytorch-lightning/pytorch_lightning/callbacks/base.py
T
William Falcon ad80a7d638 clean docs (#967)
* clean docs

* clean docs

* clean docs
2020-02-27 17:21:51 -05:00

69 lines
1.7 KiB
Python

"""
Callbacks
=========
Callbacks supported by Lightning
"""
import abc
class Callback(abc.ABC):
"""Abstract base class used to build new callbacks."""
def on_init_start(self, trainer):
"""Called when the trainer initialization begins."""
pass
def on_init_end(self, trainer):
"""Called when the trainer initialization ends."""
pass
def on_fit_start(self, trainer, pl_module):
"""Called when the fit begins."""
pass
def on_fit_end(self, trainer, pl_module):
"""Called when the fit ends."""
pass
def on_epoch_start(self, trainer, pl_module):
"""Called when the epoch begins."""
pass
def on_epoch_end(self, trainer, pl_module):
"""Called when the epoch ends."""
pass
def on_batch_start(self, trainer, pl_module):
"""Called when the training batch begins."""
pass
def on_batch_end(self, trainer, pl_module):
"""Called when the training batch ends."""
pass
def on_train_start(self, trainer, pl_module):
"""Called when the train begins."""
pass
def on_train_end(self, trainer, pl_module):
"""Called when the train ends."""
pass
def on_validation_start(self, trainer, pl_module):
"""Called when the validation loop begins."""
pass
def on_validation_end(self, trainer, pl_module):
"""Called when the validation loop ends."""
pass
def on_test_start(self, trainer, pl_module):
"""Called when the test begins."""
pass
def on_test_end(self, trainer, pl_module):
"""Called when the test ends."""
pass