.. lightning documentation master file, created by sphinx-quickstart on Sat Sep 19 16:37:02 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. ############################ Welcome to ⚡ Lightning Apps ############################ .. twocolumns:: :left: .. image:: https://pl-flash-data.s3.amazonaws.com/assets_lightning/Lightning.gif :alt: Animation showing how to convert a standard training loop to a Lightning loop :right: The `open-source Lightning framework `_ gives ML Researchers and Data Scientists, the fastest & most flexible way to iterate on ML research ideas and deliver scalable ML systems with the performance enterprises requires at the same time. .. join_slack:: :align: center :margin: 0 ---- .. toctree:: :maxdepth: 1 :caption: Home self .. toctree:: :maxdepth: 1 :caption: Get Started installation get_started/lightning_apps_intro .. toctree:: :maxdepth: 1 :caption: App Building Skills Basic Intermediate Advanced .. toctree:: :maxdepth: 1 :caption: Examples Develop a DAG Develop a File Server Develop a Github Repo Script Runner Develop a Model Server .. [Docs under construction] Build a data exploring app [Docs under construction] Build a ETL app [Docs under construction] Build a model deployment app [Docs under construction] Build a research demo app .. toctree:: :maxdepth: 1 :caption: How to... Access the App State Add a web user interface (UI) Add a web link Arrange app tabs Develop a Lightning App Develop a Lightning Component Cache Work run calls Customize your cloud compute Extend an existing app Publish a Lightning component Run a server within a Lightning App Run an App on the cloud Run Apps on your cloud account (BYOC) Run work in parallel Share an app Share files between components .. [Docs under construction] Add a Lightning component [Docs under construction] Debug a distributed cloud app locally [Docs under construction] Enable fault tolerance [Docs under construction] Run components on different hardware [Docs under construction] Schedule app runs [Docs under construction] Test an app .. toctree:: :maxdepth: 1 :caption: Core API Reference LightningApp LightningFlow LightningWork .. toctree:: :maxdepth: 1 :caption: Addons API Reference api_reference/components api_reference/frontend api_reference/runners api_reference/storage .. toctree:: :maxdepth: 1 :caption: Glossary App Components Tree Build Configuration DAG Event Loop Environment Variables Encrypted Secrets Frontend Sharing Components Scheduling Storage UI .. [Docs under construction] Debug an app [Docs under construction] Distributed front-ends [Docs under construction] Distributed hardware [Docs under construction] Fault tolerance .. toctree:: :maxdepth: 1 :name: start :caption: Get Started starter/introduction starter/installation .. toctree:: :maxdepth: 2 :name: levels :caption: Level Up levels/core_skills levels/intermediate levels/advanced levels/expert .. toctree:: :maxdepth: 2 :name: pl_docs :caption: Core API common/lightning_module common/trainer .. toctree:: :maxdepth: 2 :name: api :caption: API Reference api_references .. toctree:: :maxdepth: 1 :name: Common Workflows :caption: Common Workflows Avoid overfitting model/build_model.rst common/hyperparameters common/progress_bar deploy/production advanced/training_tricks cli/lightning_cli tuning/profiler Manage experiments Organize existing PyTorch into Lightning clouds/cluster Save and load model progress Save memory with half-precision Training over the internet advanced/model_parallel clouds/cloud_training Train on single or multiple GPUs Train on single or multiple HPUs Train on single or multiple IPUs Train on single or multiple TPUs Train on MPS Use a pretrained model model/own_your_loop .. toctree:: :maxdepth: 1 :name: Glossary :caption: Glossary Accelerators Callback Checkpointing Cluster Cloud checkpoint Console Logging Debugging Early stopping Experiment manager (Logger) Fault tolerant training Finetuning Flash Grid AI GPU Half precision HPU Inference IPU Lightning CLI Lightning Lite LightningDataModule LightningModule Lightning Transformers Log Loops TPU Metrics Model Model Parallel Collaborative Training Plugins Progress bar Production Predict Pretrained models Profiler Pruning and Quantization Remote filesystem and FSSPEC Strategy Strategy registry Style guide Sweep SWA SLURM Transfer learning Trainer Torch distributed .. toctree:: :maxdepth: 1 :name: Hands-on Examples :caption: Hands-on Examples :glob: PyTorch Lightning 101 class From PyTorch to PyTorch Lightning [Blog] From PyTorch to PyTorch Lightning [Video] .. toctree:: :maxdepth: 1 :name: Community :caption: Community generated/CODE_OF_CONDUCT.md generated/CONTRIBUTING.md generated/BECOMING_A_CORE_CONTRIBUTOR.md governance