Skip to content

Commit 615d563

Browse files
Jeff Yangrohitgr7Borda
authored
docs: configure_sync_batchnorm, amp, readme python/conda badge (Lightning-AI#3328)
* fix(docs): change to configure_sync_batchnorm for sync bn hook * Update docs/source/lightning-module.rst Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com> * distinguish pypi and conda download badges * python version badge and original pypi download badge * Update docs/source/lightning-module.rst Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com> Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
1 parent a552d4a commit 615d563

File tree

2 files changed

+17
-9
lines changed

2 files changed

+17
-9
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,11 @@
1818
</p>
1919

2020

21+
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pytorch-lightning)](https://pypi.org/project/pytorch-lightning/)
2122
[![PyPI Status](https://badge.fury.io/py/pytorch-lightning.svg)](https://badge.fury.io/py/pytorch-lightning)
2223
[![PyPI Status](https://pepy.tech/badge/pytorch-lightning)](https://pepy.tech/project/pytorch-lightning)
2324
[![Conda](https://img.shields.io/conda/v/conda-forge/pytorch-lightning?label=conda&color=success)](https://anaconda.org/conda-forge/pytorch-lightning)
25+
[![Conda](https://img.shields.io/conda/dn/conda-forge/pytorch-lightning?color=blue&label=conda%20downloads)](https://anaconda.org/conda-forge/pytorch-lightning)
2426
[![DockerHub](https://img.shields.io/docker/pulls/pytorchlightning/pytorch_lightning.svg)](https://hub.docker.com/r/pytorchlightning/pytorch_lightning)
2527
[![codecov](https://codecov.io/gh/PyTorchLightning/pytorch-lightning/branch/master/graph/badge.svg)](https://codecov.io/gh/PyTorchLightning/pytorch-lightning)
2628

docs/source/lightning_module.rst

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -897,6 +897,12 @@ Pointer to the trainer
897897
898898
------------
899899

900+
use_amp
901+
~~~~~~~
902+
True if using Automatic Mixed Precision (AMP)
903+
904+
------------
905+
900906
use_ddp
901907
~~~~~~~
902908
True if using ddp
@@ -1021,7 +1027,7 @@ configure_ddp
10211027
configure_sync_batchnorm
10221028
~~~~~~~~~~~~~~~~~~~~~~~~
10231029

1024-
.. autofunction:: pytorch_lightning.core.lightning.LightningModule.configure_ddp
1030+
.. autofunction:: pytorch_lightning.core.lightning.LightningModule.configure_sync_batchnorm
10251031
:noindex:
10261032

10271033
get_progress_bar_dict
@@ -1153,28 +1159,28 @@ on_pretrain_routine_end
11531159
.. autofunction:: pytorch_lightning.core.hooks.ModelHooks.on_pretrain_routine_end
11541160
:noindex:
11551161

1156-
on_test_epoch_start
1162+
on_test_batch_start
11571163
~~~~~~~~~~~~~~~~~~~
11581164

1159-
.. autofunction:: pytorch_lightning.core.hooks.ModelHooks.on_test_epoch_start
1165+
.. autofunction:: pytorch_lightning.core.hooks.ModelHooks.on_test_batch_start
11601166
:noindex:
11611167

1162-
on_test_epoch_end
1168+
on_test_batch_end
11631169
~~~~~~~~~~~~~~~~~
11641170

1165-
.. autofunction:: pytorch_lightning.core.hooks.ModelHooks.on_test_epoch_end
1171+
.. autofunction:: pytorch_lightning.core.hooks.ModelHooks.on_test_batch_end
11661172
:noindex:
11671173

1168-
on_test_batch_start
1174+
on_test_epoch_start
11691175
~~~~~~~~~~~~~~~~~~~
11701176

1171-
.. autofunction:: pytorch_lightning.core.hooks.ModelHooks.on_test_batch_start
1177+
.. autofunction:: pytorch_lightning.core.hooks.ModelHooks.on_test_epoch_start
11721178
:noindex:
11731179

1174-
on_test_batch_end
1180+
on_test_epoch_end
11751181
~~~~~~~~~~~~~~~~~
11761182

1177-
.. autofunction:: pytorch_lightning.core.hooks.ModelHooks.on_test_batch_end
1183+
.. autofunction:: pytorch_lightning.core.hooks.ModelHooks.on_test_epoch_end
11781184
:noindex:
11791185

11801186
on_train_batch_start

0 commit comments

Comments
 (0)