lightning/docs/source/index.rst

.. 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: Getting started

   starter/new-project
   starter/converting
   starter/rapid_prototyping_templates

.. toctree::
   :maxdepth: 1
   :name: guides
   :caption: Best practices

   guides/speed
   guides/data
   starter/style_guide
   Lightning project template<https://github.com/PyTorchLightning/pytorch-lightning-conference-seed>
   benchmarking/benchmarks


.. toctree::
   :maxdepth: 2
   :name: pl_docs
   :caption: Lightning API

   common/lightning_module
   common/trainer

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

   clouds/cloud_training
   clouds/cluster
   common/child_modules
   common/debugging
   common/early_stopping
   common/hyperparameters
   common/production_inference
   advanced/ipu
   common/lightning_cli
   advanced/lr_finder
   common/loggers
   advanced/multi_gpu
   advanced/advanced_gpu
   advanced/mixed_precision
   common/weights_loading
   advanced/fault_tolerant_training
   advanced/checkpoint_io
   common/optimizers
   advanced/profiler
   advanced/sequences
   common/single_gpu
   advanced/training_tricks
   advanced/pruning_quantization
   advanced/transfer_learning
   advanced/tpu
   common/test_set

.. toctree::
   :maxdepth: 2
   :name: docs
   :caption: Optional extensions

   extensions/accelerators
   extensions/callbacks
   extensions/datamodules
   extensions/logging
   extensions/metrics
   extensions/plugins


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

   starter/introduction_guide
   PyTorch Lightning 101 class <https://www.youtube.com/playlist?list=PLaMu-SDt_RB5NUm67hU2pdE75j6KaIOv2>
   From PyTorch to PyTorch Lightning [Blog] <https://towardsdatascience.com/from-pytorch-to-pytorch-lightning-a-gentle-introduction-b371b7caaf09>
   From PyTorch to PyTorch Lightning [Video] <https://www.youtube.com/watch?v=QHww1JH7IDU>
   notebooks/lightning_examples/mnist-hello-world.ipynb
   notebooks/lightning_examples/datamodules.ipynb
   notebooks/lightning_examples/cifar10-baseline.ipynb
   notebooks/lightning_examples/basic-gan.ipynb
   notebooks/lightning_examples/mnist-tpu-training.ipynb
   notebooks/lightning_examples/text-transformers.ipynb
   notebooks/lightning_examples/reinforce-learning-DQN.ipynb
   notebooks/lightning_examples/augmentation_kornia.ipynb

.. toctree::
   :maxdepth: 2
   :name: api
   :caption: API References

   api_references

.. toctree::
   :maxdepth: 1
   :name: Bolts
   :caption: Bolts

   ecosystem/bolts

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

   ecosystem/community_examples
   Autoencoder <https://lightning-bolts.readthedocs.io/en/latest/autoencoders.html#autoencoders>
   BYOL <https://lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#byol>
   DQN <https://lightning-bolts.readthedocs.io/en/latest/reinforce_learn.html#deep-q-network-dqn>
   GAN <https://lightning-bolts.readthedocs.io/en/latest/gans.html#basic-gan>
   GPT-2 <https://lightning-bolts.readthedocs.io/en/latest/convolutional.html#gpt-2>
   Image-GPT <https://lightning-bolts.readthedocs.io/en/latest/convolutional.html#image-gpt>
   SimCLR <https://lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#simclr>
   VAE <https://lightning-bolts.readthedocs.io/en/latest/autoencoders.html#basic-vae>

.. toctree::
   :maxdepth: 1
   :name: Partner Domain Frameworks
   :caption: Partner Domain Frameworks

   ecosystem/asr_nlp_tts

.. toctree::
   :maxdepth: 1
   :name: Community
   :caption: Community


   generated/CODE_OF_CONDUCT.md
   generated/CONTRIBUTING.md
   generated/BECOMING_A_CORE_CONTRIBUTOR.md
   governance
   generated/CHANGELOG.md

Indices and tables
------------------

* :ref:`genindex`
* :ref:`search`