Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
lightning/docs/source-fabric/api_reference.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

141 lines
2.3 KiB
ReStructuredText
Raw Normal View History

docs: move fabric on its own (#16742) * docs: move fabric to Lai * update imports * links * drop link to Trainer * own docs * ci * trigger * prune cross-links * cleaning * cleaning * template * imports * template * path * links * tensorboardX * plugins * label * drop fixme * drop copy nb + examples * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Apply suggestions from code review * try again * rev --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-03-01 11:36:14 +00:00
.. include:: links.rst
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
#############
API Reference
#############
Fabric
^^^^^^
docs: update `pytorch_lightning` imports (#16864) * update docs imports * ci * fabric * trigger * links * . * docstring * chlog * cleaning
2023-02-27 20:14:23 +00:00
.. currentmodule:: lightning.fabric.fabric
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
.. autosummary::
Update Fabric docs navigation (#16957)
2023-03-06 15:13:51 +00:00
:toctree: api/generated
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
:nosignatures:
:template: classtemplate.rst
Fabric
Accelerators
^^^^^^^^^^^^
docs: update `pytorch_lightning` imports (#16864) * update docs imports * ci * fabric * trigger * links * . * docstring * chlog * cleaning
2023-02-27 20:14:23 +00:00
.. currentmodule:: lightning.fabric.accelerators
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
.. autosummary::
Update Fabric docs navigation (#16957)
2023-03-06 15:13:51 +00:00
:toctree: api/generated
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
:nosignatures:
:template: classtemplate.rst
Accelerator
CPUAccelerator
CUDAAccelerator
MPSAccelerator
TPUAccelerator
Add CSVLogger for Lightning Lite (#16346) Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
2023-01-13 13:09:44 +00:00
Loggers
^^^^^^^
docs: update `pytorch_lightning` imports (#16864) * update docs imports * ci * fabric * trigger * links * . * docstring * chlog * cleaning
2023-02-27 20:14:23 +00:00
.. currentmodule:: lightning.fabric.loggers
Add CSVLogger for Lightning Lite (#16346) Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
2023-01-13 13:09:44 +00:00
.. autosummary::
Update Fabric docs navigation (#16957)
2023-03-06 15:13:51 +00:00
:toctree: api/generated
Add CSVLogger for Lightning Lite (#16346) Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
2023-01-13 13:09:44 +00:00
:nosignatures:
:template: classtemplate.rst
Logger
CSVLogger
TensorBoardLogger
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
Precision
"""""""""
.. TODO(fabric): include DeepSpeedPrecision
docs: update `pytorch_lightning` imports (#16864) * update docs imports * ci * fabric * trigger * links * . * docstring * chlog * cleaning
2023-02-27 20:14:23 +00:00
.. currentmodule:: lightning.fabric.plugins.precision
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
.. autosummary::
Update Fabric docs navigation (#16957)
2023-03-06 15:13:51 +00:00
:toctree: api/generated
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
:nosignatures:
:template: classtemplate.rst
Precision
DoublePrecision
MixedPrecision
TPUPrecision
TPUBf16Precision
FSDPPrecision
Environments
""""""""""""
docs: update `pytorch_lightning` imports (#16864) * update docs imports * ci * fabric * trigger * links * . * docstring * chlog * cleaning
2023-02-27 20:14:23 +00:00
.. currentmodule:: lightning.fabric.plugins.environments
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
.. autosummary::
Update Fabric docs navigation (#16957)
2023-03-06 15:13:51 +00:00
:toctree: api/generated
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
:nosignatures:
:template: classtemplate_noindex.rst
~cluster_environment.ClusterEnvironment
~kubeflow.KubeflowEnvironment
~lightning.LightningEnvironment
~lsf.LSFEnvironment
Add MPI cluster environment (#16570) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-02-03 10:45:11 +00:00
~mpi.MPIEnvironment
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
~slurm.SLURMEnvironment
~torchelastic.TorchElasticEnvironment
~xla.XLAEnvironment
IO
""
docs: update `pytorch_lightning` imports (#16864) * update docs imports * ci * fabric * trigger * links * . * docstring * chlog * cleaning
2023-02-27 20:14:23 +00:00
.. currentmodule:: lightning.fabric.plugins.io
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
.. autosummary::
Update Fabric docs navigation (#16957)
2023-03-06 15:13:51 +00:00
:toctree: api/generated
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
:nosignatures:
:template: classtemplate.rst
~checkpoint_io.CheckpointIO
~torch_io.TorchCheckpointIO
~xla.XLACheckpointIO
Collectives
"""""""""""
docs: update `pytorch_lightning` imports (#16864) * update docs imports * ci * fabric * trigger * links * . * docstring * chlog * cleaning
2023-02-27 20:14:23 +00:00
.. currentmodule:: lightning.fabric.plugins.collectives
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
.. autosummary::
Update Fabric docs navigation (#16957)
2023-03-06 15:13:51 +00:00
:toctree: api/generated
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
:nosignatures:
:template: classtemplate.rst
Collective
TorchCollective
SingleDeviceCollective
Strategies
^^^^^^^^^^
.. TODO(fabric): include DeepSpeedStrategy, XLAStrategy
docs: update `pytorch_lightning` imports (#16864) * update docs imports * ci * fabric * trigger * links * . * docstring * chlog * cleaning
2023-02-27 20:14:23 +00:00
.. currentmodule:: lightning.fabric.strategies
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
.. autosummary::
Update Fabric docs navigation (#16957)
2023-03-06 15:13:51 +00:00
:toctree: api/generated
Update Lightning Lite docs (5/n) (#16291) * organize * organize * organize * organize * Fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * accelerator * distributed launch * notebooks * code structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lightning_module * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * x * update * conflicts * fix duplicates * links.rst * api folder * add todo for build errors * resolve duplicate reference warnings * address review by eden Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-01-10 19:11:03 +00:00
:nosignatures:
:template: classtemplate.rst
Strategy
DDPStrategy
DataParallelStrategy
FSDPStrategy
ParallelStrategy
SingleDeviceStrategy
SingleTPUStrategy