summaryrefslogtreecommitdiff
path: root/src/python/doc/wasserstein_distance_sum.inc
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2019-11-08 21:05:19 +0100
committerMarc Glisse <marc.glisse@inria.fr>2019-11-08 21:05:19 +0100
commit60c52012578265e6b6ac2e4a616cf2b617809d2c (patch)
treee958905af656f72228f9e778464739093635d35b /src/python/doc/wasserstein_distance_sum.inc
parent7c80dd28eb16e70316e6acc0bde8f698f79b2003 (diff)
parentdb405e686cc859e510b894dca45562158cb5c963 (diff)
Merge remote-tracking branch 'origin/master' into sklearn_tda
Diffstat (limited to 'src/python/doc/wasserstein_distance_sum.inc')
-rw-r--r--src/python/doc/wasserstein_distance_sum.inc14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/python/doc/wasserstein_distance_sum.inc b/src/python/doc/wasserstein_distance_sum.inc
new file mode 100644
index 00000000..ffd4d312
--- /dev/null
+++ b/src/python/doc/wasserstein_distance_sum.inc
@@ -0,0 +1,14 @@
+.. table::
+ :widths: 30 50 20
+
+ +-----------------------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------+
+ | .. figure:: | The p-Wasserstein distance measures the similarity between two | :Author: Theo Lacombe |
+ | ../../doc/Bottleneck_distance/perturb_pd.png | persistence diagrams. It's the minimum value c that can be achieved | |
+ | :figclass: align-center | by a perfect matching between the points of the two diagrams (+ all | :Introduced in: GUDHI 3.1.0 |
+ | | diagonal points), where the value of a matching is defined as the | |
+ | Wasserstein distance is the p-th root of the sum of the | p-th root of the sum of all edge lengths to the power p. Edge lengths| :Copyright: MIT |
+ | edge lengths to the power p. | are measured in norm q, for :math:`1 \leq q \leq \infty`. | |
+ | | | :Requires: Python Optimal Transport (POT) :math:`\geq` 0.5.1 |
+ +-----------------------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------+
+ | * :doc:`wasserstein_distance_user` | |
+ +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+