.. 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

   new-project

.. toctree::
   :maxdepth: 4
   :name: docs
   :caption: Python API

   callbacks
   hooks
   lightning-module
   loggers
   trainer


.. toctree::
   :maxdepth: 1
   :name: Examples
   :caption: Examples

   examples

.. toctree::
   :maxdepth: 1
   :name: Tutorials
   :caption: Tutorials

   tutorials

.. toctree::
   :maxdepth: 1
   :name: Common Use Cases
   :caption: Common Use Cases

   apex
   checkpointing
   slurm
   debugging
   experiment_logging
   experiment_reporting
   early_stopping
   fast_training
   hooks
   multi_gpu
   single_gpu
   sequences
   training_tricks
   tpu
   test_set
   optimizers
   profiler

.. 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`