wassname/pytorch-lightning
1
0
Fork 0
mirror of https://github.com/wassname/pytorch-lightning.git synced 2026-09-10 12:21:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

doctest for .rst files (#1511)

Browse Source 
* add doctest to circleci

* Revert "add doctest to circleci"

This reverts commit c45b34ea911a81f87989f6c3a832b1e8d8c471c6.

* Revert "Revert "add doctest to circleci""

This reverts commit 41fca97fdcfe1cf4f6bdb3bbba75d25fa3b11f70.

* doctest docs rst files

* Revert "doctest docs rst files"

This reverts commit b4a2e83e3da5ed1909de500ec14b6b614527c07f.

* doctest only rst

* doctest debugging.rst

* doctest apex

* doctest callbacks

* doctest early stopping

* doctest for child modules

* doctest experiment reporting

* indentation

* doctest fast training

* doctest for hyperparams

* doctests for lr_finder

* doctests multi-gpu

* more doctest

* make doctest drone

* fix label build error

* update fast training

* update invalid imports

* fix problem with int device count

* rebase stuff

* wip

* wip

* wip

* intro guide

* add missing code block

* circleci

* logger import for doctest

* test if doctest runs on drone

* fix mnist download

* also run install deps for building docs

* install cmake

* try sudo

* hide output

* try pip stuff

* try to mock horovod

* Tranfer -> Transfer

* add torchvision to extras

* revert pip stuff

* mlflow file location

* do not mock torch

* torchvision

* drone extra req.

* try higher sphinx version

* Revert "try higher sphinx version"

This reverts commit 490ac28e46d6fd52352640dfdf0d765befa56988.

* try coverage command

* try coverage command

* try undoc flag

* newline

* undo drone

* report coverage

* review

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>

* remove torchvision from extras

* skip tests only if torchvision not available

* fix testoutput torchvision

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
This commit is contained in:
Adrian Wälchli
2020-05-04 22:16:54 -04:00
committed by GitHub
co-authored by Jirka Borovec
parent 48e808c20e
commit a6de1b8d75
25 changed files with 798 additions and 637 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/debugging.rst
+15 -11
View File
@@ -1,3 +1,7 @@
.. testsetup:: *
from pytorch_lightning.trainer.trainer import Trainer
Debugging
=========
The following are flags that make debugging much easier.
@@ -11,9 +15,9 @@ a full epoch to crash.
(See: :paramref:`~pytorch_lightning.trainer.trainer.Trainer.fast_dev_run`
argument of :class:`~pytorch_lightning.trainer.trainer.Trainer`)
.. code-block:: python
.. testcode::
trainer = pl.Trainer(fast_dev_run=True)
trainer = Trainer(fast_dev_run=True)
Inspect gradient norms
----------------------
@@ -22,10 +26,10 @@ Logs (to a logger), the norm of each weight matrix.
(See: :paramref:`~pytorch_lightning.trainer.trainer.Trainer.track_grad_norm`
argument of :class:`~pytorch_lightning.trainer.trainer.Trainer`)
.. code-block:: python
.. testcode::
# the 2-norm
trainer = pl.Trainer(track_grad_norm=2)
trainer = Trainer(track_grad_norm=2)
Log GPU usage
-------------
@@ -34,9 +38,9 @@ Logs (to a logger) the GPU usage for each GPU on the master machine.
(See: :paramref:`~pytorch_lightning.trainer.trainer.Trainer.log_gpu_memory`
argument of :class:`~pytorch_lightning.trainer.trainer.Trainer`)
.. code-block:: python
.. testcode::
trainer = pl.Trainer(log_gpu_memory=True)
trainer = Trainer(log_gpu_memory=True)
Make model overfit on subset of data
------------------------------------
@@ -47,9 +51,9 @@ and try to get your model to overfit. If it can't, it's a sign it won't work wit
(See: :paramref:`~pytorch_lightning.trainer.trainer.Trainer.overfit_pct`
argument of :class:`~pytorch_lightning.trainer.trainer.Trainer`)
.. code-block:: python
.. testcode::
trainer = pl.Trainer(overfit_pct=0.01)
trainer = Trainer(overfit_pct=0.01)
Print the parameter count by layer
----------------------------------
@@ -59,9 +63,9 @@ To disable this behavior, turn off this flag:
(See: :paramref:`~pytorch_lightning.trainer.trainer.Trainer.weights_summary`
argument of :class:`~pytorch_lightning.trainer.trainer.Trainer`)
.. code-block:: python
.. testcode::
trainer = pl.Trainer(weights_summary=None)
trainer = Trainer(weights_summary=None)
Set the number of validation sanity steps
@@ -72,7 +76,7 @@ This avoids crashing in the validation loop sometime deep into a lengthy trainin
(See: :paramref:`~pytorch_lightning.trainer.trainer.Trainer.num_sanity_val_steps`
argument of :class:`~pytorch_lightning.trainer.trainer.Trainer`)
.. code-block:: python
.. testcode::
# DEFAULT
trainer = Trainer(num_sanity_val_steps=5)