loop customization docs

docs/source/advanced/sequences.rst

@@ -1,6 +1,6 @@
 
 Sequential Data
-================
+===============
 
 Truncated Backpropagation Through Time
 --------------------------------------

docs/source/api_references.rst

@@ -67,6 +67,112 @@ Loggers API
     test_tube
     wandb
 
+Loop API
+--------
+
+Base classes
+^^^^^^^^^^^^
+
+.. currentmodule:: pytorch_lightning.loops
+
+.. autosummary::
+    :toctree: api
+    :nosignatures:
+    :template: classtemplate.rst
+
+    Loop
+    DataLoaderLoop
+
+
+Default Loop Implementations
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+Training
+""""""""
+
+.. currentmodule:: pytorch_lightning.loops.fit_loop
+
+.. autosummary::
+    :toctree: api
+    :nosignatures:
+    :template: classtemplate.rst
+
+    FitLoop
+
+.. currentmodule:: pytorch_lightning.loops.epoch
+
+.. autosummary::
+    :toctree: api
+    :nosignatures:
+    :template: classtemplate.rst
+
+    TrainingEpochLoop
+
+.. currentmodule:: pytorch_lightning.loops.batch
+
+.. autosummary::
+    :toctree: api
+    :nosignatures:
+    :template: classtemplate.rst
+
+    TrainingBatchLoop
+
+.. currentmodule:: pytorch_lightning.loops.optimization
+
+.. autosummary::
+    :toctree: api
+    :nosignatures:
+    :template: classtemplate.rst
+
+    OptimizerLoop
+    ManualOptimization
+
+
+Validation and Testing
+""""""""""""""""""""""
+
+.. currentmodule:: pytorch_lightning.loops.dataloader
+
+.. autosummary::
+    :toctree: api
+    :nosignatures:
+    :template: classtemplate.rst
+
+    EvaluationLoop
+
+.. currentmodule:: pytorch_lightning.loops.epoch
+
+.. autosummary::
+    :toctree: api
+    :nosignatures:
+    :template: classtemplate.rst
+
+    EvaluationEpochLoop
+
+
+Prediction
+""""""""""
+
+.. currentmodule:: pytorch_lightning.loops.dataloader
+
+.. autosummary::
+    :toctree: api
+    :nosignatures:
+    :template: classtemplate.rst
+
+    PredictionLoop
+
+.. currentmodule:: pytorch_lightning.loops.epoch
+
+.. autosummary::
+    :toctree: api
+    :nosignatures:
+    :template: classtemplate.rst
+
+    PredictionEpochLoop
+
+
 Plugins API
 -----------