From 5735a366cfa0197423d4cf7c9b972c6e4846a701 Mon Sep 17 00:00:00 2001 From: William Falcon Date: Sat, 29 Jun 2019 18:08:57 -0400 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c768328..d79839d5 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,24 @@ To use lightning do 2 things: 2. [Define a LightningModel](https://github.com/williamFalcon/pytorch-lightning/blob/master/examples/new_project_templates/lightning_module_template.py). ## What does lightning control for me? -Everything! Except you define your data and what happens inside the training and validation loop. +Everything! +Except for these 6 core functions which you defind: + +```{.python} +# what to do in the training loop +def training_step(self, data_batch, batch_nb): + +# what to do in the validation loop +def validation_step(self, data_batch, batch_nb): + +# how to aggregate validation_step outputs +def validation_end(self, outputs): + +# and your dataloaders +def tng_dataloader(): +def val_dataloader(): +def test_dataloader(): +``` **Could be as complex as seq-2-seq + attention**