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

more refactoring of MinHash API #889

Merged
merged 19 commits into from Feb 9, 2020
Merged

more refactoring of MinHash API #889

merged 19 commits into from Feb 9, 2020

Conversation

@ctb
Copy link
Member

ctb commented Feb 6, 2020

Minor refactoring:

  • Move Python MinHash.similarity(...) entirely into Rust, fix Rust function up a bit.
  • Add Python MinHash.angular_similarity(...) method.
  • Remove MinHash.containment_ignore_maxhash usage entirely from Python and Rust, while leaving as part of the Python MinHash API.
  • Remove unused deprecation import in sbt.py.
  • deprecate MinHash.containment_ignore_maxhash as of v3.3; remove from Rust.
  • deprecate MinHash.compare as of v3.3; remove from Rust.
  • deprecate MinHash.intersection as of v3.3.
  • add or update MinHash class/method docstrings.

TODO:

  • maybe: write Python MinHash object API tests/docs.
  • maybe: fix unnamed exception in rust angular_similarity method.

Ref #885.

  • Is it mergeable?
  • make test Did it pass the tests?
  • make coverage Is the new code covered?
  • Did it change the command-line interface? Only additions are allowed
    without a major version increment. Changing file formats also requires a
    major version number increment.
  • Was a spellchecker run on the source code and documentation after
    changes were made?
@codecov

This comment has been minimized.

Copy link

codecov bot commented Feb 6, 2020

Codecov Report

❗️ No coverage uploaded for pull request base (master@d599f19). Click here to learn what that means.
The diff coverage is 80%.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #889   +/-   ##
=========================================
  Coverage          ?   78.29%           
=========================================
  Files             ?       95           
  Lines             ?     7307           
  Branches          ?        0           
=========================================
  Hits              ?     5721           
  Misses            ?     1586           
  Partials          ?        0
Flag Coverage Δ
#rusttests 50.38% <66.66%> (?)
Impacted Files Coverage Δ
src/core/src/ffi/minhash.rs 0% <0%> (ø)
sourmash/__init__.py 100% <100%> (ø)
src/core/src/sketch/minhash.rs 69.33% <90.32%> (ø)
sourmash/_minhash.py 95.02% <96.66%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d599f19...038bf9a. Read the comment docs.

@ctb ctb mentioned this pull request Feb 8, 2020
@ctb ctb changed the title [WIP] more refactoring of MinHash API [MRG] more refactoring of MinHash API Feb 8, 2020
@ctb

This comment has been minimized.

Copy link
Member Author

ctb commented Feb 8, 2020

Ready for review, @luizirber

sourmash/_minhash.py Outdated Show resolved Hide resolved
ctb and others added 4 commits Feb 8, 2020
Co-Authored-By: Luiz Irber <luizirber@users.noreply.github.com>
@luizirber luizirber force-pushed the refactor/minhash branch from ff4d154 to 038bf9a Feb 9, 2020
@luizirber luizirber changed the title [MRG] more refactoring of MinHash API more refactoring of MinHash API Feb 9, 2020
@luizirber luizirber merged commit 7af043a into master Feb 9, 2020
20 of 22 checks passed
20 of 22 checks passed
build build
Details
test
Details
archive
Details
Check
Details
test (beta)
Details
test (stable)
Details
test (windows)
Details
test (macos)
Details
test_all_features
Details
coverage
Details
Lints
Details
Check if wasm-pack builds a valid package for the sourmash crate
Details
Run tests under wasm32-wasi Run tests under wasm32-wasi
Details
Publish (dry-run)
Details
minimum_rust_version
Details
Travis CI - Pull Request Build Errored
Details
LGTM analysis: JavaScript No code changes detected
Details
LGTM analysis: C/C++ No new or fixed alerts
Details
LGTM analysis: Python 1 new alert and 2 fixed alerts
Details
codecov/patch No report found to compare against
Details
codecov/project No report found to compare against
Details
netlify/sourmash-docs/deploy-preview Deploy preview ready!
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.