polarcbo.scheduler.scheduler_base

class polarcbo.scheduler.scheduler_base(opt, beta=1.0, beta_max=100000.0)[source]

Bases: object

scheduler_base class

This class implements the base scheduler class. It is used to implement the \(\beta\)-schedulers employed in the consensus schemes.

Parameters:

  • opt (object) – The optimizer for which the \(\beta\)-parameter should be updated

  • beta (float, optional) – The initial value of the \(\beta\)-parameter. The default is 1.0.

  • beta_max (float, optional) – The maximum value of the \(\beta\)-parameter. The default is 100000.0.

__call__()[source]

Call method for classes that inherit from scheduler_base

Returns:

beta – The current value of the \(\beta\)-parameter in opt.

Return type:

float