Skip to content

Commit 822231f

Browse files
author
Seppo Enarvi
committed
Fixed the documentation
1 parent 7920118 commit 822231f

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

docs/source-pytorch/glossary/index.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@
4242
Strategy registry <../advanced/strategy_registry>
4343
Strategy integrations <../integrations/strategies/index>
4444
Style guide <../starter/style_guide>
45-
SWA <../advanced/training_tricks>
4645
SLURM <../clouds/cluster_advanced>
4746
Tensor Parallel <../advanced/model_parallel/tp>
4847
Transfer learning <../advanced/transfer_learning>
4948
Trainer <../common/trainer>
5049
TorchRun (TorchElastic) <../clouds/cluster_intermediate_2>
5150
Warnings <../advanced/warnings>
51+
Weight averaging <../advanced/training_tricks>
5252

5353

5454
########
@@ -326,13 +326,6 @@ Glossary
326326
:button_link: ../starter/style_guide.html
327327
:height: 100
328328

329-
.. displayitem::
330-
:header: SWA
331-
:description: Stochastic Weight Averaging (SWA) can make your models generalize better
332-
:col_css: col-md-12
333-
:button_link: ../advanced/training_tricks.html#stochastic-weight-averaging
334-
:height: 100
335-
336329
.. displayitem::
337330
:header: SLURM
338331
:description: Simple Linux Utility for Resource Management, or simply Slurm, is a free and open-source job scheduler for Linux clusters
@@ -375,6 +368,13 @@ Glossary
375368
:button_link: ../advanced/warnings.html
376369
:height: 100
377370

371+
.. displayitem::
372+
:header: Weight averaging
373+
:description: Stochastic Weight Averaging (SWA) or Exponential Moving Average (EMA) can make your models generalize better
374+
:col_css: col-md-12
375+
:button_link: ../advanced/training_tricks.html#weight-averaging
376+
:height: 100
377+
378378
.. raw:: html
379379

380380
</div>

src/lightning/pytorch/callbacks/stochastic_weight_avg.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def __init__(
6565
6666
.. warning:: ``StochasticWeightAveraging`` is currently only supported on every epoch.
6767
68-
See also how to :ref:`enable it directly on the Trainer <advanced/training_tricks:Stochastic Weight Averaging>`
68+
See also how to :ref:`enable it directly on the Trainer <advanced/training_tricks:Weight Averaging>`.
6969
7070
Arguments:
7171

src/lightning/pytorch/callbacks/weight_averaging.py

+3
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@ class WeightAveraging(Callback):
5252
During validation and after the training finishes, the current model parameters will be replaced with the averaged
5353
values.
5454
55+
See also the documentation on the :ref:`weight averaging callbacks <advanced/training_tricks:Weight Averaging>`
56+
provided by Lightning.
57+
5558
Example::
5659
5760
from lightning.pytorch.callbacks import WeightAveraging

0 commit comments

Comments
 (0)