From 1de54e598ed6d6372451f9cb9053d9690f815ee3 Mon Sep 17 00:00:00 2001
From: William Falcon <falc@fb.com>
Date: Wed, 26 Jun 2019 20:15:18 -0400
Subject: [PATCH] added docs page

---
 docs/index.md | 26 +++++++++++++++++++-------
 1 file changed, 19 insertions(+), 7 deletions(-)

diff --git a/docs/index.md b/docs/index.md
index aef2d193..721bd042 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,10 +1,10 @@
 # PYTORCH-LIGHTNING DOCUMENTATION
 
 ###### Quick start
-- Model interface   
-- Trainer set up   
+- Define a lightning model   
+- Set up the trainer   
 
-###### Examples 
+###### Quick start examples 
 - CPU example   
 - Single GPU example   
 - Multi-gpu example 
@@ -20,10 +20,22 @@
 - Model saving
 - Model loading 
 
-###### Mixed precision training
-- 16-bit mixed precision
-
 ###### Computing cluster (SLURM)
 - Automatic checkpointing   
 - Automatic saving, loading   
-- Walltime auto-resubmit   
\ No newline at end of file
+- Walltime auto-resubmit   
+
+###### Common training use cases 
+- 16-bit mixed precision
+- Accumulate gradients
+- Check val many times during 1 training epoch
+- Check GPU usage
+- Check validation every n epochs
+- Check which gradients are nan
+- Inspect gradient norms
+- Learning rate annealing
+- Make model overfit on subset of data
+- Min, max epochs
+- Multiple optimizers (like GANs)
+- Run a sanity check of model val and tng step
+- Set how much of the tng, val, test sets to check (1-100%)