added lightning model docs

docs/index.md

@@ -1,7 +1,7 @@
 # PYTORCH-LIGHTNING DOCUMENTATION
 
 ###### Quick start
-- Define a lightning model   
+- [Define a LightningModule](Pytorch-Lightning/LightningModule/)  
 - Set up the trainer   
 
 ###### Quick start examples 

docs/source/examples/example_model.py

@@ -71,9 +71,6 @@ class ExampleModel(RootModule):
         # calculate loss
         loss_val = self.loss(y, y_hat)
 
-        # tqdm_dic = {'tng_loss': loss_val.item()}
-        # return loss_val, tqdm_dic
-
         output = OrderedDict({
             'loss': loss_val,
             'tqdm_metrics': {}
@@ -96,7 +93,6 @@ class ExampleModel(RootModule):
         labels_hat = torch.argmax(y_hat, dim=1)
         val_acc = torch.sum(y == labels_hat).item() / (len(y) * 1.0)
 
-        # output = {'y_hat': y_hat, 'val_loss': loss_val.item(), 'val_acc': val_acc}
         output = OrderedDict({
             'val_loss': loss_val,
             'val_acc': torch.tensor(val_acc),

mkdocs.yml

@@ -3,7 +3,7 @@ theme: readthedocs
 docs_dir: docs
 repo_url: https://github.com/williamFalcon/pytorch-lightning
 site_dir: 'site'
-site_description: 'Documentation for Pytorch Lightning, the researcher version of keras.'
+site_description: 'Documentation for Pytorch Pytorch-Lightning, the researcher version of keras.'
 
 dev_addr: '0.0.0.0:8000'
 #google_analytics: ['UA-aasd', 'sitename']