Type Hints for Trainer (Lightning-AI#912)

Adrian Wälchli · williamFalcon · tullie · commit 6f8e9d77a1ce · 2020-04-03T05:47:50.000-07:00
* typehints for trainer 

fix type links in docs


fix types in docs


type hints for trainer methods


fix fit docs


switch to comments


readability


added sphinx typehints extension


wip


remove typehints from docstring


more type annotations


fix spaces

* Update trainer.py

Co-authored-by: William Falcon &lt;waf2107@columbia.edu&gt;
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -7,4 +7,5 @@ docutils
 sphinxcontrib-fulltoc
 sphinxcontrib-mockautodoc
 git+https://github.com/PytorchLightning/lightning_sphinx_theme.git
-# pip_shims
+# pip_shims
+sphinx-autodoc-typehints
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -86,6 +86,7 @@
     'sphinx.ext.autosectionlabel',
     # 'm2r',
     'nbsphinx',
+    'sphinx_autodoc_typehints',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
diff --git a/pytorch_lightning/trainer/trainer.py b/pytorch_lightning/trainer/trainer.py

Original file line number	Diff line number	Diff line change
`@@ -86,6 +86,7 @@`
`86`	`86`	`'sphinx.ext.autosectionlabel',`
`87`	`87`	`# 'm2r',`
`88`	`88`	`'nbsphinx',`
	`89`	`+ 'sphinx_autodoc_typehints',`
`89`	`90`	`]`
`90`	`91`
`91`	`92`	`# Add any paths that contain templates here, relative to this directory.`