Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update PairwiseDistance docstring for bottleneck distance #525

Merged
merged 3 commits into from
Nov 1, 2020
Merged

Update PairwiseDistance docstring for bottleneck distance #525

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b0e774c
Update the docstring to state what could happen with the symmetry of …
rorondre Oct 29, 2020
f279664
Update the docstring for bottleneck distance
rorondre Oct 29, 2020
1c58c8e
Merge remote-tracking branch 'origin/issue_397_update_docs' into issu…
rorondre Oct 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion gtda/diagrams/distance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.``
Expand Down