Update Fabric docs navigation (#16957)

Lightning-AI · Mar 6, 2023 · 54147e0 · 54147e0
1 parent 5870714
commit 54147e0
Show file tree

Hide file tree

Showing 20 changed files with 107 additions and 138 deletions.
diff --git a/.gitignore b/.gitignore
@@ -17,7 +17,7 @@ docs/source-pytorch/notebooks
 docs/source-pytorch/_static/images/course_UvA-DL
 docs/source-pytorch/_static/images/lightning_examples
 
-docs/source-fabric/api
+docs/source-fabric/*/generated
 
 # C extensions
 *.so

diff --git a/docs/source-fabric/advanced/distributed_communication.rst b/docs/source-fabric/advanced/distributed_communication.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ###########################################
 Communication between distributed processes
 ###########################################

diff --git a/docs/source-fabric/advanced/gradient_accumulation.rst b/docs/source-fabric/advanced/gradient_accumulation.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ###############################
 Efficient Gradient Accumulation
 ###############################

diff --git a/docs/source-fabric/api/fabric_args.rst b/docs/source-fabric/api/fabric_args.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ################
 Fabric Arguments
 ################

diff --git a/docs/source-fabric/api/fabric_methods.rst b/docs/source-fabric/api/fabric_methods.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ##############
 Fabric Methods
 ##############

diff --git a/docs/source-fabric/api/utilities.rst b/docs/source-fabric/api/utilities.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ################
 Fabric Utilities
 ################

diff --git a/docs/source-fabric/api_reference.rst b/docs/source-fabric/api_reference.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 .. include:: links.rst
 
 #############
@@ -13,7 +11,7 @@ Fabric
 .. currentmodule:: lightning.fabric.fabric
 
 .. autosummary::
-    :toctree: api
+    :toctree: api/generated
     :nosignatures:
     :template: classtemplate.rst
 
@@ -26,7 +24,7 @@ Accelerators
 .. currentmodule:: lightning.fabric.accelerators
 
 .. autosummary::
-    :toctree: api
+    :toctree: api/generated
     :nosignatures:
     :template: classtemplate.rst
 
@@ -43,7 +41,7 @@ Loggers
 .. currentmodule:: lightning.fabric.loggers
 
 .. autosummary::
-    :toctree: api
+    :toctree: api/generated
     :nosignatures:
     :template: classtemplate.rst
 
@@ -59,7 +57,7 @@ Precision
 .. currentmodule:: lightning.fabric.plugins.precision
 
 .. autosummary::
-    :toctree: api
+    :toctree: api/generated
     :nosignatures:
     :template: classtemplate.rst
 
@@ -77,7 +75,7 @@ Environments
 .. currentmodule:: lightning.fabric.plugins.environments
 
 .. autosummary::
-    :toctree: api
+    :toctree: api/generated
     :nosignatures:
     :template: classtemplate_noindex.rst
 
@@ -97,7 +95,7 @@ IO
 .. currentmodule:: lightning.fabric.plugins.io
 
 .. autosummary::
-    :toctree: api
+    :toctree: api/generated
     :nosignatures:
     :template: classtemplate.rst
 
@@ -112,7 +110,7 @@ Collectives
 .. currentmodule:: lightning.fabric.plugins.collectives
 
 .. autosummary::
-    :toctree: api
+    :toctree: api/generated
     :nosignatures:
     :template: classtemplate.rst
 
@@ -129,7 +127,7 @@ Strategies
 .. currentmodule:: lightning.fabric.strategies
 
 .. autosummary::
-    :toctree: api
+    :toctree: api/generated
     :nosignatures:
     :template: classtemplate.rst
 

diff --git a/docs/source-fabric/examples/index.rst b/docs/source-fabric/examples/index.rst
@@ -0,0 +1,59 @@
+########
+Examples
+########
+
+.. raw:: html
+
+    <div class="display-card-container">
+        <div class="row">
+
+.. displayitem::
+    :header: Image Classification
+    :description: Train an image classifier on the MNIST dataset
+    :button_link: https://github.com/Lightning-AI/lightning/blob/master/examples/fabric/image_classifier
+    :col_css: col-md-4
+    :height: 150
+    :tag: basic
+
+.. displayitem::
+    :header: GAN
+    :description: Train a GAN that generates realistic human faces
+    :button_link: https://github.com/Lightning-AI/lightning/blob/master/examples/fabric/dcgan
+    :col_css: col-md-4
+    :height: 150
+    :tag: intermediate
+
+.. displayitem::
+    :header: Meta-Learning
+    :description: Distributed training with the MAML algorithm on the Omniglot and MiniImagenet datasets
+    :button_link: https://github.com/Lightning-AI/lightning/blob/master/examples/fabric/meta_learning
+    :col_css: col-md-4
+    :height: 150
+    :tag: intermediate
+
+.. displayitem::
+    :header: Large Language Models
+    :description: Pre-train a GPT-2 language model on OpenWebText data
+    :button_link: https://github.com/Lightning-AI/nanoGPT/blob/master/train_fabric.py
+    :col_css: col-md-4
+    :height: 150
+    :tag: advanced
+
+.. displayitem::
+    :header: Reinforcement Learning
+    :description: Implementation of the Proximal Policy Optimization (PPO) algorithm with multi-GPU support
+    :button_link: https://github.com/Lightning-AI/lightning/blob/master/examples/fabric/reinforcement_learning
+    :col_css: col-md-4
+    :height: 150
+
+.. displayitem::
+    :header: Active Learning
+    :description: Coming soon
+    :col_css: col-md-4
+    :height: 150
+
+
+.. raw:: html
+
+        </div>
+    </div>
diff --git a/docs/source-fabric/fundamentals/accelerators.rst b/docs/source-fabric/fundamentals/accelerators.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ################################
 Accelerate your code with Fabric
 ################################

diff --git a/docs/source-fabric/fundamentals/code_structure.rst b/docs/source-fabric/fundamentals/code_structure.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ######################################
 How to structure your code with Fabric
 ######################################

diff --git a/docs/source-fabric/fundamentals/convert.rst b/docs/source-fabric/fundamentals/convert.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ##############################
 Convert PyTorch code to Fabric
 ##############################

diff --git a/docs/source-fabric/fundamentals/launch.rst b/docs/source-fabric/fundamentals/launch.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ###########################
 Launch distributed training
 ###########################

diff --git a/docs/source-fabric/fundamentals/notebooks.rst b/docs/source-fabric/fundamentals/notebooks.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 .. _Fabric in Notebooks:
 
 ###################

diff --git a/docs/source-fabric/fundamentals/precision.rst b/docs/source-fabric/fundamentals/precision.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ################################
 Save memory with mixed precision
 ################################

diff --git a/docs/source-fabric/guide/callbacks.rst b/docs/source-fabric/guide/callbacks.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 #########
 Callbacks
 #########

diff --git a/docs/source-fabric/guide/checkpoint.rst b/docs/source-fabric/guide/checkpoint.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ##############################
 Saving and Loading Checkpoints
 ##############################

diff --git a/docs/source-fabric/guide/lightning_module.rst b/docs/source-fabric/guide/lightning_module.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ##################
 Organize Your Code
 ##################

diff --git a/docs/source-fabric/guide/logging.rst b/docs/source-fabric/guide/logging.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ###############################
 Track and Visualize Experiments
 ###############################

diff --git a/docs/source-fabric/guide/trainer_template.rst b/docs/source-fabric/guide/trainer_template.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 ################
 Template Trainer
 ################

diff --git a/docs/source-fabric/index.rst b/docs/source-fabric/index.rst
@@ -240,116 +240,60 @@ Advanced Topics
 ----
 
 
-.. _Fabric Examples:
-
-********
-Examples
-********
-
 .. raw:: html
 
-    <div class="display-card-container">
-        <div class="row">
+    <div style="display:none">
 
-.. displayitem::
-    :header: Image Classification
-    :description: Train an image classifier on the MNIST dataset
-    :button_link: https://github.com/Lightning-AI/lightning/blob/master/examples/fabric/image_classifier
-    :col_css: col-md-4
-    :height: 150
-    :tag: basic
 
-.. displayitem::
-    :header: GAN
-    :description: Train a GAN that generates realistic human faces
-    :button_link: https://github.com/Lightning-AI/lightning/blob/master/examples/fabric/dcgan
-    :col_css: col-md-4
-    :height: 150
-    :tag: intermediate
+.. toctree::
+    :maxdepth: 1
+    :name: start
+    :caption: Fundamentals
 
-.. displayitem::
-    :header: Meta-Learning
-    :description: Distributed training with the MAML algorithm on the Omniglot and MiniImagenet datasets
-    :button_link: https://github.com/Lightning-AI/lightning/blob/master/examples/fabric/meta_learning
-    :col_css: col-md-4
-    :height: 150
-    :tag: intermediate
+    Getting Started <fundamentals/convert>
+    Accelerators <fundamentals/accelerators>
+    Code Structure <fundamentals/code_structure>
+    Launch Distributed Training <fundamentals/launch>
+    Fabric in Notebooks <fundamentals/notebooks>
+    Mixed Precision Training <fundamentals/precision>
 
-.. displayitem::
-    :header: Large Language Models
-    :description: Pre-train a GPT-2 language model on OpenWebText data
-    :button_link: https://github.com/Lightning-AI/nanoGPT/blob/master/train_fabric.py
-    :col_css: col-md-4
-    :height: 150
-    :tag: advanced
+.. toctree::
+    :maxdepth: 1
+    :name: byot
+    :caption: Build Your Own Trainer
 
-.. displayitem::
-    :header: Reinforcement Learning
-    :description: Implementation of the Proximal Policy Optimization (PPO) algorithm with multi-GPU support
-    :button_link: https://github.com/Lightning-AI/lightning/blob/master/examples/fabric/reinforcement_learning
-    :col_css: col-md-4
-    :height: 150
+    The LightningModule <guide/lightning_module>
+    Callbacks <guide/callbacks>
+    Logging <guide/logging>
+    Checkpoints <guide/checkpoint>
+    Trainer Template <guide/trainer_template>
 
-.. displayitem::
-    :header: Active Learning
-    :description: Coming soon
-    :col_css: col-md-4
-    :height: 150
+.. toctree::
+    :maxdepth: 1
+    :name: advanced
+    :caption: Advanced Topics
 
+    Efficient Gradient Accumulation <advanced/gradient_accumulation>
+    Distributed Communication <advanced/distributed_communication>
 
+.. toctree::
+    :maxdepth: 1
+    :name: examples
+    :caption: Examples
 
-.. raw:: html
+    Examples <examples/index>
 
-        </div>
-    </div>
+.. toctree::
+    :maxdepth: 1
+    :name: api
+    :caption: API Reference
 
+    Fabric Arguments <api/fabric_args>
+    Fabric Methods <api/fabric_methods>
+    Utilities <api/utilities>
+    Full API Reference <api_reference>
 
 
-----
-
-
-***
-API
-***
-
 .. raw:: html
 
-    <div class="display-card-container">
-        <div class="row">
-
-.. displayitem::
-    :header: Fabric Arguments
-    :description: All configuration options for the Fabric object
-    :button_link: api/fabric_args.html
-    :col_css: col-md-4
-    :height: 150
-    :tag: basic
-
-.. displayitem::
-    :header: Fabric Methods
-    :description: Explore all methods that Fabric offers
-    :button_link: api/fabric_methods.html
-    :col_css: col-md-4
-    :height: 150
-    :tag: basic
-
-.. displayitem::
-    :header: Utilities
-    :description: Explore utility functions that make your life easier
-    :button_link: api/utilities.html
-    :col_css: col-md-4
-    :height: 150
-    :tag: basic
-
-.. displayitem::
-    :header: Full API Reference
-    :description: Reference of all public classes, methods and functions. Useful for developers.
-    :button_link: api_reference.html
-    :col_css: col-md-4
-    :height: 150
-    :tag: intermediate
-
-.. raw:: html
-
-        </div>
     </div>