From f47a6a359ae7968ce2e32930210fa1580cbf806c Mon Sep 17 00:00:00 2001 From: William Falcon Date: Fri, 28 Jun 2019 18:44:44 -0400 Subject: [PATCH] added module properties docs --- docs/index.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index dea92070..04f62f6f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,15 +1,17 @@ # PYTORCH-LIGHTNING DOCUMENTATION -###### Doc Shortcuts -- [LightningModule](LightningModule/RequiredTrainerInterface/) -- [Trainer](Trainer/) +###### New project Quick Start +To start a new project define these two files. -###### New project Quick Start 1. [Define a LightningModule](LightningModule/Examples#template-model-definition) 2. Pick a trainer - [Basic CPU Trainer](https://github.com/williamFalcon/pytorch-lightning/blob/master/examples/new_project_templates/trainer_cpu_template.py) - [GPU cluster Trainer](https://github.com/williamFalcon/pytorch-lightning/blob/master/examples/new_project_templates/trainer_gpu_cluster_template.py) +###### Doc Shortcuts +- [LightningModule](LightningModule/RequiredTrainerInterface/) +- [Trainer](Trainer/) + ###### Quick start examples - [CPU example](https://williamfalcon.github.io/pytorch-lightning/Examples/#cpu-hyperparameter-search) - [Hyperparameter search on single GPU](https://williamfalcon.github.io/pytorch-lightning/Examples/#hyperparameter-search-on-a-single-or-multiple-gpus)