Lightning Template

Lightning Template#

Lightning Template is a generic project template lib based on pytorch lightning for project-template with the following features:

  • All features from pytorch lightning and lightning CLI. Especially, the experiment manager feature, auto-implementing multi-node, multi-device, multi-accelerator support, etc.

  • Powerful deep update feature for config file inherit to manage your config files more hierarchically, see also recommend structure.

  • Multi and complex optimizers and lr_scheduler from CLI config support, see doc.

  • Cross-validation support with only one argument you have to change, see doc.

  • Hyperparameters tuning via Wandb, see the doc and wandb sweep.

  • Powerful and flexible LightningModule and LightningDataModule base class.

  • Useful auto lr finder and auto batch size scaler, see doc.

Installation Guides

Get started by installing Lightning Template.

Usage Guides

Details of the core features provide by Lightning Template.

API Reference Guides

References of the API provided by Lightning Template.

Contribution Guides

Helpful instruction to develop Lightning Template.