lightning/docs/source/index.rst

86 lines
1.5 KiB
ReStructuredText

.. PyTorch-Lightning documentation master file, created by
sphinx-quickstart on Fri Nov 15 07:48:22 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
PyTorch Lightning Documentation
===============================
.. toctree::
:maxdepth: 1
:name: start
:caption: Start Here
introduction_guide
.. toctree::
:maxdepth: 2
:name: docs
:caption: Python API
callbacks
hooks
lightning-module
loggers
trainer
.. toctree::
:maxdepth: 1
:name: Community Examples
:caption: Community Examples
examples
.. toctree::
:maxdepth: 1
:name: Tutorials
:caption: Tutorials
From PyTorch to PyTorch Lightning <https://towardsdatascience.com/from-pytorch-to-pytorch-lightning-a-gentle-introduction-b371b7caaf09>
.. toctree::
:maxdepth: 1
:name: Common Use Cases
:caption: Common Use Cases
apex
slurm
child_modules
debugging
experiment_logging
experiment_reporting
early_stopping
fast_training
hooks
hyperparameters
multi_gpu
weights_loading
optimizers
profiler
single_gpu
sequences
training_tricks
transfer_learning
tpu
test_set
.. toctree::
:maxdepth: 1
:name: community
:caption: Community
CODE_OF_CONDUCT.md
CONTRIBUTING.md
BECOMING_A_CORE_CONTRIBUTOR.md
PULL_REQUEST_TEMPLATE.md
governance.md
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`