mirror of
https://github.com/wassname/pytorch-lightning.git
synced 2026-09-21 13:20:08 +08:00
Adrian WälchliandJirka Borovec
1f2da71069
* improved docs for callbacks * class references * make doctest pass * doctests * fix lines too long * fix line too long * fix permission error in doctest * Apply suggestions from code review Co-Authored-By: Jirka Borovec <Borda@users.noreply.github.com> * fix doctest * fix default Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
64 lines
1.5 KiB
Python
64 lines
1.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 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_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
|