diff --git a/docs/index.md b/docs/index.md index ba5ec0e7..2a9c156f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,11 @@ ###### New project Quick Start -To start a new project define these two files. +To start a new project you define two files, a LightningModule and a Trainer file. +A separate trainer file allows to run many LightningModules. Each LightningModule has the core +logic to a particular research project. For example, one lightningModule could be an image classifier, the other +one could be a seq-2-seq model, both (optionally) ran by the same trainer file. -1. [Define a LightningModule](https://williamfalcon.github.io/pytorch-lightning/LightningModule/RequiredTrainerInterface/#minimal-example) -2. [Define a trainer](https://williamfalcon.github.io/pytorch-lightning/Trainer/) +1. [LightningModule](https://williamfalcon.github.io/pytorch-lightning/LightningModule/RequiredTrainerInterface/#minimal-example) +2. [Trainer](https://williamfalcon.github.io/pytorch-lightning/Trainer/) - [Basic CPU Trainer Template](https://github.com/williamFalcon/pytorch-lightning/blob/master/pytorch_lightning/examples/new_project_templates/single_cpu_template.py) - [Multi-GPU Trainer Template](https://github.com/williamFalcon/pytorch-lightning/blob/master/pytorch_lightning/examples/new_project_templates/single_gpu_node_template.py) - [GPU cluster Trainer Template](https://github.com/williamFalcon/pytorch-lightning/blob/master/pytorch_lightning/examples/new_project_templates/multi_node_cluster_template.py)