Skip to content

Latest commit

 

History

History
335 lines (252 loc) · 5.47 KB

api_references.rst

File metadata and controls

335 lines (252 loc) · 5.47 KB
Raw

API References

Accelerator API

pytorch_lightning.accelerators

Accelerator CPUAccelerator GPUAccelerator HPUAccelerator IPUAccelerator TPUAccelerator

Core API

pytorch_lightning.core

~hooks.CheckpointHooks ~hooks.DataHooks ~hooks.ModelHooks LightningDataModule LightningModule ~mixins.DeviceDtypeModuleMixin ~mixins.HyperparametersMixin ~optimizer.LightningOptimizer ~saving.ModelIO

Strategy API

pytorch_lightning.strategies

BaguaStrategy DDP2Strategy DDPFullyShardedStrategy DDPShardedStrategy DDPSpawnShardedStrategy DDPSpawnStrategy DDPStrategy DataParallelStrategy DeepSpeedStrategy HorovodStrategy HPUParallelStrategy IPUStrategy ParallelStrategy SingleDeviceStrategy SingleHPUStrategy SingleTPUStrategy Strategy TPUSpawnStrategy

Callbacks API

pytorch_lightning.callbacks

BackboneFinetuning BaseFinetuning BasePredictionWriter Callback DeviceStatsMonitor EarlyStopping GPUStatsMonitor GradientAccumulationScheduler LambdaCallback LearningRateMonitor ModelCheckpoint ModelPruning ModelSummary ProgressBarBase QuantizationAwareTraining RichModelSummary RichProgressBar StochasticWeightAveraging Timer TQDMProgressBar XLAStatsMonitor

Loggers API

pytorch_lightning.loggers

base comet csv_logs mlflow neptune tensorboard test_tube wandb

Loop API

Base Classes

pytorch_lightning.loops

~dataloader.dataloader_loop.DataLoaderLoop ~base.Loop

Default Loop Implementations

Training

pytorch_lightning.loops

~batch.TrainingBatchLoop ~epoch.TrainingEpochLoop FitLoop ~optimization.ManualOptimization ~optimization.OptimizerLoop

Validation and Testing

pytorch_lightning.loops

~epoch.EvaluationEpochLoop ~dataloader.EvaluationLoop

Prediction

pytorch_lightning.loops

~epoch.PredictionEpochLoop ~dataloader.PredictionLoop

Plugins API

Precision Plugins

pytorch_lightning.plugins.precision

ApexMixedPrecisionPlugin DeepSpeedPrecisionPlugin DoublePrecisionPlugin FullyShardedNativeMixedPrecisionPlugin HPUPrecisionPlugin IPUPrecisionPlugin MixedPrecisionPlugin NativeMixedPrecisionPlugin PrecisionPlugin ShardedNativeMixedPrecisionPlugin TPUBf16PrecisionPlugin TPUPrecisionPlugin

Cluster Environments

pytorch_lightning.plugins.environments

ClusterEnvironment KubeflowEnvironment LightningEnvironment LSFEnvironment SLURMEnvironment TorchElasticEnvironment

Checkpoint IO Plugins

pytorch_lightning.plugins.io

CheckpointIO HPUCheckpointIO TorchCheckpointIO XLACheckpointIO

Other Plugins

pytorch_lightning.plugins

LayerSync NativeSyncBatchNorm

Profiler API

pytorch_lightning.profiler

AdvancedProfiler PassThroughProfiler Profiler PyTorchProfiler SimpleProfiler XLAProfiler

Trainer API

pytorch_lightning.trainer.trainer

Trainer

LightningLite API

pytorch_lightning.lite

LightningLite

Tuner API

pytorch_lightning.tuner.tuning

Tuner

Utilities API

pytorch_lightning.utilities

apply_func argparse cli cloud_io deepspeed distributed finite_checks memory model_summary optimizer parsing rank_zero seed warnings