Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add on_train_batch_start/end, chpt hooks in hooks docs (#4023)

This commit is contained in:
Jeff Yang 2020-10-10 02:30:03 +06:30 committed by GitHub
parent 7e756ca11f
commit d41ffafa87
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/source/hooks.rst
View File

@ -40,6 +40,7 @@ Training loop
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
- :meth:`~pytorch_lightning.core.hooks.ModelHooks.on_epoch_start` - :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.tbptt_split_batch`
- :meth:`~pytorch_lightning.core.lightning.LightningModule.training_step` - :meth:`~pytorch_lightning.core.lightning.LightningModule.training_step`
- :meth:`~pytorch_lightning.core.lightning.LightningModule.training_step_end` (optional) - :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.backward`
- :meth:`~pytorch_lightning.core.hooks.ModelHooks.on_after_backward` - :meth:`~pytorch_lightning.core.hooks.ModelHooks.on_after_backward`
- ``optimizer.step()`` - ``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.lightning.LightningModule.training_epoch_end`
- :meth:`~pytorch_lightning.core.hooks.ModelHooks.on_epoch_end` - :meth:`~pytorch_lightning.core.hooks.ModelHooks.on_epoch_end`
@ -90,3 +92,6 @@ General hooks
.. autoclass:: pytorch_lightning.core.hooks.DataHooks .. autoclass:: pytorch_lightning.core.hooks.DataHooks
:noindex: :noindex:
.. autoclass:: pytorch_lightning.core.hooks.CheckpointHooks
:noindex: