revert docs

This commit is contained in:
Eden Afek 2023-03-30 20:14:54 -04:00
parent 14cf89c788
commit 65eb3e7c45
1 changed files with 88 additions and 12 deletions

View File

@ -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 <common/evaluation>
model/build_model.rst
cli/lightning_cli
common/progress_bar
deploy/production
advanced/training_tricks
tuning/profiler
Manage experiments <visualize/logging_intermediate>
Organize existing PyTorch into Lightning <starter/converting>
clouds/cluster
Save and load model progress <common/checkpointing>
Save memory with half-precision <common/precision>
advanced/model_parallel
Train on single or multiple GPUs <accelerators/gpu>
Train on single or multiple HPUs <accelerators/hpu>
Train on single or multiple IPUs <accelerators/ipu>
Train on single or multiple TPUs <accelerators/tpu>
Train on MPS <accelerators/mps>
Use a pretrained model <advanced/pretrained>
data/data
model/own_your_loop
.. toctree::
:maxdepth: 1
:name: Glossary
:caption: Glossary
Accelerators <extensions/accelerator>
Callback <extensions/callbacks>
Checkpointing <common/checkpointing>
Cluster <clouds/cluster>
Cloud checkpoint <common/checkpointing_advanced>
Console Logging <common/console_logs>
Debugging <debug/debugging>
Early stopping <common/early_stopping>
Experiment manager (Logger) <visualize/experiment_managers>
Finetuning <advanced/finetuning>
Flash <https://lightning-flash.readthedocs.io/en/stable/>
GPU <accelerators/gpu>
Half precision <common/precision>
HPU <accelerators/hpu>
Inference <deploy/production_intermediate>
IPU <accelerators/ipu>
Lightning CLI <cli/lightning_cli>
LightningDataModule <data/datamodule>
LightningModule <common/lightning_module>
Log <visualize/loggers>
TPU <accelerators/tpu>
Metrics <https://torchmetrics.readthedocs.io/en/stable/>
Model <model/build_model.rst>
Model Parallel <advanced/model_parallel>
Plugins <extensions/plugins>
Progress bar <common/progress_bar>
Production <deploy/production_advanced>
Predict <deploy/production_basic>
Pretrained models <advanced/pretrained>
Profiler <tuning/profiler>
Pruning and Quantization <advanced/pruning_quantization>
Remote filesystem and FSSPEC <common/remote_fs>
Strategy <extensions/strategy>
Strategy registry <advanced/strategy_registry>
Style guide <starter/style_guide>
SWA <advanced/training_tricks>
SLURM <clouds/cluster_advanced>
Transfer learning <advanced/transfer_learning>
Trainer <common/trainer>
Torch distributed <clouds/cluster_intermediate_2>
.. toctree::
:maxdepth: 1
:name: Hands-on Examples
:caption: Hands-on Examples
:glob:
notebooks/**/*
.. toctree::
:maxdepth: 1
:name: More
:caption: More
Community <community/index>
Glossary <glossary/index>
How to <common/index>
: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.