Skip to content

Commit

Permalink
Remove mention of scale_epsilon
Browse files Browse the repository at this point in the history
  • Loading branch information
michalk8 committed Nov 29, 2024
1 parent ade9aea commit 1da51f6
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions src/ott/geometry/epsilon_scheduler.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 1da51f6

Please sign in to comment.