From d41ffafa87f87e122177ac2c2763a4f1a2b6f8a8 Mon Sep 17 00:00:00 2001 From: Jeff Yang Date: Sat, 10 Oct 2020 02:30:03 +0630 Subject: [PATCH] add on_train_batch_start/end, chpt hooks in hooks docs (#4023) --- docs/source/hooks.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/hooks.rst b/docs/source/hooks.rst index c5b18b4337..f19b56309f 100644 --- a/docs/source/hooks.rst +++ b/docs/source/hooks.rst @@ -40,6 +40,7 @@ Training loop ^^^^^^^^^^^^^ - :meth:`~pytorch_lightning.core.hooks.ModelHooks.on_epoch_start` +- :meth:`~pytorch_lightning.core.hooks.ModelHooks.on_train_batch_start` - :meth:`~pytorch_lightning.core.lightning.LightningModule.tbptt_split_batch` - :meth:`~pytorch_lightning.core.lightning.LightningModule.training_step` - :meth:`~pytorch_lightning.core.lightning.LightningModule.training_step_end` (optional) @@ -47,6 +48,7 @@ Training loop - :meth:`~pytorch_lightning.core.hooks.ModelHooks.backward` - :meth:`~pytorch_lightning.core.hooks.ModelHooks.on_after_backward` - ``optimizer.step()`` +- :meth:`~pytorch_lightning.core.hooks.ModelHooks.on_train_batch_end` - :meth:`~pytorch_lightning.core.lightning.LightningModule.training_epoch_end` - :meth:`~pytorch_lightning.core.hooks.ModelHooks.on_epoch_end` @@ -90,3 +92,6 @@ General hooks .. autoclass:: pytorch_lightning.core.hooks.DataHooks :noindex: + +.. autoclass:: pytorch_lightning.core.hooks.CheckpointHooks + :noindex: