From 9bccb4ccddf7247f4aa2b33c2d68480e44e4003f Mon Sep 17 00:00:00 2001
From: William Falcon <waf2107@columbia.edu>
Date: Wed, 15 Jan 2020 21:43:04 -0500
Subject: [PATCH] added direct links to docs

---
 pytorch_lightning/core/lightning.py   | 12 +++++++++---
 pytorch_lightning/trainer/__init__.py |  3 ---
 2 files changed, 9 insertions(+), 6 deletions(-)

diff --git a/pytorch_lightning/core/lightning.py b/pytorch_lightning/core/lightning.py
index 07af367f..53646356 100644
--- a/pytorch_lightning/core/lightning.py
+++ b/pytorch_lightning/core/lightning.py
@@ -1,8 +1,14 @@
 """
-LightningModule
-====================================
+The LightningModule is the "system recipe." It groups the following in one file:
+    - computational system definition
+    - computations done on forward
+    - training loop
+    - validation loop
+    - testing loop
+    - train, val, test dataloaders
+    - optimizers
+"""
 
-"""
 import os
 import warnings
 import collections
diff --git a/pytorch_lightning/trainer/__init__.py b/pytorch_lightning/trainer/__init__.py
index e3ffd3e1..71138861 100644
--- a/pytorch_lightning/trainer/__init__.py
+++ b/pytorch_lightning/trainer/__init__.py
@@ -1,7 +1,4 @@
 """
-Trainer
-====================================
-
 The lightning Trainer abstracts best practices for running a training, val, test routine.
  It calls parts of your model when it wants to hand over full control and otherwise makes
  training assumptions which are now standard practice in AI research.