ott.geometry.epsilon_scheduler.Epsilon

Contents

ott.geometry.epsilon_scheduler.Epsilon#

class ott.geometry.epsilon_scheduler.Epsilon(target, init=1.0, decay=1.0)[source]#

Scheduler class for the regularization parameter epsilon.

An epsilon scheduler outputs a regularization strength, to be used by the Sinkhorn algorithm or variant, at any iteration count. That value is either the final, targeted regularization, or one that is larger, obtained by geometric decay of an initial multiplier.

Parameters:
  • target (array) – The epsilon regularizer that is targeted.

  • init (float) – Initial value when using epsilon scheduling, understood as a multiple of the target, following \(\text{init} \text{decay}^{\text{it}}\).

  • decay (float) – Geometric decay factor, \(\leq 1\).

Methods