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

docs (#4105)

This commit is contained in:
William Falcon 2020-10-12 17:37:24 -04:00 committed by GitHub
parent 8e83ac5aa9
commit 84c04362fb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 207 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

210
docs/source/hooks.rst
View File

@ -87,11 +87,215 @@ Test loop
General hooks
-------------
.. autoclass:: pytorch_lightning.core.hooks.ModelHooks
on_after_backward
^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_after_backward
:noindex:
.. autoclass:: pytorch_lightning.core.hooks.DataHooks
on_before_zero_grad
^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_before_zero_grad
:noindex:
.. autoclass:: pytorch_lightning.core.hooks.CheckpointHooks
on_epoch_start
^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_epoch_start
:noindex:
on_epoch_end
^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_epoch_end
:noindex:
on_fit_start
^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_fit_start
:noindex:
on_fit_end
^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_fit_end
:noindex:
on_save_checkpoint
^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.CheckpointHooks.on_save_checkpoint
:noindex:
on_load_checkpoint
^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.CheckpointHooks.on_load_checkpoint
:noindex:
on_pretrain_routine_start
^^^^^^^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_pretrain_routine_start
:noindex:
on_pretrain_routine_end
^^^^^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_pretrain_routine_end
:noindex:
on_test_batch_start
^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_test_batch_start
:noindex:
on_test_batch_end
^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_test_batch_end
:noindex:
on_test_epoch_start
^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_test_epoch_start
:noindex:
on_test_epoch_end
^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_test_epoch_end
:noindex:
on_test_model_train
^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_test_model_train
:noindex:
on_test_model_eval
^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_test_model_eval
:noindex:
on_train_batch_start
^^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_train_batch_start
:noindex:
on_train_batch_end
^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_train_batch_end
:noindex:
on_train_start
^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_train_start
:noindex:
on_train_end
^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_train_end
:noindex:
on_train_epoch_start
^^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_train_epoch_start
:noindex:
on_train_epoch_end
^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_train_epoch_end
:noindex:
on_validation_batch_start
^^^^^^^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_validation_batch_start
:noindex:
on_validation_batch_end
^^^^^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_validation_batch_end
:noindex:
on_validation_epoch_start
^^^^^^^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_validation_epoch_start
:noindex:
on_validation_epoch_end
^^^^^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_validation_epoch_end
:noindex:
on_validation_model_eval
^^^^^^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_validation_model_eval
:noindex:
on_validation_model_train
^^^^^^^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.on_validation_model_train
:noindex:
Data hooks
----------
setup
^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.setup
:noindex:
teardown
^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.ModelHooks.teardown
:noindex:
prepare_data
^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.DataHooks.prepare_data
:noindex:
test_dataloader
^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.DataHooks.test_dataloader
:noindex:
train_dataloader
^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.DataHooks.train_dataloader
:noindex:
transfer_batch_to_device
^^^^^^^^^^^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.DataHooks.transfer_batch_to_device
:noindex:
val_dataloader
^^^^^^^^^^^^^^
.. automethod:: pytorch_lightning.core.hooks.DataHooks.val_dataloader
:noindex: