Skip to content

Add doctest for MultiStepScheduler #2399

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

Merged
sdesrozis merged 4 commits into from
Jan 1, 2022
Merged

Add doctest for MultiStepScheduler #2399

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0ca3d6f
doctest for MultiStepScheduler
bibhabasumohapatra Dec 31, 2021
621ec95
Merge branch 'master' into doctest-MultiStepStateScheduler
sdesrozis Dec 31, 2021
e49f4a6
Update ignite/handlers/state_param_scheduler.py
sdesrozis Dec 31, 2021
366108b
Merge branch 'master' into doctest-MultiStepStateScheduler
sdesrozis Jan 1, 2022
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
45 changes: 36 additions & 9 deletions ignite/handlers/state_param_scheduler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,21 +438,48 @@ class MultiStepStateScheduler(StateParamScheduler):

Examples:

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

...
engine = Engine(train_step)
default_trainer = get_default_trainer()

.. testcode::

param_scheduler = MultiStepStateScheduler(
param_name="param", initial_value=10, gamma=0.99, milestones=[3, 6],
param_scheduler =MultiStepStateScheduler(
param_name="param", initial_value=1, gamma=0.9, milestones=[3, 6, 9, 12]
)

param_scheduler.attach(engine, Events.EPOCH_COMPLETED)
# parameter is param, initial_value sets param to 1, gamma is set as 0.9
# Epoch 1 to 2, param does not change as milestone is 3
# Epoch 3, param changes from 1 to 1*0.9, param = 0.9
# Epoch 3 to 5, param does not change as milestone is 6
# Epoch 6, param changes from 0.9 to 0.9*0.9, param = 0.81
# Epoch 6 to 8, param does not change as milestone is 9
# Epoch 9, param changes from 0.81 to 0.81*0.9, param = 0.729
# Epoch 9 to 11, param does not change as milestone is 12
# Epoch 12, param changes from 0.729 to 0.729*0.9, param = 0.6561

# basic handler to print scheduled state parameter
engine.add_event_handler(Events.EPOCH_COMPLETED, lambda _ : print(engine.state.param))
param_scheduler.attach(default_trainer, Events.EPOCH_COMPLETED)

@default_trainer.on(Events.EPOCH_COMPLETED)
def print_param():
print(default_trainer.state.param)

engine.run([0] * 8, max_epochs=10)
default_trainer.run([0], max_epochs=12)

.. testoutput::

1.0
1.0
0.9
0.9
0.9
0.81
0.81
0.81
0.7290...
0.7290...
0.7290...
0.6561

.. versionadded:: 0.5.0

Expand Down