Shortcuts

PolyParamScheduler

class mmengine.optim.PolyParamScheduler(optimizer, param_name, eta_min=0, power=1.0, begin=0, end=1000000000, last_step=- 1, by_epoch=True, verbose=False)[source]

Decays the parameter value of each parameter group in a polynomial decay scheme.

Notice that such decay can happen simultaneously with other changes to the parameter value from outside this scheduler.

Parameters
  • optimizer (Optimizer or OptimWrapper) – optimizer or Wrapped optimizer.

  • param_name (str) – Name of the parameter to be adjusted, such as lr, momentum.

  • eta_min (float) – Minimum parameter value at the end of scheduling. Defaults to 0.

  • power (float) – The power of the polynomial. Defaults to 1.0.

  • begin (int) – Step at which to start updating the parameters. Defaults to 0.

  • end (int) – Step at which to stop updating the parameters. Defaults to INF.

  • last_step (int) – The index of last step. Used for resume without state dict. Defaults to -1.

  • by_epoch (bool) – Whether the scheduled parameters are updated by epochs. Defaults to True.

  • verbose (bool) – Whether to print the value for each update. Defaults to False.

classmethod build_iter_from_epoch(*args, begin=0, end=1000000000, by_epoch=True, epoch_length=None, **kwargs)[source]

Build an iter-based instance of this scheduler from an epoch-based config.

Read the Docs v: v0.4.0
Versions
latest
stable
v0.5.0
v0.4.0
v0.3.0
v0.2.0
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.