From 0f44c5067ae36af86f3290180a8709628bf556c0 Mon Sep 17 00:00:00 2001 From: William Falcon Date: Wed, 26 Jun 2019 19:33:50 -0400 Subject: [PATCH] added docs page --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index df489cba7c..51f971e04a 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,10 @@ This is a research tool I built for myself internally while doing my PhD. The AP Keras is too abstract for researchers. Lightning makes it so you only have to define your model but still control all details of training if you need to. To use lightning do 2 things: -1. Define a model with this interface +1. Define a model with the lightning interface. +2. Feed this model to the lightning trainer. + +*Example model definition* ```python from pytorch_lightning import RootModule @@ -48,8 +51,7 @@ class MyModel(RootModule): def add_model_specific_args(parent_parser): # add args for this model to your argparse ``` -2. Automate the training loop using the trainer - +*Example trainer* ```python from pytorch_lightning import Trainer from pytorch_lightning.utils.pt_callbacks import EarlyStopping, ModelCheckpoint