leaspy.algo.algo_with_annealing

Classes

AlgorithmWithAnnealingMixin

Mixin class to use in algorithms that requires temperature_inv.

Module Contents

class AlgorithmWithAnnealingMixin(settings)[source]

Mixin class to use in algorithms that requires temperature_inv.

Note that this mixin should be used with a class inheriting from AbstractAlgo, which must have algo_parameters attribute.

Parameters:
settingsAlgorithmSettings

The specifications of the algorithm as a AlgorithmSettings instance.

Please note that you can customize the number of iterations with annealing by setting:
  • annealing.n_iter_frac, such that iterations with annealing is a ratio of algorithm n_iter (default = 50%)

Attributes:
annealing_onbool

Activates annealing.

temperaturefloat >= 1
temperature_invfloat in [0, 1]

Temperature and its inverse when using annealing

Parameters:

settings (AlgorithmSettings)

temperature: float = 1.0
temperature_inv: float = 1.0
annealing_on: bool