Skip to content

Commit c886317

Browse files
lightningforeveredenlightningBorda
authored
Restructure Fabric docs (2/n) (#17126)
Co-authored-by: edenlightning <[email protected]> Co-authored-by: Jirka Borovec <[email protected]>
1 parent 7bc2a65 commit c886317

File tree

17 files changed

+579
-258
lines changed

17 files changed

+579
-258
lines changed

‎docs/source-fabric/_static/images/logo.svg

Lines changed: 18 additions & 9 deletions
Loading

‎docs/source-fabric/api/accelerators.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. include:: ../links.rst
2+
3+
#############################
4+
lightning.fabric.accelerators
5+
#############################
6+
7+
8+
Accelerators
9+
^^^^^^^^^^^^
10+
11+
.. currentmodule:: lightning.fabric.accelerators
12+
13+
.. autosummary::
14+
:toctree: ./generated
15+
:nosignatures:
16+
:template: classtemplate.rst
17+
18+
Accelerator
19+
CPUAccelerator
20+
CUDAAccelerator
21+
MPSAccelerator
22+
TPUAccelerator

‎docs/source-fabric/api/collectives.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. include:: ../links.rst
2+
3+
####################################
4+
lightning.fabric.plugins.collectives
5+
####################################
6+
7+
.. warning::
8+
This is an `experimental <https://lightning.ai/docs/pytorch/latest/versioning.html>`__ feature.
9+
10+
11+
Collectives
12+
^^^^^^^^^^^
13+
14+
.. currentmodule:: lightning.fabric.plugins.collectives
15+
16+
.. autosummary::
17+
:toctree: ./generated
18+
:nosignatures:
19+
:template: classtemplate.rst
20+
21+
Collective
22+
TorchCollective
23+
SingleDeviceCollective

‎docs/source-fabric/api/environments.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. include:: ../links.rst
2+
3+
#####################################
4+
lightning.fabric.plugins.environments
5+
#####################################
6+
7+
8+
Environments
9+
^^^^^^^^^^^^
10+
11+
.. currentmodule:: lightning.fabric.plugins.environments
12+
13+
.. autosummary::
14+
:toctree: ./generated
15+
:nosignatures:
16+
:template: classtemplate_noindex.rst
17+
18+
~cluster_environment.ClusterEnvironment
19+
~kubeflow.KubeflowEnvironment
20+
~lightning.LightningEnvironment
21+
~lsf.LSFEnvironment
22+
~mpi.MPIEnvironment
23+
~slurm.SLURMEnvironment
24+
~torchelastic.TorchElasticEnvironment
25+
~xla.XLAEnvironment

‎docs/source-fabric/api/fabric.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.. include:: ../links.rst
2+
3+
#######################
4+
lightning.fabric.Fabric
5+
#######################
6+
7+
8+
Fabric
9+
^^^^^^
10+
11+
.. currentmodule:: lightning.fabric.fabric
12+
13+
.. autosummary::
14+
:toctree: ./generated
15+
:nosignatures:
16+
:template: classtemplate.rst
17+
18+
Fabric

‎docs/source-fabric/api/io.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. include:: ../links.rst
2+
3+
###########################
4+
lightning.fabric.plugins.io
5+
###########################
6+
7+
8+
.. warning::
9+
This is an `experimental <https://lightning.ai/docs/pytorch/latest/versioning.html>`__ feature.
10+
11+
12+
IO
13+
^^
14+
15+
.. currentmodule:: lightning.fabric.plugins.io
16+
17+
.. autosummary::
18+
:toctree: ./generated
19+
:nosignatures:
20+
:template: classtemplate.rst
21+
22+
~checkpoint_io.CheckpointIO
23+
~torch_io.TorchCheckpointIO
24+
~xla.XLACheckpointIO

‎docs/source-fabric/api/loggers.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. include:: ../links.rst
2+
3+
########################
4+
lightning.fabric.loggers
5+
########################
6+
7+
8+
Loggers
9+
^^^^^^^
10+
11+
.. currentmodule:: lightning.fabric.loggers
12+
13+
.. autosummary::
14+
:toctree: ./generated
15+
:nosignatures:
16+
:template: classtemplate.rst
17+
18+
Logger
19+
CSVLogger
20+
TensorBoardLogger

‎docs/source-fabric/api/precision.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. include:: ../links.rst
2+
3+
##################################
4+
lightning.fabric.plugins.precision
5+
##################################
6+
7+
8+
Precision
9+
^^^^^^^^^
10+
11+
.. TODO(fabric): include DeepSpeedPrecision
12+
13+
.. currentmodule:: lightning.fabric.plugins.precision
14+
15+
.. autosummary::
16+
:toctree: ./generated
17+
:nosignatures:
18+
:template: classtemplate.rst
19+
20+
Precision
21+
DoublePrecision
22+
MixedPrecision
23+
TPUPrecision
24+
TPUBf16Precision
25+
FSDPPrecision

‎docs/source-fabric/api/strategies.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. include:: ../links.rst
2+
3+
###########################
4+
lightning.fabric.strategies
5+
###########################
6+
7+
8+
Strategies
9+
^^^^^^^^^^
10+
11+
.. TODO(fabric): include DeepSpeedStrategy, XLAStrategy
12+
13+
.. currentmodule:: lightning.fabric.strategies
14+
15+
.. autosummary::
16+
:toctree: ./generated
17+
:nosignatures:
18+
:template: classtemplate.rst
19+
20+
Strategy
21+
DDPStrategy
22+
DataParallelStrategy
23+
FSDPStrategy
24+
ParallelStrategy
25+
SingleDeviceStrategy
26+
SingleTPUStrategy

‎docs/source-fabric/api/utilities.rst

Lines changed: 0 additions & 88 deletions
This file was deleted.

0 commit comments

Comments
 (0)