diff --git a/docs/source-pytorch/community/index.rst b/docs/source-pytorch/community/index.rst deleted file mode 100644 index f9f5f90e41..0000000000 --- a/docs/source-pytorch/community/index.rst +++ /dev/null @@ -1,69 +0,0 @@ - .. toctree:: - :maxdepth: 1 - :hidden: - - generated/CODE_OF_CONDUCT.md - generated/CONTRIBUTING.md - generated/BECOMING_A_CORE_CONTRIBUTOR.md - governance - versioning - past_versions - generated/CHANGELOG.md - -######### -Community -######### - -.. raw:: html - -
-
- -.. displayitem:: - :header: Code of conduct - :description: Contributor Covenant Code of Conduct - :col_css: col-md-12 - :button_link: ../generated/CODE_OF_CONDUCT.html - :height: 100 - -.. displayitem:: - :header: Contribution guide - :description: How to contribute to PyTorch Lightning - :col_css: col-md-12 - :button_link: ../generated/CONTRIBUTING.html - :height: 100 - -.. displayitem:: - :header: How to Become a core contributor - :description: Steps to be a core contributor - :col_css: col-md-12 - :button_link: ../generated/BECOMING_A_CORE_CONTRIBUTOR.html - :height: 100 - -.. displayitem:: - :header: Lightning Governance - :description: The governance processes we follow - :col_css: col-md-12 - :button_link: governance.html - :height: 100 - -.. displayitem:: - :header: Versioning - :description: PyTorch Lightning's versioning policy - :col_css: col-md-12 - :button_link: versioning.html - :height: 100 - -.. displayitem:: - :header: Past PyTorch Lightning versions - :description: Docs and upgrade guide for past versions - :col_css: col-md-12 - :button_link: past_versions.html - :height: 100 - -.. displayitem:: - :header: Changelog - :description: All notable changes to PyTorch Lightning - :col_css: col-md-12 - :button_link: ../generated/CHANGELOG.html - :height: 100 diff --git a/docs/source-pytorch/glossary/index.rst b/docs/source-pytorch/glossary/index.rst deleted file mode 100644 index d51aa15791..0000000000 --- a/docs/source-pytorch/glossary/index.rst +++ /dev/null @@ -1,281 +0,0 @@ -######## -Glossary -######## - -.. raw:: html - -
-
- -.. displayitem:: - :header: Accelerators - :description: Use accelerators to train faster. - :col_css: col-md-12 - :button_link: ../extensions/accelerator.html - :height: 100 - -.. displayitem:: - :header: Callback - :description: Add arbitrary self-contained programs - :col_css: col-md-12 - :button_link: ../extensions/callbacks.html - :height: 100 - -.. displayitem:: - :header: Checkpointing - :description: Save and load progress with checkpoints - :col_css: col-md-12 - :button_link: ../common/checkpointing.html - :height: 100 - -.. displayitem:: - :header: Cluster - :description: Run on your own group of servers - :col_css: col-md-12 - :button_link: ../clouds/cluster.html - :height: 100 - -.. displayitem:: - :header: Cloud checkpoint - :description: Save your models to cloud filesystems - :col_css: col-md-12 - :button_link: ../common/checkpointing_advanced.html - :height: 100 - -.. displayitem:: - :header: Console Logging - :description: Capture more visible logs - :col_css: col-md-12 - :button_link: ../common/console_logs.html - :height: 100 - -.. displayitem:: - :header: Debugging - :description: Fix errors in your code - :col_css: col-md-12 - :button_link: ../debug/debugging.html - :height: 100 - -.. displayitem:: - :header: Early stopping - :description: Stop the training when no improvement is observed - :col_css: col-md-12 - :button_link: ../common/early_stopping.html - :height: 100 - -.. displayitem:: - :header: Experiment manager (Logger) - :description: Tools for tracking and visualizing artifacts and logs - :col_css: col-md-12 - :button_link: ../visualize/experiment_managers.html - :height: 100 - -.. displayitem:: - :header: Finetuning - :description: Technique for training pretrained models - :col_css: col-md-12 - :button_link: ../advanced/finetuning.html - :height: 100 - -.. displayitem:: - :header: GPU - :description: Graphics Processing Unit for faster training - :col_css: col-md-12 - :button_link: ../accelerators/gpu.html - :height: 100 - -.. displayitem:: - :header: Half precision - :description: Using different numerical formats to save memory and run fatser - :col_css: col-md-12 - :button_link: ../common/precision.html - :height: 100 - -.. displayitem:: - :header: HPU - :description: Habana Gaudi AI Processor Unit for faster training - :col_css: col-md-12 - :button_link: ../accelerators/hpu.html - :height: 100 - -.. displayitem:: - :header: Inference - :description: Making predictions by applying a trained model to unlabeled examples - :col_css: col-md-12 - :button_link: ../deploy/production_intermediate.html - :height: 100 - -.. displayitem:: - :header: IPU - :description: Graphcore Intelligence Processing Unit for faster training - :col_css: col-md-12 - :button_link: ../accelerators/ipu.html - :height: 100 - -.. displayitem:: - :header: Lightning CLI - :description: A Command-line Interface (CLI) to interact with Lightning code via a terminal - :col_css: col-md-12 - :button_link: ../cli/lightning_cli.html - :height: 100 - -.. displayitem:: - :header: LightningDataModule - :description: A shareable, reusable class that encapsulates all the steps needed to process data - :col_css: col-md-12 - :button_link: ../data/datamodule.html - :height: 100 - -.. displayitem:: - :header: LightningModule - :description: A base class organizug your neural network module - :col_css: col-md-12 - :button_link: ../common/lightning_module.html - :height: 100 - -.. displayitem:: - :header: Log - :description: Outpus or results used for visualization and tracking - :col_css: col-md-12 - :button_link: ../visualize/loggers.html - :height: 100 - -.. displayitem:: - :header: Metrics - :description: A statistic used to measure performance or other objectives we want to optimize - :col_css: col-md-12 - :button_link: https://torchmetrics.readthedocs.io/en/stable/ - :height: 100 - -.. displayitem:: - :header: Model - :description: The set of parameters and structure needed for a system to make predictions - :col_css: col-md-12 - :button_link: ../model/build_model.html - :height: 100 - -.. displayitem:: - :header: Model Parallelism - :description: A way to scale training that splits a model between multiple devices. - :col_css: col-md-12 - :button_link: ../advanced/model_parallel.html - :height: 100 - -.. displayitem:: - :header: Plugins - :description: Custom trainer integrations such as custom precision, checkpointing or cluster environment implementation - :col_css: col-md-12 - :button_link: ../extensions/plugins.html - :height: 100 - -.. displayitem:: - :header: Progress bar - :description: Output printed to the terminal to visualize the progression of training - :col_css: col-md-12 - :button_link: ../common/progress_bar.html - :height: 100 - -.. displayitem:: - :header: Production - :description: Using ML models in real world systems - :col_css: col-md-12 - :button_link: ../deploy/production_advanced.html - :height: 100 - -.. displayitem:: - :header: Prediction - :description: Computing a model's output - :col_css: col-md-12 - :button_link: ../deploy/production_basic.html - :height: 100 - -.. displayitem:: - :header: Pretrained models - :description: Models that have already been trained for a particular task - :col_css: col-md-12 - :button_link: ../advanced/pretrained.html - :height: 100 - -.. displayitem:: - :header: Profiler - :description: Tool to identify bottlenecks and performance of different parts of a model - :col_css: col-md-12 - :button_link: ../tuning/profiler.html - :height: 100 - -.. displayitem:: - :header: Pruning - :description: A technique to eliminae some of the model weights to reduce the model size and decrease inference requirements - :col_css: col-md-12 - :button_link: ../advanced/pruning_quantization.html - :height: 100 - -.. displayitem:: - :header: Quantization - :description: A technique to accelerate the model inference speed and decrease the memory load while still maintaining the model accuracy - :col_css: col-md-12 - :button_link: ../advanced/post_training_quantization.html - :height: 100 - -.. displayitem:: - :header: Remote filesystem and FSSPEC - :description: Accessing files from cloud storage providers - :col_css: col-md-12 - :button_link: ../common/remote_fs.html - :height: 100 - -.. displayitem:: - :header: Strategy - :description: Ways the trainer controls the model distribution across training, evaluation, and prediction - :col_css: col-md-12 - :button_link: ../extensions/strategy.html - :height: 100 - -.. displayitem:: - :header: Strategy registry - :description: A class that holds information about training strategies and allows adding new custom strategies - :col_css: col-md-12 - :button_link: ../advanced/strategy_registry.html - :height: 100 - -.. displayitem:: - :header: Style guide - :description: Best practices to improve readability and reproducability - :col_css: col-md-12 - :button_link: ../starter/style_guide.html - :height: 100 - -.. displayitem:: - :header: SWA - :description: Stochastic Weight Averaging (SWA) can make your models generalize better - :col_css: col-md-12 - :button_link: ../advanced/training_tricks.html#stochastic-weight-averaging - :height: 100 - -.. displayitem:: - :header: SLURM - :description: Simple Linux Utility for Resource Management, or simply Slurm, is a free and open-source job scheduler for Linux clusters - :col_css: col-md-12 - :button_link: ../clouds/cluster_advanced.html - :height: 100 - -.. displayitem:: - :header: Transfer learning - :description: Transferring information from one machine learning task to another - :col_css: col-md-12 - :button_link: ../advanced/transfer_learning.html - :height: 100 - -.. displayitem:: - :header: Trainer - :description: The class that automates and customizes model training - :col_css: col-md-12 - :button_link: ../common/trainer.html - :height: 100 - -.. displayitem:: - :header: Torch distributed - :description: Setup for running on distributed environments - :col_css: col-md-12 - :button_link: ../clouds/cluster_intermediate_2.html - :height: 100 diff --git a/docs/source-pytorch/community/governance.rst b/docs/source-pytorch/governance.rst similarity index 98% rename from docs/source-pytorch/community/governance.rst rename to docs/source-pytorch/governance.rst index ec27a55b8b..ae4ffbe490 100644 --- a/docs/source-pytorch/community/governance.rst +++ b/docs/source-pytorch/governance.rst @@ -68,4 +68,4 @@ Commits to the project are exclusively to be added by pull requests on GitHub an review them. However, reviews submitted by `code owners `_ have higher weight and it is necessary to get the approval of code owners before a pull request can be merged. -Additional requirements may apply case by case. +Additional requirements may apply case by case. \ No newline at end of file diff --git a/docs/source-pytorch/community/past_versions.rst b/docs/source-pytorch/past_versions.rst similarity index 100% rename from docs/source-pytorch/community/past_versions.rst rename to docs/source-pytorch/past_versions.rst diff --git a/docs/source-pytorch/community/versioning.rst b/docs/source-pytorch/versioning.rst similarity index 100% rename from docs/source-pytorch/community/versioning.rst rename to docs/source-pytorch/versioning.rst