@@ -123,6 +123,10 @@ class LambdaStateScheduler(StateParamScheduler):
123
123
param_name: name of parameter to update.
124
124
save_history: whether to log the parameter values to
125
125
`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).
126
130
127
131
Examples:
128
132
@@ -200,6 +204,10 @@ class PiecewiseLinearStateScheduler(StateParamScheduler):
200
204
param_name: name of parameter to update.
201
205
save_history: whether to log the parameter values to
202
206
`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).
203
211
204
212
Examples:
205
213
@@ -320,6 +328,10 @@ class ExpStateScheduler(StateParamScheduler):
320
328
param_name: name of parameter to update.
321
329
save_history: whether to log the parameter values to
322
330
`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).
323
335
324
336
Examples:
325
337
@@ -383,6 +395,10 @@ class StepStateScheduler(StateParamScheduler):
383
395
param_name: name of parameter to update.
384
396
save_history: whether to log the parameter values to
385
397
`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).
386
402
387
403
Examples:
388
404
@@ -457,6 +473,10 @@ class MultiStepStateScheduler(StateParamScheduler):
457
473
param_name: name of parameter to update.
458
474
save_history: whether to log the parameter values to
459
475
`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).
460
480
461
481
Examples:
462
482
0 commit comments