PyTorch Lightning Documentation

Getting started

• Lightning in 2 steps
• How to organize PyTorch into Lightning
• Rapid prototyping templates

Best practices

• Speed up model training
• Managing Data
• Style guide
• Lightning project template
• Benchmark with vanilla PyTorch

Lightning API

• LightningModule
  • Minimal Example
  • Training
  • Inference
  • LightningModule API
• Trainer
  • Basic use
  • Under the hood
  • Trainer in Python scripts
  • Validation
  • Testing
  • Reproducibility
  • Trainer flags
  • Trainer class API

Optional extensions

• Accelerators
  • Accelerator API
• Callback
  • Examples
  • Built-in Callbacks
  • Persisting State
  • Best Practices
  • Available Callback hooks
• LightningDataModule
  • Why do I need a DataModule?
  • What is a DataModule
  • LightningDataModule API
  • Using a DataModule
  • DataModules without Lightning
• Logging
  • Logging from a LightningModule
  • Make a custom logger
  • Control logging frequency
  • Progress Bar
  • Configure console logging
  • Logging hyperparameters
  • Snapshot code
  • Supported Loggers
• Metrics
• Plugins
  • TrainingTypePlugin
  • PrecisionPlugin
  • Training Type Plugins
  • Precision Plugins
  • Cluster Environments

Tutorials

• Step-by-step walk-through
• PyTorch Lightning 101 class
• From PyTorch to PyTorch Lightning [Blog]
• From PyTorch to PyTorch Lightning [Video]
• Introduction to Pytorch Lightning
• PyTorch Lightning DataModules
• PyTorch Lightning CIFAR10 ~94% Baseline Tutorial
• PyTorch Lightning Basic GAN Tutorial
• TPU training with PyTorch Lightning
• Finetune Transformers Models with PyTorch Lightning
• How to train a Deep Q Network
• GPU and batched data augmentation with Kornia and PyTorch-Lightning

API References

• API References
  • Accelerator API
  • Core API
  • Callbacks API
  • Loggers API
  • Plugins API
  • Profiler API
  • Trainer API
  • Tuner API
  • Utilities API

Bolts

• Bolts

Examples

• Community Examples
• PyTorch Ecosystem Examples
• Autoencoder
• BYOL
• DQN
• GAN
• GPT-2
• Image-GPT
• SimCLR
• VAE

Common Use Cases

• Cloud Training
• Computing cluster
• Child Modules
• Debugging
• Early stopping
• Hyperparameters
• Inference in Production
• IPU support
• Lightning CLI and config files
• Learning Rate Finder
• Loggers
• Multi-GPU training
• Advanced GPU Optimized Training
• Saving and loading weights
• Optimization
• Performance and Bottleneck Profiler
• Sequential Data
• Single GPU Training
• Training Tricks
• Pruning and Quantization
• Transfer Learning
• TPU support
• Test set

Partner Domain Frameworks

• Conversational AI

Community

• Contributor Covenant Code of Conduct
• Contributing
• How to become a core contributor
• Lightning Governance | Persons of interest
• Changelog

Indices and tables

• Index

• Search Page