From 156dc3e5ee3e77560583d45c6c6a0b62a2b46bf8 Mon Sep 17 00:00:00 2001 From: William Falcon Date: Tue, 25 Jun 2019 18:40:34 -0400 Subject: [PATCH] updated args --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index ee15cccb4d..3020bdf801 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,24 @@ To use lightning do 2 things: 1. [Define a trainer](https://github.com/williamFalcon/pytorch-lightning/blob/master/docs/source/examples/basic_trainer.py) (which will run ALL your models). 2. [Define a model](https://github.com/williamFalcon/pytorch-lightning/blob/master/docs/source/examples/example_model.py). +#### Quick demo +Run the following demo to see how it works: +```bash + +# install lightning +pip install pytorch-lightning + +# clone lightning for the demo +git clone https://github.com/williamFalcon/pytorch-lightning.git +cd pytorch-lightning/docs/source/examples + +# run demo (on cpu) +python fully_featured_trainer.py + +# run demo on 2 gpus +python fully_featured_trainer.py --gpus "0;1" +``` + #### Basic trainer example See [this demo](https://github.com/williamFalcon/pytorch-lightning/blob/master/docs/source/examples/fully_featured_trainer.py) for a more robust trainer example.