Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixed docs issue in ReduceLROnPlateauScheduler #2976

Merged
merged 3 commits into from
Jun 29, 2023
Merged

Fixed docs issue in ReduceLROnPlateauScheduler #2976

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc22b99
Update param_scheduler.py
vfdev-5 Jun 28, 2023
bfdfa50
Update param_scheduler.py
vfdev-5 Jun 28, 2023
6c38fe3
Update param_scheduler.py
vfdev-5 Jun 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions ignite/handlers/param_scheduler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1508,20 +1508,19 @@ class ReduceLROnPlateauScheduler(ParamScheduler):
Default: False.
param_group_index: `optimizer`'s parameters group
to use. Default: None. Use all `optimizer`'s paramater groups.
**scheduler_kwargs: Keyword arguments to be passed to the wrapped
`ReduceLROnPlateau`.
scheduler_kwargs: Keyword arguments to be passed to the wrapped ``ReduceLROnPlateau``.

Examples:

.. code-block python
.. code-block:: python

# Metric 'metric-name' should surpass its best value by
# Metric "accuracy" should increase the best value by
# more than 1 unit after at most 2 epochs, otherwise LR
# would get multiplied by 0.5 .

scheduler = ReduceLROnPlateauScheduler(
default_optimizer,
metric_name="metric-name", mode="max",
metric_name="accuracy", mode="max",
factor=0.5, patience=1, threshold_mode='abs',
threshold=1, trainer=trainer
)
Expand All @@ -1538,10 +1537,10 @@ class ReduceLROnPlateauScheduler(ParamScheduler):

default_trainer = get_default_trainer()

# Metric `loss` should decrease more than
# a tenth of best loss after at most
# Metric "loss" should decrease more than
# 0.1 of best loss after at most
# three iterations. Then best loss would get
# updated, otherwise lr is multiplied by 2
# updated, otherwise lr is multiplied by 0.5

scheduler = ReduceLROnPlateauScheduler(
default_optimizer, "loss",
Expand Down
Loading