131 lines
3.5 KiB
Python
131 lines
3.5 KiB
Python
r"""
|
|
Callback Base
|
|
-------------
|
|
|
|
Abstract base class used to build new callbacks.
|
|
|
|
"""
|
|
|
|
import abc
|
|
|
|
|
|
class Callback(abc.ABC):
|
|
r"""
|
|
Abstract base class used to build new callbacks.
|
|
"""
|
|
|
|
def setup(self, trainer, stage: str):
|
|
"""Called when fit or test begins"""
|
|
pass
|
|
|
|
def teardown(self, trainer, stage: str):
|
|
"""Called when fit or test ends"""
|
|
pass
|
|
|
|
def on_init_start(self, trainer):
|
|
"""Called when the trainer initialization begins, model has not yet been set."""
|
|
pass
|
|
|
|
def on_init_end(self, trainer):
|
|
"""Called when the trainer initialization ends, model has not yet been set."""
|
|
pass
|
|
|
|
def on_fit_start(self, trainer):
|
|
"""Called when fit begins"""
|
|
pass
|
|
|
|
def on_fit_end(self, trainer):
|
|
"""Called when fit ends"""
|
|
pass
|
|
|
|
def on_sanity_check_start(self, trainer, pl_module):
|
|
"""Called when the validation sanity check starts."""
|
|
pass
|
|
|
|
def on_sanity_check_end(self, trainer, pl_module):
|
|
"""Called when the validation sanity check ends."""
|
|
pass
|
|
|
|
def on_train_epoch_start(self, trainer, pl_module):
|
|
"""Called when the train epoch begins."""
|
|
pass
|
|
|
|
def on_train_epoch_end(self, trainer, pl_module):
|
|
"""Called when the train epoch ends."""
|
|
pass
|
|
|
|
def on_validation_epoch_start(self, trainer, pl_module):
|
|
"""Called when the val epoch begins."""
|
|
pass
|
|
|
|
def on_validation_epoch_end(self, trainer, pl_module):
|
|
"""Called when the val epoch ends."""
|
|
pass
|
|
|
|
def on_test_epoch_start(self, trainer, pl_module):
|
|
"""Called when the test epoch begins."""
|
|
pass
|
|
|
|
def on_test_epoch_end(self, trainer, pl_module):
|
|
"""Called when the test epoch 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_validation_batch_start(self, trainer, pl_module):
|
|
"""Called when the validation batch begins."""
|
|
pass
|
|
|
|
def on_validation_batch_end(self, trainer, pl_module):
|
|
"""Called when the validation batch ends."""
|
|
pass
|
|
|
|
def on_test_batch_start(self, trainer, pl_module):
|
|
"""Called when the test batch begins."""
|
|
pass
|
|
|
|
def on_test_batch_end(self, trainer, pl_module):
|
|
"""Called when the test batch ends."""
|
|
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
|
|
|
|
def on_keyboard_interrupt(self, trainer, pl_module):
|
|
"""Called when the training is interrupted by KeyboardInterrupt."""
|