PyTorch Lightning is the deep learning framework for professional AI researchers and machine learning engineers who need maximal flexibility without sacrificing performance at scale.
For pip (and conda) users
pip install pytorch-lightningOr directly from conda
conda install pytorch-lightning -c conda-forgeOr read the advanced install guide
.. customcalloutitem:: :description: Use this 2-step guide to learn key concepts. :header: New to Lightning? :button_link: starter/introduction.html
.. customcalloutitem:: :description: Easily organize your existing PyTorch code into PyTorch Lightning. :header: PyTorch to PyTorch Lightning :button_link: starter/converting.html
.. customcalloutitem:: :description: See how Lightning in used in research areas like NLP, Computer Vision, RL and meta learning. :header: Examples :button_link: tutorials.html
.. customcalloutitem:: :description: Detailed descriptions of each API package. :header: API Reference :button_link: api_references.html
.. customcalloutitem:: :description: Key Lightning use cases, including hyperparameter sweeps, cloud training, Pruning and Quantization. :header: Common Use Cases :button_link: common_usecases.html
.. customcalloutitem:: :description: Learn how to benchmark PyTorch Lightning. :header: Benchmarking :button_link: benchmarking/benchmarks.html
.. toctree:: :maxdepth: 1 :name: start :caption: Getting started starter/introduction starter/installation starter/converting starter/lightning_lite
.. 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: 2 :name: docs :caption: Optional Extensions extensions/accelerator extensions/callbacks extensions/datamodules extensions/logging extensions/plugins extensions/strategy extensions/loops
.. toctree:: :maxdepth: 1 :name: Accelerators :caption: Accelerators accelerators/gpu accelerators/tpu accelerators/ipu accelerators/hpu
.. toctree:: :maxdepth: 1 :name: Common Use Cases :caption: Common Use Cases clouds/cloud_training common/checkpointing clouds/cluster common/debugging common/early_stopping advanced/training_tricks common/evaluation advanced/fault_tolerant_training common/hyperparameters common/production_inference common/lightning_cli common/loggers advanced/model_parallel advanced/precision common/optimization advanced/profiler common/progress_bar advanced/pruning_quantization common/remote_fs advanced/strategy_registry advanced/transfer_learning
.. toctree:: :maxdepth: 1 :name: Tutorials :caption: Tutorials :glob: starter/core_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/**/*
.. toctree:: :maxdepth: 2 :name: api :caption: API References api_references
.. toctree:: :maxdepth: 1 :name: Lightning Ecosystem :caption: Lightning Ecosystem ecosystem/metrics ecosystem/flash ecosystem/bolts ecosystem/transformers ecosystem/ecosystem-ci
.. toctree:: :maxdepth: 1 :name: Examples :caption: Examples ecosystem/community_examples ecosystem/asr_nlp_tts Autoencoder <https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/autoencoders.html> BYOL <https://lightning-bolts.readthedocs.io/en/stable/deprecated/callbacks/self_supervised.html#byolmaweightupdate> DQN <https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/reinforce_learn.html#deep-q-network-dqn> GAN <https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/gans.html#basic-gan> GPT-2 <https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/convolutional.html#gpt-2> Image-GPT <https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/convolutional.html#image-gpt> SimCLR <https://lightning-bolts.readthedocs.io/en/stable/deprecated/transforms/self_supervised.html#simclr-transforms> VAE <https://lightning-bolts.readthedocs.io/en/stable/deprecated/models/autoencoders.html#basic-vae>
.. 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