Skip to content

Commit f8d9f8f

Browse files
williamFalconwilliamFalcon
authored
Clean docs (#725)
* updated gitignore * updated gitignore * updated links in ninja file * updated docs * finished callbacks * finished callbacks * finished callbacks * fixed left menu * added callbacks to menu * added direct links to docs * added direct links to docs * added direct links to docs * added direct links to docs * added direct links to docs * added direct links to docs * updated gitignore * updated links in ninja file * updated docs * finished callbacks * finished callbacks * finished callbacks * fixed left menu * added callbacks to menu * added direct links to docs * added direct links to docs * added direct links to docs * added direct links to docs * added direct links to docs * added direct links to docs * finished rebase * making private members * making private members * making private members * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * set auto dp if no backend * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * fixed lightning import * cleared spaces * cleared spaces * cleared spaces * cleared spaces * cleared spaces * cleared spaces * cleared spaces * cleared spaces * cleared spaces * cleared spaces * finished lightning module * finished lightning module * finished lightning module * finished lightning module * added callbacks * added loggers * added loggers * added loggers * added loggers * added loggers * added loggers * added loggers * added loggers * set auto dp if no backend * added loggers * added loggers * added loggers * added loggers * added loggers * added loggers * flake 8 * flake 8 * fix docs path * updated gitignore * updated gitignore * updated links in ninja file * updated docs * finished callbacks * finished callbacks * finished callbacks * fixed left menu * added callbacks to menu * added direct links to docs * added direct links to docs * added direct links to docs * added direct links to docs * added direct links to docs * added direct links to docs * updated gitignore * updated docs * finished callbacks * finished callbacks * finished callbacks * fixed left menu * added callbacks to menu * added direct links to docs * added direct links to docs * added direct links to docs * added direct links to docs * added direct links to docs * added direct links to docs * finished rebase * making private members * making private members * making private members * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * set auto dp if no backend * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * working on trainer docs * fixed lightning import * cleared spaces * cleared spaces * cleared spaces * cleared spaces * cleared spaces * finished lightning module * finished lightning module * finished lightning module * finished lightning module * added callbacks * added loggers * added loggers * added loggers * added loggers * added loggers * added loggers * added loggers * added loggers * added loggers * added loggers * added loggers * flake 8 * flake 8 * fix docs path * flake 8 * Update theme_variables.jinja
1 parent dfb6d36 commit f8d9f8f

File tree

15 files changed

+120
-21
lines changed

15 files changed

+120
-21
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ app/models/
66
pip-wheel-metadata/
77
lightning_logs/
88

9+
910
# Test-tube
1011
test_tube_logs/
1112
test_tube_data/
@@ -14,6 +15,7 @@ test_tube_exp/
1415
# Documentations
1516
docs/source/pl_examples*.rst
1617
docs/source/pytorch_lightning*.rst
18+
tests/tests/
1719
/docs/source/*.md
1820

1921
# Byte-compiled / optimized / DLL files
@@ -22,6 +24,7 @@ __pycache__/
2224
*$py.class
2325
timit_data/
2426

27+
2528
# C extensions
2629
*.so
2730

‎docs/source/callbacks.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. role:: hidden
2+
:class: hidden-section
3+
4+
Callbacks
5+
===========
6+
.. automodule:: pytorch_lightning.callbacks
7+
:exclude-members:
8+
_del_model,
9+
_save_model,
10+
on_epoch_end,
11+
on_train_end,
12+
on_epoch_begin,
13+
check_monitor_top_k,
14+
on_train_begin,

‎docs/source/common-cases.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Multi-gpu (same node) training
2+
==============================
3+
4+
Multi-node training
5+
====================
6+
7+
16-bit precision
8+
=================
9+
10+
gradient clipping
11+
=================
12+
13+
modifying training via hooks
14+
=============================
15+
16+
17+
18+
.. toctree::
19+
:maxdepth: 3
20+
21+
pl_examples

‎docs/source/index.rst‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,22 +44,20 @@ PyTorch-Lightning Documentation
4444

4545
common-cases
4646

47-
4847
.. toctree::
4948
:maxdepth: 1
5049
:name: community
5150
:caption: Community
5251

52+
5353
CODE_OF_CONDUCT.md
5454
CONTRIBUTING.md
5555
BECOMING_A_CORE_CONTRIBUTOR.md
5656
governance.md
5757

58-
5958
Indices and tables
6059
------------------
6160

6261
* :ref:`genindex`
6362
* :ref:`modindex`
6463
* :ref:`search`
65-

‎docs/source/lightning-module.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. role:: hidden
2+
:class: hidden-section
3+
4+
LightningModule
5+
===========
6+
.. automodule:: pytorch_lightning.core
7+
:exclude-members:
8+
_abc_impl,
9+
summarize,
10+

‎docs/source/logging.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. role:: hidden
2+
:class: hidden-section
3+
4+
Logging
5+
===========
6+
.. automodule:: pytorch_lightning.logging
7+
:exclude-members:
8+
_abc_impl,
9+
_save_model,
10+
on_epoch_end,
11+
on_train_end,
12+
on_epoch_begin,

‎docs/source/modules.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
pl_examples
2+
===========
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
pl_examples

‎docs/source/trainer.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. role:: hidden
2+
:class: hidden-section
3+
4+
Trainer
5+
===========
6+
.. automodule:: pytorch_lightning.trainer
7+
:members: fit, test
8+
:exclude-members:
9+
run_pretrain_routine,
10+
_abc_impl,
11+
_Trainer__set_root_gpu,
12+
_Trainer__init_optimizers,
13+
_Trainer__parse_gpu_ids,
14+
_Trainer__configure_schedulers,
15+
data_parallel,
16+
num_gpus,
17+
slurm_job_id,
18+
tng_tqdm_dic,
19+
training_tqdm_dict,
20+
init_optimizers,
21+
configure_schedulers

‎docs/source/tutorials.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Refactoring PyTorch into Lightning
2+
==================================
3+
`Tutorial <https://towardsdatascience.com/how-to-refactor-your-pytorch-code-to-get-these-42-benefits-of-pytorch-lighting-6fdd0dc97538>`_
4+
5+
Start a research project
6+
=========================
7+
`Research seed <https://github.com/PytorchLightning/pytorch-lightning-conference-seed>`_
8+
9+
Basic Lightning use
10+
====================
11+
`Tutorial <https://towardsdatascience.com/supercharge-your-ai-research-with-pytorch-lightning-337948a99eec>`_
12+
13+
9 key Lightning tricks
14+
========================
15+
`Tutorial <9 key speed features in Pytorch-Lightning>`_
16+
17+
Multi-node training on SLURM
18+
=============================
19+
`Tutorial <https://towardsdatascience.com/trivial-multi-node-training-with-pytorch-lightning-ff75dfb809bd>`_
20+

‎pytorch_lightning/callbacks/pt_callbacks.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
"""
22
Callbacks
3-
=========
4-
3+
====================================
54
Callbacks supported by Lightning
65
"""
76

8-
import logging
97
import os
108
import shutil
9+
import logging
1110
import warnings
12-
1311
import numpy as np
1412

1513
from pytorch_lightning.overrides.data_parallel import LightningDistributedDataParallel
@@ -165,7 +163,9 @@ def on_train_end(self, logs=None):
165163

166164

167165
class ModelCheckpoint(Callback):
168-
r"""Save the model after every epoch.
166+
r"""
167+
168+
Save the model after every epoch.
169169
170170
Args:
171171
filepath (str): path to save the model file.

0 commit comments

Comments
 (0)