summaryrefslogtreecommitdiff
path: root/ot/lp/__init__.py
diff options
context:
space:
mode:
authorRomain Tavenard <romain.tavenard@univ-rennes2.fr>2019-06-24 13:09:36 +0200
committerRomain Tavenard <romain.tavenard@univ-rennes2.fr>2019-06-24 13:09:36 +0200
commit77452dd92f607c3f18a6420cb8cd09fa5cd905a6 (patch)
tree9d11d69ccfcd19ab4e368cd0df6b49720d6c4346 /ot/lp/__init__.py
parent71f9b5adfb8d8f4481948391f22e49f45494d071 (diff)
Added more docstrings (Cython) + fixed link to ot.dist doc
Diffstat (limited to 'ot/lp/__init__.py')
-rw-r--r--ot/lp/__init__.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/ot/lp/__init__.py b/ot/lp/__init__.py
index a350d60..645ed8b 100644
--- a/ot/lp/__init__.py
+++ b/ot/lp/__init__.py
@@ -343,7 +343,7 @@ def emd_1d(x_a, x_b, a, b, metric='sqeuclidean', dense=True, log=False):
b : (nt,) ndarray, float64
Target histogram (uniform weight if empty list)
metric: str, optional (default='sqeuclidean')
- Metric to be used. Only strings listed in ... are accepted.
+ Metric to be used. Only strings listed in :func:`ot.dist` are accepted.
Due to implementation details, this function runs faster when
`'sqeuclidean'`, `'cityblock'`, or `'euclidean'` metrics are used.
dense: boolean, optional (default=True)
@@ -454,7 +454,7 @@ def emd2_1d(x_a, x_b, a, b, metric='sqeuclidean', dense=True, log=False):
b : (nt,) ndarray, float64
Target histogram (uniform weight if empty list)
metric: str, optional (default='sqeuclidean')
- Metric to be used. Only strings listed in ... are accepted.
+ Metric to be used. Only strings listed in :func:`ot.dist` are accepted.
Due to implementation details, this function runs faster when
`'sqeuclidean'`, `'cityblock'`, or `'euclidean'` metrics are used.
dense: boolean, optional (default=True)