StepMomentum¶
- class mmengine.optim.StepMomentum(optimizer, *args, **kwargs)[source]¶
Decays the momentum of each parameter group by gamma every step_size epochs. Notice that such decay can happen simultaneously with other changes to the momentum from outside this scheduler.
- Parameters
optimizer (Optimizer or OptimWrapper) – optimizer or Wrapped optimizer.
step_size (int) – Period of momentum value decay.
gamma (float) – Multiplicative factor of momentum value decay. Defaults to 0.1.
begin (int) – Step at which to start updating the momentum. Defaults to 0.
end (int) – Step at which to stop updating the momentum. 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 momentum is updated by epochs. Defaults to True.
verbose (bool) – Whether to print the momentum for each update. Defaults to False.