diff options
| author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-03-05 14:24:01 +0100 |
|---|---|---|
| committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-03-05 14:24:01 +0100 |
| commit | f78d65f0bd6aaf5f92639e2b809e1711acf929f7 (patch) | |
| tree | 42272a2d27eea45735b806ce46e61c41b1f5ea9a /src/python/doc/wasserstein_distance_user.rst | |
| parent | 73ad191a7dee054a58e9823c84dce9f1e71995f4 (diff) | |
| parent | d2943b9e7311c8a3d8a4fb379c39b15497481b9c (diff) | |
Merge branch 'master' into print_warnings_to_stderr
Diffstat (limited to 'src/python/doc/wasserstein_distance_user.rst')
| -rw-r--r-- | src/python/doc/wasserstein_distance_user.rst | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/src/python/doc/wasserstein_distance_user.rst b/src/python/doc/wasserstein_distance_user.rst index 32999a0c..94b454e2 100644 --- a/src/python/doc/wasserstein_distance_user.rst +++ b/src/python/doc/wasserstein_distance_user.rst @@ -9,17 +9,26 @@ Definition .. include:: wasserstein_distance_sum.inc -This implementation is based on ideas from "Large Scale Computation of Means and Cluster for Persistence Diagrams via Optimal Transport". +Functions +--------- +This implementation uses the Python Optimal Transport library and is based on +ideas from "Large Scale Computation of Means and Cluster for Persistence +Diagrams via Optimal Transport" :cite:`10.5555/3327546.3327645`. -Function --------- .. autofunction:: gudhi.wasserstein.wasserstein_distance +This other implementation comes from `Hera +<https://bitbucket.org/grey_narn/hera/src/master/>`_ (BSD-3-Clause) which is +based on "Geometry Helps to Compare Persistence Diagrams" +:cite:`Kerber:2017:GHC:3047249.3064175` by Michael Kerber, Dmitriy +Morozov, and Arnur Nigmetov. + +.. autofunction:: gudhi.hera.wasserstein_distance Basic example ------------- -This example computes the 1-Wasserstein distance from 2 persistence diagrams with euclidean ground metric. +This example computes the 1-Wasserstein distance from 2 persistence diagrams with Euclidean ground metric. Note that persistence diagrams must be submitted as (n x 2) numpy arrays and must not contain inf values. .. testcode:: |