From b0e774c47f4454fff6fd2a71affc7227e717b6d4 Mon Sep 17 00:00:00 2001 From: rorondre Date: Thu, 29 Oct 2020 20:12:26 +0200 Subject: [PATCH 1/2] Update the docstring to state what could happen with the symmetry of the bottleneck distance when the delta parameter is non-zero --- gtda/diagrams/distance.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/gtda/diagrams/distance.py b/gtda/diagrams/distance.py index 1ff2c3eaf..c96e93abc 100644 --- a/gtda/diagrams/distance.py +++ b/gtda/diagrams/distance.py @@ -66,7 +66,8 @@ class PairwiseDistance(BaseEstimator, TransformerMixin): - If ``metric == 'bottleneck'`` the only argument is `delta` (float, default: ``0.01``). When equal to ``0.``, an exact algorithm is used; - otherwise, a faster approximate algorithm is used. + otherwise, a faster approximate algorithm is used and symmetry is not + guaranteed. - If ``metric == 'wasserstein'`` the available arguments are `p` (float, default: ``2.``) and `delta` (float, default: ``0.01``). Unlike the case of ``'bottleneck'``, `delta` cannot be set to ``0.`` From f279664712426f752c68670f56366c4677f86df8 Mon Sep 17 00:00:00 2001 From: rorondre Date: Thu, 29 Oct 2020 20:12:26 +0200 Subject: [PATCH 2/2] Update the docstring for bottleneck distance --- gtda/diagrams/distance.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/gtda/diagrams/distance.py b/gtda/diagrams/distance.py index 1ff2c3eaf..c96e93abc 100644 --- a/gtda/diagrams/distance.py +++ b/gtda/diagrams/distance.py @@ -66,7 +66,8 @@ class PairwiseDistance(BaseEstimator, TransformerMixin): - If ``metric == 'bottleneck'`` the only argument is `delta` (float, default: ``0.01``). When equal to ``0.``, an exact algorithm is used; - otherwise, a faster approximate algorithm is used. + otherwise, a faster approximate algorithm is used and symmetry is not + guaranteed. - If ``metric == 'wasserstein'`` the available arguments are `p` (float, default: ``2.``) and `delta` (float, default: ``0.01``). Unlike the case of ``'bottleneck'``, `delta` cannot be set to ``0.``