2021-09-06 12:49:09 +00:00
|
|
|
.. include:: links.rst
|
|
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
accelerators
|
|
|
|
|
------------
|
2021-04-10 06:55:07 +00:00
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.accelerators
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: classtemplate.rst
|
|
|
|
|
|
|
|
|
|
Accelerator
|
|
|
|
|
CPUAccelerator
|
2022-07-19 10:16:35 +00:00
|
|
|
CUDAAccelerator
|
2022-03-25 10:24:52 +00:00
|
|
|
HPUAccelerator
|
2022-01-07 14:56:17 +00:00
|
|
|
IPUAccelerator
|
2021-04-10 06:55:07 +00:00
|
|
|
TPUAccelerator
|
|
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
callbacks
|
|
|
|
|
---------
|
2020-11-13 15:05:54 +00:00
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.callbacks
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
2022-03-01 13:53:03 +00:00
|
|
|
:template: classtemplate.rst
|
2020-11-13 15:05:54 +00:00
|
|
|
|
2022-03-01 13:53:03 +00:00
|
|
|
BackboneFinetuning
|
|
|
|
|
BaseFinetuning
|
|
|
|
|
BasePredictionWriter
|
|
|
|
|
Callback
|
|
|
|
|
DeviceStatsMonitor
|
|
|
|
|
EarlyStopping
|
|
|
|
|
GradientAccumulationScheduler
|
|
|
|
|
LambdaCallback
|
|
|
|
|
LearningRateMonitor
|
|
|
|
|
ModelCheckpoint
|
|
|
|
|
ModelPruning
|
|
|
|
|
ModelSummary
|
|
|
|
|
ProgressBarBase
|
|
|
|
|
QuantizationAwareTraining
|
|
|
|
|
RichModelSummary
|
|
|
|
|
RichProgressBar
|
|
|
|
|
StochasticWeightAveraging
|
|
|
|
|
Timer
|
|
|
|
|
TQDMProgressBar
|
2020-11-13 15:05:54 +00:00
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
core
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.core
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: classtemplate.rst
|
|
|
|
|
|
|
|
|
|
~hooks.CheckpointHooks
|
|
|
|
|
~hooks.DataHooks
|
|
|
|
|
~hooks.ModelHooks
|
|
|
|
|
LightningDataModule
|
|
|
|
|
LightningModule
|
|
|
|
|
~mixins.DeviceDtypeModuleMixin
|
|
|
|
|
~mixins.HyperparametersMixin
|
|
|
|
|
~optimizer.LightningOptimizer
|
|
|
|
|
~saving.ModelIO
|
|
|
|
|
|
|
|
|
|
lightninglite
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.lite
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
|
|
|
|
|
|
|
|
|
LightningLite
|
|
|
|
|
|
|
|
|
|
loggers
|
|
|
|
|
-------
|
2020-11-13 15:05:54 +00:00
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.loggers
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
|
|
|
|
|
|
|
|
|
base
|
|
|
|
|
comet
|
|
|
|
|
csv_logs
|
|
|
|
|
mlflow
|
|
|
|
|
neptune
|
|
|
|
|
tensorboard
|
|
|
|
|
wandb
|
|
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
loops
|
|
|
|
|
^^^^^
|
2021-10-18 09:43:11 +00:00
|
|
|
|
|
|
|
|
Base Classes
|
2022-04-19 18:15:47 +00:00
|
|
|
""""""""""""
|
2021-10-18 09:43:11 +00:00
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.loops
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: classtemplate.rst
|
|
|
|
|
|
|
|
|
|
~dataloader.dataloader_loop.DataLoaderLoop
|
2022-01-07 14:56:17 +00:00
|
|
|
~base.Loop
|
2021-10-18 09:43:11 +00:00
|
|
|
|
|
|
|
|
Training
|
|
|
|
|
""""""""
|
|
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.loops
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: classtemplate.rst
|
|
|
|
|
|
|
|
|
|
~batch.TrainingBatchLoop
|
2022-01-07 14:56:17 +00:00
|
|
|
~epoch.TrainingEpochLoop
|
|
|
|
|
FitLoop
|
2021-10-18 09:43:11 +00:00
|
|
|
~optimization.ManualOptimization
|
2022-01-07 14:56:17 +00:00
|
|
|
~optimization.OptimizerLoop
|
2021-10-18 09:43:11 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Validation and Testing
|
|
|
|
|
""""""""""""""""""""""
|
|
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.loops
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: classtemplate.rst
|
|
|
|
|
|
|
|
|
|
~epoch.EvaluationEpochLoop
|
2022-01-07 14:56:17 +00:00
|
|
|
~dataloader.EvaluationLoop
|
2021-10-18 09:43:11 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Prediction
|
|
|
|
|
""""""""""
|
|
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.loops
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: classtemplate.rst
|
|
|
|
|
|
|
|
|
|
~epoch.PredictionEpochLoop
|
2022-01-07 14:56:17 +00:00
|
|
|
~dataloader.PredictionLoop
|
2021-10-18 09:43:11 +00:00
|
|
|
|
|
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
plugins
|
|
|
|
|
^^^^^^^
|
2021-04-14 20:53:21 +00:00
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
precision
|
|
|
|
|
"""""""""
|
2021-04-14 20:53:21 +00:00
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.plugins.precision
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: classtemplate.rst
|
|
|
|
|
|
|
|
|
|
ApexMixedPrecisionPlugin
|
|
|
|
|
DeepSpeedPrecisionPlugin
|
|
|
|
|
DoublePrecisionPlugin
|
2021-10-19 17:48:57 +00:00
|
|
|
FullyShardedNativeMixedPrecisionPlugin
|
2022-03-25 10:24:52 +00:00
|
|
|
HPUPrecisionPlugin
|
2021-10-19 17:48:57 +00:00
|
|
|
IPUPrecisionPlugin
|
2022-01-07 14:56:17 +00:00
|
|
|
MixedPrecisionPlugin
|
|
|
|
|
NativeMixedPrecisionPlugin
|
|
|
|
|
PrecisionPlugin
|
|
|
|
|
ShardedNativeMixedPrecisionPlugin
|
|
|
|
|
TPUBf16PrecisionPlugin
|
|
|
|
|
TPUPrecisionPlugin
|
2021-04-14 20:53:21 +00:00
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
environments
|
|
|
|
|
""""""""""""
|
2021-04-14 20:53:21 +00:00
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.plugins.environments
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: classtemplate.rst
|
|
|
|
|
|
|
|
|
|
ClusterEnvironment
|
2022-01-07 14:56:17 +00:00
|
|
|
KubeflowEnvironment
|
2021-04-14 20:53:21 +00:00
|
|
|
LightningEnvironment
|
2021-07-15 14:40:22 +00:00
|
|
|
LSFEnvironment
|
2021-04-14 20:53:21 +00:00
|
|
|
SLURMEnvironment
|
2022-01-07 14:56:17 +00:00
|
|
|
TorchElasticEnvironment
|
2022-06-22 08:57:50 +00:00
|
|
|
XLAEnvironment
|
2021-04-14 20:53:21 +00:00
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
io
|
|
|
|
|
""
|
2021-08-13 16:35:31 +00:00
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.plugins.io
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: classtemplate.rst
|
|
|
|
|
|
2022-07-26 15:43:19 +00:00
|
|
|
AsyncCheckpointIO
|
2021-08-13 16:35:31 +00:00
|
|
|
CheckpointIO
|
2022-03-25 10:24:52 +00:00
|
|
|
HPUCheckpointIO
|
2021-08-13 16:35:31 +00:00
|
|
|
TorchCheckpointIO
|
2021-10-20 21:09:16 +00:00
|
|
|
XLACheckpointIO
|
2021-04-14 20:53:21 +00:00
|
|
|
|
2022-03-01 14:11:40 +00:00
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
others
|
|
|
|
|
""""""
|
2022-03-01 14:11:40 +00:00
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.plugins
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: classtemplate.rst
|
|
|
|
|
|
|
|
|
|
LayerSync
|
|
|
|
|
NativeSyncBatchNorm
|
|
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
profiler
|
|
|
|
|
--------
|
2020-11-13 15:05:54 +00:00
|
|
|
|
2022-06-22 14:57:19 +00:00
|
|
|
.. currentmodule:: pytorch_lightning.profilers
|
2020-11-13 15:05:54 +00:00
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
2021-06-04 15:38:29 +00:00
|
|
|
:template: classtemplate.rst
|
|
|
|
|
|
|
|
|
|
AdvancedProfiler
|
|
|
|
|
PassThroughProfiler
|
2022-03-21 20:17:03 +00:00
|
|
|
Profiler
|
2021-06-04 15:38:29 +00:00
|
|
|
PyTorchProfiler
|
|
|
|
|
SimpleProfiler
|
2021-10-20 18:10:39 +00:00
|
|
|
XLAProfiler
|
2020-11-13 15:05:54 +00:00
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
trainer
|
|
|
|
|
-------
|
2020-11-13 15:05:54 +00:00
|
|
|
|
2022-01-07 14:56:17 +00:00
|
|
|
.. currentmodule:: pytorch_lightning.trainer.trainer
|
2020-11-13 15:05:54 +00:00
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
2022-01-07 14:56:17 +00:00
|
|
|
:template: classtemplate.rst
|
2020-11-13 15:05:54 +00:00
|
|
|
|
2022-01-07 14:56:17 +00:00
|
|
|
Trainer
|
2020-11-13 15:05:54 +00:00
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
strategies
|
|
|
|
|
----------
|
2021-10-30 10:25:52 +00:00
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
.. currentmodule:: pytorch_lightning.strategies
|
2021-10-30 10:25:52 +00:00
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
2022-04-19 18:15:47 +00:00
|
|
|
:template: classtemplate.rst
|
2021-10-30 10:25:52 +00:00
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
BaguaStrategy
|
2022-06-23 15:44:48 +00:00
|
|
|
HivemindStrategy
|
2022-04-19 18:15:47 +00:00
|
|
|
DDPFullyShardedStrategy
|
|
|
|
|
DDPShardedStrategy
|
|
|
|
|
DDPSpawnShardedStrategy
|
|
|
|
|
DDPSpawnStrategy
|
|
|
|
|
DDPStrategy
|
|
|
|
|
DataParallelStrategy
|
|
|
|
|
DeepSpeedStrategy
|
|
|
|
|
HorovodStrategy
|
|
|
|
|
HPUParallelStrategy
|
|
|
|
|
IPUStrategy
|
|
|
|
|
ParallelStrategy
|
|
|
|
|
SingleDeviceStrategy
|
|
|
|
|
SingleHPUStrategy
|
|
|
|
|
SingleTPUStrategy
|
|
|
|
|
Strategy
|
|
|
|
|
TPUSpawnStrategy
|
2021-10-30 10:25:52 +00:00
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
tuner
|
|
|
|
|
-----
|
2020-11-13 15:05:54 +00:00
|
|
|
|
2021-04-30 13:54:58 +00:00
|
|
|
.. currentmodule:: pytorch_lightning.tuner.tuning
|
2020-11-13 15:05:54 +00:00
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
2021-04-30 13:54:58 +00:00
|
|
|
:template: classtemplate.rst
|
2020-11-13 15:05:54 +00:00
|
|
|
|
2021-04-30 13:54:58 +00:00
|
|
|
Tuner
|
2020-11-13 15:05:54 +00:00
|
|
|
|
2022-04-19 18:15:47 +00:00
|
|
|
utilities
|
|
|
|
|
---------
|
2020-11-13 15:05:54 +00:00
|
|
|
|
|
|
|
|
.. currentmodule:: pytorch_lightning.utilities
|
|
|
|
|
|
|
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: api
|
|
|
|
|
:nosignatures:
|
|
|
|
|
|
2022-01-13 13:22:58 +00:00
|
|
|
apply_func
|
2021-04-22 00:13:00 +00:00
|
|
|
argparse
|
2022-01-13 13:22:58 +00:00
|
|
|
cli
|
|
|
|
|
cloud_io
|
|
|
|
|
deepspeed
|
|
|
|
|
distributed
|
|
|
|
|
finite_checks
|
|
|
|
|
memory
|
|
|
|
|
model_summary
|
2022-02-18 08:36:07 +00:00
|
|
|
optimizer
|
2022-01-13 13:22:58 +00:00
|
|
|
parsing
|
2022-02-07 08:09:55 +00:00
|
|
|
rank_zero
|
2020-11-13 15:05:54 +00:00
|
|
|
seed
|
2022-01-13 13:22:58 +00:00
|
|
|
warnings
|
