clean v2 docs #691
clean v2 docs #691
Conversation
| @@ -14,6 +14,8 @@ tests/save_dir | |||
| default/ | |||
| lightning_logs/ | |||
| tests/tests/ | |||
| *.rst | |||
| /docs/source/*.md | |||
There was a problem hiding this comment.
just thinking about making the copy of the github pages to a sub-folder so then we we can write the ignore more specific...
| @@ -14,6 +14,8 @@ tests/save_dir | |||
| default/ | |||
| lightning_logs/ | |||
| tests/tests/ | |||
| *.rst | |||
There was a problem hiding this comment.
I would rather write
pl_examples.rst
pl_examples.*.rst
pytorch_lightning.rst
pytorch_lightning.*.rst
| verbose: verbosity mode, 0 or 1. | ||
| save_top_k: if `save_top_k == k`, | ||
| r""" | ||
|
|
| training will stop when the quantity | ||
| monitored has stopped decreasing; in `max` | ||
| mode it will stop when the quantity | ||
| monitored has stopped increasing; in `auto` | ||
| mode, the direction is automatically inferred | ||
| from the name of the monitored quantity. | ||
|
|
||
| Example: | ||
| >>> from pytorch_lightning import Trainer |
There was a problem hiding this comment.
pls remove >>> or keep it and shift left so it become a doctest
| >>> # save epoch and val_loss in name | ||
| >>> ModelCheckpoint(filepath='{epoch:02d}-{val_loss:.2f}.hdf5') | ||
| >>> # saves file like: /path/epoch_2-val_loss_0.2.hdf5 | ||
| monitor (str): quantity to monitor. |
There was a problem hiding this comment.
We shall decide what kind of documentation we are going to use...
https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
pytorch_lightning/core/lightning.py
Outdated
| @@ -1,3 +1,14 @@ | |||
| """ | |||
| The LightningModule is the "system recipe." It groups the following in one file: | |||
| - computational system definition | |||
There was a problem hiding this comment.
I think that it needs a blank line to be treated as a list, be aware that reStructuredText and MarkDown formatting is a bit different...
http://www.unexpected-vortices.com/doc-notes/markdown-and-rest-compared.html
* flake8 * fix typo * fix tensorboardlogger drop test_tube dependence * formatting * fix tensorboard & tests * upgrade Tensorboard * test formatting separately * try to fix JIT issue * add tests for 1.4
|
@Borda ready for review!
|
Improves on v1 of new docs started by @Borda
https://torch-lightning.readthedocs.io/en/paths/documentation.html