Skip to content

Bottleneck matching warning - #109

Open
catanzaromj wants to merge 2 commits into
scikit-tda:masterfrom
catanzaromj:bottleneck-matching-warning
Open

Bottleneck matching warning#109
catanzaromj wants to merge 2 commits into
scikit-tda:masterfrom
catanzaromj:bottleneck-matching-warning

Conversation

@catanzaromj

Copy link
Copy Markdown
Contributor

This PR adds a UserWarning on matching=True calls due to the previous change swapping out hopcroftkarp dep for scipy. This warning will be removed in a 0.5.0 release.

The warning itself is because when several optimal matchings exist, the bottleneck matching from hopcraftkarp vs scipy may differ. The bottleneck distances themselves are identical, so the warning is only emitted when calling matching=True. This warning was only noted in RELEASE.txt before, so this PR makes it explicit to callers in code.

I also added two tests to make sure the warning is only emitted in the correct case.

@codecov

codecov Bot commented Aug 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.87%. Comparing base (096a25f) to head (e19f15a).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #109      +/-   ##
==========================================
+ Coverage   78.85%   78.87%   +0.02%     
==========================================
  Files          20       20              
  Lines        1480     1482       +2     
  Branches      270      271       +1     
==========================================
+ Hits         1167     1169       +2     
  Misses        235      235              
  Partials       78       78              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant