Shortcuts

ExponentialParamScheduler

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

Decays the parameter value of each parameter group by gamma every epoch.

Parameters:
  • optimizer (Optimizer or BaseOptimWrapper) – optimizer or Wrapped optimizer.

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

  • gamma (float) – Multiplicative factor of parameter value decay.

  • 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.