leaspy.algo.utils.algo_with_annealing module

class AlgoWithAnnealingMixin(settings)

Bases: object

Mixin to use in algorithms needing temperature_inv; inherit from this class first.

Note that this mixin is to be used with a class inheriting from AbstractAlgo (and in particular that have a 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 either: * annealing.n_iter directly (deprecated but has priority over following setting, not defined by default) * annealing.n_iter_frac, such that iterations with annealing is a ratio of algorithm n_iter (default of 50%)

Attributes:

annealing_onbool

Is annealing activated or not?

temperaturefloat >= 1

temperature_invfloat in ]0, 1]

Temperature and its inverse when using annealing