diff --git a/docs/source-pytorch/index.rst b/docs/source-pytorch/index.rst index 0bd78b6fb6..0d06b3e935 100644 --- a/docs/source-pytorch/index.rst +++ b/docs/source-pytorch/index.rst @@ -165,7 +165,7 @@ Current Lightning Users levels/expert .. toctree:: - :maxdepth: 1 + :maxdepth: 2 :name: pl_docs :caption: Core API @@ -173,30 +173,105 @@ Current Lightning Users common/trainer .. toctree:: - :maxdepth: 1 + :maxdepth: 2 :name: api - :caption: Optional API + :caption: API Reference api_references .. toctree:: :maxdepth: 1 - :name: Examples - :caption: Examples + :name: Common Workflows + :caption: Common Workflows + + Avoid overfitting + model/build_model.rst + cli/lightning_cli + common/progress_bar + deploy/production + advanced/training_tricks + tuning/profiler + Manage experiments + Organize existing PyTorch into Lightning + clouds/cluster + Save and load model progress + Save memory with half-precision + advanced/model_parallel + 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 + data/data + 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) + Finetuning + Flash + GPU + Half precision + HPU + Inference + IPU + Lightning CLI + LightningDataModule + LightningModule + Log + TPU + Metrics + Model + Model Parallel + Plugins + Progress bar + Production + Predict + Pretrained models + Profiler + Pruning and Quantization + Remote filesystem and FSSPEC + Strategy + Strategy registry + Style guide + SWA + SLURM + Transfer learning + Trainer + Torch distributed + +.. toctree:: + :maxdepth: 1 + :name: Hands-on Examples + :caption: Hands-on Examples :glob: notebooks/**/* - .. toctree:: :maxdepth: 1 - :name: More - :caption: More - - Community - Glossary - How to + :name: Community + :caption: Community + generated/CODE_OF_CONDUCT.md + generated/CONTRIBUTING.md + generated/BECOMING_A_CORE_CONTRIBUTOR.md + governance + versioning + past_versions + generated/CHANGELOG.md .. raw:: html @@ -206,3 +281,4 @@ Current Lightning Users 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. + \ No newline at end of file