From 1da51f6004456434b057614026575cd910a35f80 Mon Sep 17 00:00:00 2001 From: Michal Klein <46717574+michalk8@users.noreply.github.com> Date: Fri, 29 Nov 2024 19:56:49 +0100 Subject: [PATCH] Remove mention of `scale_epsilon` --- src/ott/geometry/epsilon_scheduler.py | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/src/ott/geometry/epsilon_scheduler.py b/src/ott/geometry/epsilon_scheduler.py index 163a036e5..f5d2cc3f4 100644 --- a/src/ott/geometry/epsilon_scheduler.py +++ b/src/ott/geometry/epsilon_scheduler.py @@ -26,14 +26,10 @@ class Epsilon: r"""Scheduler class for the regularization parameter epsilon. - An epsilon scheduler outputs a regularization strength, to be used by in a + An epsilon scheduler outputs a regularization strength, to be used by a Sinkhorn-type algorithm, at any iteration count. That value is either the final, targeted regularization, or one that is larger, obtained by geometric decay of an initial value that is larger than the intended target. - Concretely, the value returned by such a scheduler will consider first - the max between ``target`` and ``init * target * decay ** iteration``. - If the ``scale_epsilon`` parameter is provided, that value is used to - multiply the max computed previously by ``scale_epsilon``. Args: target: The epsilon regularizer that is targeted.