lightning/pl_examples
Adrian Wälchli f1623355bd
Add example table to loop docs (#10058)
Co-authored-by: tchaton <thomas@grid.ai>
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
2021-10-25 22:42:15 +00:00
..
basic_examples remove dataloader patching on the LightningModule (#9764) 2021-10-20 15:23:20 +02:00
domain_templates Update strategy flag in docs (#10000) 2021-10-20 21:02:53 +05:30
ipu_examples Replace `yapf` with `black` (#7783) 2021-07-26 13:37:35 +02:00
loop_examples Add Yield loop example (#9983) 2021-10-25 14:26:36 +00:00
README.md Add example table to loop docs (#10058) 2021-10-25 22:42:15 +00:00
__init__.py Replace `yapf` with `black` (#7783) 2021-07-26 13:37:35 +02:00
bug_report_model.py Add `enable_model_summary` flag and deprecate `weights_summary` (#9699) 2021-10-13 17:20:54 +05:30
run_examples.sh Call any trainer function from the `LightningCLI` (#7508) 2021-08-28 04:43:14 +00:00
test_examples.py Call any trainer function from the `LightningCLI` (#7508) 2021-08-28 04:43:14 +00:00

README.md

Examples

Our most robust examples showing all sorts of implementations can be found in our sister library lightning-bolts.


Basic examples

In this folder we add 3 simple examples:


Domain examples

This folder contains older examples. You should instead use the examples in lightning-bolts for advanced use cases.


Loop examples

Contains implementations leveraging loop customization to enhance the Trainer with new optimization routines.

  • K-fold Cross Validation Loop: Implemenation of cross validation in a loop and special datamodule.
  • Yield Loop: Enables yielding from the training_step like in a Python generator. Useful for automatic optimization with multiple optimizers.