Shortcuts

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.

Read the Docs v: v0.8.3
Versions
latest
stable
v0.8.3
v0.8.2
v0.8.1
v0.8.0
v0.7.4
v0.7.3
v0.7.2
v0.7.1
v0.7.0
v0.6.0
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.