diff options
author | Marc Glisse <marc.glisse@inria.fr> | 2020-04-22 17:39:52 +0200 |
---|---|---|
committer | Marc Glisse <marc.glisse@inria.fr> | 2020-04-22 17:39:52 +0200 |
commit | a643583a4740fc40cf1e06e6cc1b4d17ca14000f (patch) | |
tree | 8027763a18c4ea477e295e4bd6f3c3b9416b827d /src/python | |
parent | f4d655bebbc3f4ea2919019cd5bc71bd0e8d426d (diff) |
Document incompatibility of matching=True and enable_autodiff
Diffstat (limited to 'src/python')
-rw-r--r-- | src/python/gudhi/wasserstein/wasserstein.py | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/python/gudhi/wasserstein/wasserstein.py b/src/python/gudhi/wasserstein/wasserstein.py index 0d164eda..89ecab1c 100644 --- a/src/python/gudhi/wasserstein/wasserstein.py +++ b/src/python/gudhi/wasserstein/wasserstein.py @@ -100,7 +100,8 @@ def wasserstein_distance(X, Y, matching=False, order=2., internal_p=2., enable_a :param internal_p: Ground metric on the (upper-half) plane (i.e. norm L^p in R^2); Default value is 2 (Euclidean norm). :param enable_autodiff: If X and Y are torch.tensor, tensorflow.Tensor or jax.numpy.ndarray, make the computation - transparent to automatic differentiation. This requires the package EagerPy. + transparent to automatic differentiation. This requires the package EagerPy and is currently incompatible + with `matching=True`. .. note:: This considers the function defined on the coordinates of the off-diagonal points of X and Y and lets the various frameworks compute its gradient. It never pulls new points from the diagonal. |