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.

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

Conversation

rorondre
Copy link
Contributor

@rorondre rorondre commented Oct 29, 2020

Reference issues/PRs
Fixes #397

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation enhancement

Description
Small enhancement to PairwiseDistance docstring for bottleneck distance to state what could happen with the symmetry of the bottleneck distance when the delta parameter is non-zero

Screenshots (if appropriate)

Any other comments?

Checklist

  • I have read the guidelines for contributing.
  • My code follows the code style of this project. I used flake8 to check my Python changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed. I used pytest to check this on Python tests.

@rorondre rorondre changed the title Update a docstring Update PairwiseDistance docstring for bottleneck distance Oct 30, 2020
@giotto-ai giotto-ai deleted a comment from azure-pipelines bot Oct 31, 2020
@ulupo ulupo added the documentation Improvements or additions to documentation label Oct 31, 2020
Copy link
Collaborator

@ulupo ulupo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for this!

@ulupo ulupo merged commit 558fdf3 into giotto-ai:master Nov 1, 2020
ulupo added a commit that referenced this pull request Nov 20, 2020
* Add workflow figure to docs (#519)

* Add workflow figure to docs

* Fix forgotten reshape in MNIST notebook

* Add 0.3.0 to the list of versions

Co-authored-by: wreise <wojciech.reise@epfl.ch>

* Upload new mapper pipeline svg (#521)

* Fix copyright notices (#522)

* 🎨 Clean up shape classification tutorial (#523)

* Add subsection to improve baseline model, remove projective space subsection

* Remove case study prefix from Lorenz attractor example

Co-authored-by: wreise <wojciech.reise@epfl.ch>
Co-authored-by: Umberto Lupo <umberto.lupo@gmail.com>

* [CI] Rename notebooks_check to test_notebooks and add test_wheels variable (#524)

* Update PairwiseDistance docstring for bottleneck distance (#525)

Update the docstring to state what could happen with the symmetry of the bottleneck distance when the delta parameter is non-zero

* Bump macOS version in Azure jobs to 10.15 (#527)

* Bump macOS version in Azure jobs to 10.15

Attempt to fix the brew woes in the Azure jobs by trying the suggestion in https://developercommunity.visualstudio.com/comments/1239467/view.html

* Increase timeout deadline to 500ms in some flaky tests (#531)

* Increase timeout deadline to 500ms in collapser and mapper clustering classes tests

* Use list comprehensions in _time_delay_embedding

* Pull ripser.py latest changes (#530)

* Update ripser.py commit

* Add robinhhood hashmap as a dependency

* Enable use of robinhood hashmap for ripser

* Update ccache on azure pipeline

Signed-off-by: julian <julian.burellaperez@heig-vd.ch>

* Split time series classification notebook into two (#529)

* Separate the two notebooks

* Rename time_series_classification notebook to topology_time_series

* Revert #465 following #530

* Use np.asarray to handle coo attributes being lists

* Fix documentation after splitting time series classification notebook (#533)

* Add gravitational waves notebook to docs, rename time_series_classification to topology_time_series following #529

* Change link to use cases on giotto.ai

* Clarify situation with use cases needing old versions of the library

Co-authored-by: Umberto Lupo <umberto.lupo@gmail.com>

* Add copyright notice inherited from ripser.py following @MonkeyBreaker's comment

* Prepare for v0.3.1 (#534)

* Bump version number to 0.3.1

* Make release notes for 0.3.1 and add @rorondre to code authors

Co-authored-by: wreise <wojciech.reise@epfl.ch>

Co-authored-by: wreise <wojciech.reise@epfl.ch>
Co-authored-by: lewtun <lewis.c.tunstall@gmail.com>
Co-authored-by: rorondre <r.andreeva@sms.ed.ac.uk>
Co-authored-by: REDS institute <reds-heig@users.noreply.github.com>
Co-authored-by: Wojciech Reise <32167173+wreise@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PairwiseDistance with bottleneck metric returns non-symmetric matrix when delta is not zero
2 participants