Skip to content

Add doctest for LamdaStateScheduler #2402

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 2 commits into from
Jan 1, 2022
Merged

Add doctest for LamdaStateScheduler #2402

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bf2d56
doctest LamdaStateScheduler
bibhabasumohapatra Jan 1, 2022
c8fd251
Merge branch 'doctest-LambdaStateScheduler' of https://github.com/bib…
bibhabasumohapatra 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
42 changes: 32 additions & 10 deletions ignite/handlers/state_param_scheduler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,11 @@ class LambdaStateScheduler(StateParamScheduler):

Examples:

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

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

.. testcode::

class LambdaState:
def __init__(self, initial_value, gamma):
Expand All @@ -139,18 +140,39 @@ def __init__(self, initial_value, gamma):
def __call__(self, event_index):
return self.initial_value * self.gamma ** (event_index % 9)


param_scheduler = LambdaStateScheduler(
param_name="param",
lambda_obj=LambdaState(10, 0.99),
param_name="param", lambda_obj=LambdaState(1, 0.9), create_new=True
)

param_scheduler.attach(engine, Events.EPOCH_COMPLETED)
# parameter is param, initial_value sets param to 1 and in this example gamma = 1
# using class 'LambdaState' user defined callable object can be created
# update a parameter during training by using a user defined callable object
# user defined callable object is taking an event index as input and returns parameter value
# in this example, we update as initial_value * gamma ** (event_endex % 9)
# in every Epoch the parameter is updated as 1 * 0.9 ** (Epoch % 9)
# In Epoch 3, parameter param = 1 * 0.9 ** (3 % 9) = 0.729
# In Epoch 10, parameter param = 1 * 0.9 ** (10 % 9) = 0.9

# 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)

default_trainer.run([0], max_epochs=10)

engine.run([0] * 8, max_epochs=2)
.. testoutput::

0.9
0.81
0.7290...
0.6561
0.5904...
0.5314...
0.4782...
0.4304...
1.0
0.9

.. versionadded:: 0.5.0

Expand Down