summaryrefslogtreecommitdiff
path: root/ot/bregman.py
diff options
context:
space:
mode:
authorMokhtar Z. Alaya <mzalaya@sct-18-1bee-1581.univ-rouen.fr>2020-01-10 11:52:37 +0100
committerMokhtar Z. Alaya <mzalaya@sct-18-1bee-1581.univ-rouen.fr>2020-01-10 11:52:37 +0100
commit5a70afeaa1671e4af010009d47bdea1073967e1e (patch)
tree04d24e666d424a2e4c6ce0b29804a4a46964074c /ot/bregman.py
parent73de2854ef8564521e082ea706ba2ed5ab44786e (diff)
update screenkhorn example
Diffstat (limited to 'ot/bregman.py')
-rw-r--r--ot/bregman.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/ot/bregman.py b/ot/bregman.py
index 4f24cf4..95b27e4 100644
--- a/ot/bregman.py
+++ b/ot/bregman.py
@@ -1793,13 +1793,13 @@ def empirical_sinkhorn_divergence(X_s, X_t, reg, a=None, b=None, metric='sqeucli
def screenkhorn(a, b, M, reg, ns_budget=None, nt_budget=None, uniform=False, restricted=True,
maxiter=10000, maxfun=10000, pgtol=1e-09, verbose=False, log=False):
- """"
+ r""""
Screening Sinkhorn Algorithm for Regularized Optimal Transport
The function solves an approximate dual of Sinkhorn divergence [2] which is written as the following optimization problem:
..math::
- (u, v) = \argmin_{u, v} 1_{ns}.T B(u,v) 1_{nt} - <\kappa u, a> - <v/\kappa, b>
+ (u, v) = \argmin_{u, v} 1_{ns}^\top B(u,v) 1_{nt} - <\kappa u, a> - <v/\kappa, b>
where B(u,v) = \diag(e^u) K \diag(e^v), with K = e^{-M/reg} and
@@ -1853,8 +1853,8 @@ def screenkhorn(a, b, M, reg, ns_budget=None, nt_budget=None, uniform=False, res
Dependency
----------
- To gain more efficiency, screenkhorn needs to call the "Bottleneck" package (https://pypi.org/project/Bottleneck/) in the screening pre-processing step.
- If Bottleneck isn't installed, the following error message appears:
+ To gain more efficiency, screenkhorn needs to call the "Bottleneck" package (https://pypi.org/project/Bottleneck/)
+ in the screening pre-processing step. If Bottleneck isn't installed, the following error message appears:
"Bottleneck module doesn't exist. Install it from https://pypi.org/project/Bottleneck/"