summaryrefslogtreecommitdiff
path: root/ot/lp
diff options
context:
space:
mode:
authorncassereau-idris <84033440+ncassereau-idris@users.noreply.github.com>2021-05-26 16:56:00 +0200
committerGitHub <noreply@github.com>2021-05-26 16:56:00 +0200
commit178c281fc91e014f5e148b7017430928d715de8c (patch)
tree14418ad35b9c5cfc49837014e23b3e8568fed4fd /ot/lp
parentd06eee87155cdc6702c0dc8fe933dc02d9efdada (diff)
Docs correction (#252)
Diffstat (limited to 'ot/lp')
-rw-r--r--ot/lp/__init__.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/ot/lp/__init__.py b/ot/lp/__init__.py
index f08e020..d5c3a5e 100644
--- a/ot/lp/__init__.py
+++ b/ot/lp/__init__.py
@@ -323,7 +323,7 @@ def emd2(a, b, M, processes=multiprocessing.cpu_count(),
The maximum number of iterations before stopping the optimization
algorithm if it has not converged.
log: boolean, optional (default=False)
- If True, returns a dictionary containing the cost and dual
+ If True, returns a dictionary containing dual
variables. Otherwise returns only the optimal transportation cost.
return_matrix: boolean, optional (default=False)
If True, returns the optimal transportation matrix in the log.
@@ -333,10 +333,10 @@ def emd2(a, b, M, processes=multiprocessing.cpu_count(),
Returns
-------
- gamma: (ns x nt) ndarray
- Optimal transportation matrix for the given parameters
+ W: float
+ Optimal transportation loss for the given parameters
log: dictnp
- If input log is true, a dictionary containing the cost and dual
+ If input log is true, a dictionary containing dual
variables and exit status