inversion_ideas.directives.MultiplierCooler#

class inversion_ideas.directives.MultiplierCooler(scaled_objective, cooling_factor, cooling_rate=1)#

Cool the multiplier of an objective function.

Parameters:
scaled_objectiveScaled

Scaled objective function whose multiplier will be cooled.

cooling_factorfloat

Factor by which the multiplier will be cooled.

cooling_rateint, optional

Cool down the multiplier every cooling_rate call to this directive.

Methods

__call__(model, iteration)

Cool the multiplier.

Notes

Given a scaled objective function \(\phi(\mathbf{m}) = \alpha \varphi(\mathbf{m})\), and a cooling factor \(k\), this directive will cool the multiplier alpha by dividing it by \(k\) on every cooling_rate call to the directive.

Methods#

Methods documentation

MultiplierCooler.__call__(model, iteration)#

Cool the multiplier.