From 1cd5dde16423662048ea0c98c344d8109dae285a Mon Sep 17 00:00:00 2001 From: William Falcon Date: Tue, 13 Aug 2019 12:11:24 -0400 Subject: [PATCH] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c8280854c2..7c22a14672 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,9 @@ Don't worry about training on multiple gpus or speeding up your code, lightning --- ## How do I do use it? -The research code goes into a LightningModule and you train it using a Trainer. Think of the LightningModule as a *system* such as seq-2-seq, GAN, etc... However, the LightningModule can ALSO just be a simple classifier such as the example below. +The research code goes into a [LightningModule]((https://williamfalcon.github.io/pytorch-lightning/LightningModule/RequiredTrainerInterface/)) which you fit using a Trainer. + +Think of the LightningModule as a *system* such as seq-2-seq, GAN, etc... However, the LightningModule can ALSO just be a simple classifier such as the example below. To use lightning do 2 things: 1. [Define a LightningModule](https://williamfalcon.github.io/pytorch-lightning/LightningModule/RequiredTrainerInterface/)