Skip to content

Commit 1a1873a

Browse files
adding create_new to args StateParamScheduler (#2404)
* adding create_new to args StateParamScheduler * autopep8 fix Co-authored-by: bibhabasumohapatra <[email protected]>
1 parent 4f61e20 commit 1a1873a

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

Diff for: ignite/handlers/state_param_scheduler.py

+20
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,10 @@ class LambdaStateScheduler(StateParamScheduler):
123123
param_name: name of parameter to update.
124124
save_history: whether to log the parameter values to
125125
`engine.state.param_history`, (default=False).
126+
create_new: whether to create ``param_name`` on
127+
``engine.state`` taking into account whether
128+
``param_name`` attribute already exists or not.
129+
Overrides existing attribute by default, (default=False).
126130
127131
Examples:
128132
@@ -200,6 +204,10 @@ class PiecewiseLinearStateScheduler(StateParamScheduler):
200204
param_name: name of parameter to update.
201205
save_history: whether to log the parameter values to
202206
`engine.state.param_history`, (default=False).
207+
create_new: whether to create ``param_name`` on
208+
``engine.state`` taking into account whether
209+
``param_name`` attribute already exists or not.
210+
Overrides existing attribute by default, (default=False).
203211
204212
Examples:
205213
@@ -320,6 +328,10 @@ class ExpStateScheduler(StateParamScheduler):
320328
param_name: name of parameter to update.
321329
save_history: whether to log the parameter values to
322330
`engine.state.param_history`, (default=False).
331+
create_new: whether to create ``param_name`` on
332+
``engine.state`` taking into account whether
333+
``param_name`` attribute already exists or not.
334+
Overrides existing attribute by default, (default=False).
323335
324336
Examples:
325337
@@ -383,6 +395,10 @@ class StepStateScheduler(StateParamScheduler):
383395
param_name: name of parameter to update.
384396
save_history: whether to log the parameter values to
385397
`engine.state.param_history`, (default=False).
398+
create_new: whether to create ``param_name`` on
399+
``engine.state`` taking into account whether
400+
``param_name`` attribute already exists or not.
401+
Overrides existing attribute by default, (default=False).
386402
387403
Examples:
388404
@@ -457,6 +473,10 @@ class MultiStepStateScheduler(StateParamScheduler):
457473
param_name: name of parameter to update.
458474
save_history: whether to log the parameter values to
459475
`engine.state.param_history`, (default=False).
476+
create_new: whether to create ``param_name`` on
477+
``engine.state`` taking into account whether
478+
``param_name`` attribute already exists or not.
479+
Overrides existing attribute by default, (default=False).
460480
461481
Examples:
462482

0 commit comments

Comments
 (0)