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/api_references.rst

282 lines
4.4 KiB
ReStructuredText
Raw Normal View History

logger docs and api docs (#3950) * logger and api docs * remove gpu_usage_logger, lr_logger * update docstring * fix wandb example * remove step result * charts * add some charts info Co-authored-by: Teddy Koker <teddy.koker@gmail.com> Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
2020-11-13 15:05:54 +00:00
API References
==============
CI: precommit - docformatter (#8584) * CI: precommit - docformatter * fix deprecated Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2021-09-06 12:49:09 +00:00
.. include:: links.rst
Accelerator API docs (#6936) Co-authored-by: ananthsub <ananth.subramaniam@gmail.com> Co-authored-by: William Falcon <waf2107@columbia.edu> Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
2021-04-10 06:55:07 +00:00
Accelerator API
---------------
.. currentmodule:: pytorch_lightning.accelerators
.. autosummary::
:toctree: api
:nosignatures:
:template: classtemplate.rst
Accelerator
CPUAccelerator
Update API references (#10040) Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com> Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
2021-10-20 18:10:39 +00:00
IPUAccelerator
Accelerator API docs (#6936) Co-authored-by: ananthsub <ananth.subramaniam@gmail.com> Co-authored-by: William Falcon <waf2107@columbia.edu> Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
2021-04-10 06:55:07 +00:00
GPUAccelerator
TPUAccelerator
logger docs and api docs (#3950) * logger and api docs * remove gpu_usage_logger, lr_logger * update docstring * fix wandb example * remove step result * charts * add some charts info Co-authored-by: Teddy Koker <teddy.koker@gmail.com> Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
2020-11-13 15:05:54 +00:00
Core API
--------
.. currentmodule:: pytorch_lightning.core
.. autosummary::
:toctree: api
:nosignatures:
datamodule
decorators
hooks
lightning
Callbacks API
-------------
.. currentmodule:: pytorch_lightning.callbacks
.. autosummary::
:toctree: api
:nosignatures:
base
early_stopping
gpu_stats_monitor
gradient_accumulation_scheduler
lr_monitor
model_checkpoint
progress
Loggers API
-----------
.. currentmodule:: pytorch_lightning.loggers
.. autosummary::
:toctree: api
:nosignatures:
base
comet
csv_logs
mlflow
neptune
tensorboard
test_tube
wandb
loop customization docs (#9609) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com> Co-authored-by: thomas chaton <thomas@grid.ai> Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com>
2021-10-18 09:43:11 +00:00
Loop API
--------
Base Classes
^^^^^^^^^^^^
.. currentmodule:: pytorch_lightning.loops
.. autosummary::
:toctree: api
:nosignatures:
:template: classtemplate.rst
~base.Loop
~dataloader.dataloader_loop.DataLoaderLoop
Default Loop Implementations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Training
""""""""
.. currentmodule:: pytorch_lightning.loops
.. autosummary::
:toctree: api
:nosignatures:
:template: classtemplate.rst
FitLoop
~epoch.TrainingEpochLoop
~batch.TrainingBatchLoop
~optimization.OptimizerLoop
~optimization.ManualOptimization
Validation and Testing
""""""""""""""""""""""
.. currentmodule:: pytorch_lightning.loops
.. autosummary::
:toctree: api
:nosignatures:
:template: classtemplate.rst
~dataloader.EvaluationLoop
~epoch.EvaluationEpochLoop
Prediction
""""""""""
.. currentmodule:: pytorch_lightning.loops
.. autosummary::
:toctree: api
:nosignatures:
:template: classtemplate.rst
~dataloader.PredictionLoop
~epoch.PredictionEpochLoop
Plugin Docs (#6952) Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com> Co-authored-by: William Falcon <waf2107@columbia.edu> Co-authored-by: ananthsub <ananth.subramaniam@gmail.com>
2021-04-14 20:53:21 +00:00
Plugins API
-----------
Training Type Plugins
^^^^^^^^^^^^^^^^^^^^^
.. currentmodule:: pytorch_lightning.plugins.training_type
.. autosummary::
:toctree: api
:nosignatures:
:template: classtemplate.rst
Rename the `TrainingTypePlugin` base to `Strategy` (#11120) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com> Co-authored-by: four4fish <88516121+four4fish@users.noreply.github.com>
2021-12-20 12:50:11 +00:00
Strategy
Rename `SingleDevicePlugin` to `SingleDeviceStrategy` (#11181) Co-authored-by: ananthsub <ananth.subramaniam@gmail.com> Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2021-12-21 23:56:14 +00:00
SingleDeviceStrategy
Rename `ParallelPlugin` to `ParallelStrategy` (#11123)
2021-12-22 01:09:17 +00:00
ParallelStrategy
Rename the `DataParallelPlugin` to `DataParallelStrategy` (#11183)
2021-12-21 22:00:24 +00:00
DataParallelStrategy
Rename `DDPPlugin` to `DDPStrategy` (#11142) * Raname DDPPlugin to DDPStrategy * Change ddp_plugin to ddp_strategy * update changelog * rename occurences in docs * rename more occurrences * fix line too long * more fixes Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2021-12-21 08:55:51 +00:00
DDPStrategy
Renamed the DDP2Plugin to DDP2Strategy (#11185) Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2021-12-21 19:21:00 +00:00
DDP2Strategy
Renamed DDPShardPlugin to DDPShardStrategy (#11187) Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2021-12-21 17:18:25 +00:00
DDPShardedStrategy
Rename the DDPSpawnShardedPlugin to DDPSpawnShardeedStrategy (#11210) Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2021-12-22 00:27:36 +00:00
DDPSpawnShardedStrategy
Renamed the `DDPSpawnPlugin` to `DDPSpawnStrategy` (#11145)
2021-12-21 23:06:14 +00:00
DDPSpawnStrategy
Rename DeepSpeedPlugin to DeepSpeedStrategy (#11194)
2021-12-21 15:18:01 +00:00
DeepSpeedStrategy
Rename HorovodPlugin to HorovodStrategy (#11195)
2021-12-21 13:31:41 +00:00
HorovodStrategy
Rename `SingleTPUPlugin` to `SingleTPUStrategy` (#11182)
2021-12-21 20:09:30 +00:00
SingleTPUStrategy
Rename `TPUSpawnPlugin` to `TPUSpawnStrategy` (#11190) Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2021-12-21 16:36:16 +00:00
TPUSpawnStrategy
Plugin Docs (#6952) Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com> Co-authored-by: William Falcon <waf2107@columbia.edu> Co-authored-by: ananthsub <ananth.subramaniam@gmail.com>
2021-04-14 20:53:21 +00:00
Renamed the `DDPSpawnPlugin` to `DDPSpawnStrategy` (#11145)
2021-12-21 23:06:14 +00:00
Plugin Docs (#6952) Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com> Co-authored-by: William Falcon <waf2107@columbia.edu> Co-authored-by: ananthsub <ananth.subramaniam@gmail.com>
2021-04-14 20:53:21 +00:00
Precision Plugins
^^^^^^^^^^^^^^^^^
.. currentmodule:: pytorch_lightning.plugins.precision
.. autosummary::
:toctree: api
:nosignatures:
:template: classtemplate.rst
PrecisionPlugin
Add `TPUPrecisionPlugin` (#10020) Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com> Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2021-10-19 17:48:57 +00:00
MixedPrecisionPlugin
Plugin Docs (#6952) Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com> Co-authored-by: William Falcon <waf2107@columbia.edu> Co-authored-by: ananthsub <ananth.subramaniam@gmail.com>
2021-04-14 20:53:21 +00:00
NativeMixedPrecisionPlugin
ShardedNativeMixedPrecisionPlugin
ApexMixedPrecisionPlugin
DeepSpeedPrecisionPlugin
Add `TPUPrecisionPlugin` (#10020) Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com> Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2021-10-19 17:48:57 +00:00
TPUPrecisionPlugin
Rename `TPUHalfPrecisionPlugin` to `TPUBf16PrecisionPlugin` (#10026) Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2021-10-19 21:09:37 +00:00
TPUBf16PrecisionPlugin
Plugin Docs (#6952) Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com> Co-authored-by: William Falcon <waf2107@columbia.edu> Co-authored-by: ananthsub <ananth.subramaniam@gmail.com>
2021-04-14 20:53:21 +00:00
DoublePrecisionPlugin
Add `TPUPrecisionPlugin` (#10020) Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com> Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2021-10-19 17:48:57 +00:00
FullyShardedNativeMixedPrecisionPlugin
IPUPrecisionPlugin
Plugin Docs (#6952) Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com> Co-authored-by: William Falcon <waf2107@columbia.edu> Co-authored-by: ananthsub <ananth.subramaniam@gmail.com>
2021-04-14 20:53:21 +00:00
Cluster Environments
^^^^^^^^^^^^^^^^^^^^
.. currentmodule:: pytorch_lightning.plugins.environments
.. autosummary::
:toctree: api
:nosignatures:
:template: classtemplate.rst
ClusterEnvironment
LightningEnvironment
Add LSFEnvironment to API reference (#8423)
2021-07-15 14:40:22 +00:00
LSFEnvironment
Plugin Docs (#6952) Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com> Co-authored-by: William Falcon <waf2107@columbia.edu> Co-authored-by: ananthsub <ananth.subramaniam@gmail.com>
2021-04-14 20:53:21 +00:00
TorchElasticEnvironment
Add kubeflow cluster environment (#7300) * Add kubeflow cluster environment * Add KubeflowEnvironment to docs * Add KubeflowEnvironment to the changelog * break up a long line * Add method to detect kubeflow environment * Select Kubeflow environment when available * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Run pre-commit * task_idx == 0 Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2021-05-17 08:05:24 +00:00
KubeflowEnvironment
Plugin Docs (#6952) Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com> Co-authored-by: William Falcon <waf2107@columbia.edu> Co-authored-by: ananthsub <ananth.subramaniam@gmail.com>
2021-04-14 20:53:21 +00:00
SLURMEnvironment
Introduce CheckpointIO Plugin (#8743)
2021-08-13 16:35:31 +00:00
Checkpoint IO Plugins
^^^^^^^^^^^^^^^^^^^^^
.. currentmodule:: pytorch_lightning.plugins.io
.. autosummary::
:toctree: api
:nosignatures:
:template: classtemplate.rst
CheckpointIO
TorchCheckpointIO
Add XLACheckpointIO (#9972) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2021-10-20 21:09:16 +00:00
XLACheckpointIO
Plugin Docs (#6952) Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com> Co-authored-by: William Falcon <waf2107@columbia.edu> Co-authored-by: ananthsub <ananth.subramaniam@gmail.com>
2021-04-14 20:53:21 +00:00
logger docs and api docs (#3950) * logger and api docs * remove gpu_usage_logger, lr_logger * update docstring * fix wandb example * remove step result * charts * add some charts info Co-authored-by: Teddy Koker <teddy.koker@gmail.com> Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
2020-11-13 15:05:54 +00:00
Profiler API
------------
.. currentmodule:: pytorch_lightning.profiler
.. autosummary::
:toctree: api
:nosignatures:
[doc] Move each profiler to its own file + Add missing PyTorchProfiler to the doc (#7822)
2021-06-04 15:38:29 +00:00
:template: classtemplate.rst
AbstractProfiler
AdvancedProfiler
BaseProfiler
PassThroughProfiler
PyTorchProfiler
SimpleProfiler
Update API references (#10040) Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com> Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
2021-10-20 18:10:39 +00:00
XLAProfiler
logger docs and api docs (#3950) * logger and api docs * remove gpu_usage_logger, lr_logger * update docstring * fix wandb example * remove step result * charts * add some charts info Co-authored-by: Teddy Koker <teddy.koker@gmail.com> Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
2020-11-13 15:05:54 +00:00
Trainer API
-----------
.. currentmodule:: pytorch_lightning.trainer
.. autosummary::
:toctree: api
:nosignatures:
trainer
Lightning Lite docs (#10176)
2021-10-30 10:25:52 +00:00
LightningLite API
-----------------
.. currentmodule:: pytorch_lightning.lite
.. autosummary::
:toctree: api
:nosignatures:
LightningLite
logger docs and api docs (#3950) * logger and api docs * remove gpu_usage_logger, lr_logger * update docstring * fix wandb example * remove step result * charts * add some charts info Co-authored-by: Teddy Koker <teddy.koker@gmail.com> Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
2020-11-13 15:05:54 +00:00
Tuner API
---------
Attach data refactor and tuner bugs [4/n] (#7258) Co-authored-by: Nicki Skafte <skaftenicki@gmail.com> Co-authored-by: Kaushik B <45285388+kaushikb11@users.noreply.github.com>
2021-04-30 13:54:58 +00:00
.. currentmodule:: pytorch_lightning.tuner.tuning
logger docs and api docs (#3950) * logger and api docs * remove gpu_usage_logger, lr_logger * update docstring * fix wandb example * remove step result * charts * add some charts info Co-authored-by: Teddy Koker <teddy.koker@gmail.com> Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
2020-11-13 15:05:54 +00:00
.. autosummary::
:toctree: api
:nosignatures:
Attach data refactor and tuner bugs [4/n] (#7258) Co-authored-by: Nicki Skafte <skaftenicki@gmail.com> Co-authored-by: Kaushik B <45285388+kaushikb11@users.noreply.github.com>
2021-04-30 13:54:58 +00:00
:template: classtemplate.rst
logger docs and api docs (#3950) * logger and api docs * remove gpu_usage_logger, lr_logger * update docstring * fix wandb example * remove step result * charts * add some charts info Co-authored-by: Teddy Koker <teddy.koker@gmail.com> Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
2020-11-13 15:05:54 +00:00
Attach data refactor and tuner bugs [4/n] (#7258) Co-authored-by: Nicki Skafte <skaftenicki@gmail.com> Co-authored-by: Kaushik B <45285388+kaushikb11@users.noreply.github.com>
2021-04-30 13:54:58 +00:00
Tuner
logger docs and api docs (#3950) * logger and api docs * remove gpu_usage_logger, lr_logger * update docstring * fix wandb example * remove step result * charts * add some charts info Co-authored-by: Teddy Koker <teddy.koker@gmail.com> Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
2020-11-13 15:05:54 +00:00
Utilities API
-------------
.. currentmodule:: pytorch_lightning.utilities
.. autosummary::
:toctree: api
:nosignatures:
Simple reproducibility with minimum boilerplate CLI training with `LightningCLI` (#4492) Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com> Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
2021-04-06 13:19:11 +00:00
cli
Fix argparse docs (#7148)
2021-04-22 00:13:00 +00:00
argparse
logger docs and api docs (#3950) * logger and api docs * remove gpu_usage_logger, lr_logger * update docstring * fix wandb example * remove step result * charts * add some charts info Co-authored-by: Teddy Koker <teddy.koker@gmail.com> Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
2020-11-13 15:05:54 +00:00
seed