Restructure Fabric docs (2/n) (Lightning-AI#17126)

Co-authored-by: edenlightning <[email protected]> Co-authored-by: Jirka Borovec <[email protected]>
Git-abouvier · Mar 20, 2023 · c886317 · c886317
1 parent 7bc2a65
commit c886317
Show file tree

Hide file tree

Showing 17 changed files with 579 additions and 258 deletions.
diff --git a/docs/source-fabric/_static/images/logo.svg b/docs/source-fabric/_static/images/logo.svg
diff --git a/docs/source-fabric/api/accelerators.rst b/docs/source-fabric/api/accelerators.rst
@@ -0,0 +1,22 @@
+.. include:: ../links.rst
+
+#############################
+lightning.fabric.accelerators
+#############################
+
+
+Accelerators
+^^^^^^^^^^^^
+
+.. currentmodule:: lightning.fabric.accelerators
+
+.. autosummary::
+    :toctree: ./generated
+    :nosignatures:
+    :template: classtemplate.rst
+
+    Accelerator
+    CPUAccelerator
+    CUDAAccelerator
+    MPSAccelerator
+    TPUAccelerator
diff --git a/docs/source-fabric/api/collectives.rst b/docs/source-fabric/api/collectives.rst
@@ -0,0 +1,23 @@
+.. include:: ../links.rst
+
+####################################
+lightning.fabric.plugins.collectives
+####################################
+
+.. warning::
+    This is an `experimental <https://lightning.ai/docs/pytorch/latest/versioning.html>`__ feature.
+
+
+Collectives
+^^^^^^^^^^^
+
+.. currentmodule:: lightning.fabric.plugins.collectives
+
+.. autosummary::
+    :toctree: ./generated
+    :nosignatures:
+    :template: classtemplate.rst
+
+    Collective
+    TorchCollective
+    SingleDeviceCollective
diff --git a/docs/source-fabric/api/environments.rst b/docs/source-fabric/api/environments.rst
@@ -0,0 +1,25 @@
+.. include:: ../links.rst
+
+#####################################
+lightning.fabric.plugins.environments
+#####################################
+
+
+Environments
+^^^^^^^^^^^^
+
+.. currentmodule:: lightning.fabric.plugins.environments
+
+.. autosummary::
+    :toctree: ./generated
+    :nosignatures:
+    :template: classtemplate_noindex.rst
+
+    ~cluster_environment.ClusterEnvironment
+    ~kubeflow.KubeflowEnvironment
+    ~lightning.LightningEnvironment
+    ~lsf.LSFEnvironment
+    ~mpi.MPIEnvironment
+    ~slurm.SLURMEnvironment
+    ~torchelastic.TorchElasticEnvironment
+    ~xla.XLAEnvironment
diff --git a/docs/source-fabric/api/fabric.rst b/docs/source-fabric/api/fabric.rst
@@ -0,0 +1,18 @@
+.. include:: ../links.rst
+
+#######################
+lightning.fabric.Fabric
+#######################
+
+
+Fabric
+^^^^^^
+
+.. currentmodule:: lightning.fabric.fabric
+
+.. autosummary::
+    :toctree: ./generated
+    :nosignatures:
+    :template: classtemplate.rst
+
+    Fabric
diff --git a/docs/source-fabric/api/io.rst b/docs/source-fabric/api/io.rst
@@ -0,0 +1,24 @@
+.. include:: ../links.rst
+
+###########################
+lightning.fabric.plugins.io
+###########################
+
+
+.. warning::
+    This is an `experimental <https://lightning.ai/docs/pytorch/latest/versioning.html>`__ feature.
+
+
+IO
+^^
+
+.. currentmodule:: lightning.fabric.plugins.io
+
+.. autosummary::
+    :toctree: ./generated
+    :nosignatures:
+    :template: classtemplate.rst
+
+    ~checkpoint_io.CheckpointIO
+    ~torch_io.TorchCheckpointIO
+    ~xla.XLACheckpointIO
diff --git a/docs/source-fabric/api/loggers.rst b/docs/source-fabric/api/loggers.rst
@@ -0,0 +1,20 @@
+.. include:: ../links.rst
+
+########################
+lightning.fabric.loggers
+########################
+
+
+Loggers
+^^^^^^^
+
+.. currentmodule:: lightning.fabric.loggers
+
+.. autosummary::
+    :toctree: ./generated
+    :nosignatures:
+    :template: classtemplate.rst
+
+    Logger
+    CSVLogger
+    TensorBoardLogger
diff --git a/docs/source-fabric/api/precision.rst b/docs/source-fabric/api/precision.rst
@@ -0,0 +1,25 @@
+.. include:: ../links.rst
+
+##################################
+lightning.fabric.plugins.precision
+##################################
+
+
+Precision
+^^^^^^^^^
+
+.. TODO(fabric): include DeepSpeedPrecision
+
+.. currentmodule:: lightning.fabric.plugins.precision
+
+.. autosummary::
+    :toctree: ./generated
+    :nosignatures:
+    :template: classtemplate.rst
+
+    Precision
+    DoublePrecision
+    MixedPrecision
+    TPUPrecision
+    TPUBf16Precision
+    FSDPPrecision
diff --git a/docs/source-fabric/api/strategies.rst b/docs/source-fabric/api/strategies.rst
@@ -0,0 +1,26 @@
+.. include:: ../links.rst
+
+###########################
+lightning.fabric.strategies
+###########################
+
+
+Strategies
+^^^^^^^^^^
+
+.. TODO(fabric): include DeepSpeedStrategy, XLAStrategy
+
+.. currentmodule:: lightning.fabric.strategies
+
+.. autosummary::
+    :toctree: ./generated
+    :nosignatures:
+    :template: classtemplate.rst
+
+    Strategy
+    DDPStrategy
+    DataParallelStrategy
+    FSDPStrategy
+    ParallelStrategy
+    SingleDeviceStrategy
+    SingleTPUStrategy
diff --git a/docs/source-fabric/api/utilities.rst b/docs/source-fabric/api/utilities.rst