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

docs: improve docs for MinHashDedup Step #1050

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

anakin87
Copy link

@anakin87 anakin87 commented Nov 1, 2024

👋

While looking at this nice feature, I noticed some errors in the docstring and I'm trying to fix them.

Slightly related feedback
Initially I was bit surprised that I cannot easily understand why a single text element is considered a duplicate when using this technique, while this is transparent using EmbeddingGeneration + EmbeddingDedup.
But I understand that this technique is more complex, even from the implementation point of view...

@gabrielmbmb @plaguss

seed: the seed to use for the MinHash. This seed must be the same
used for `MinHash`, keep in mind when both steps are created. Defaults to `1`.
seed: the seed to use for the MinHash. Defaults to `1`.
Copy link
Author

Choose a reason for hiding this comment

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

I think this detail is not needed after #937

@anakin87 anakin87 marked this pull request as ready for review November 1, 2024 20:32
@plaguss plaguss added the documentation Improvements or additions to documentation label Nov 5, 2024
Copy link

codspeed-hq bot commented Nov 5, 2024

CodSpeed Performance Report

Merging #1050 will not alter performance

Comparing anakin87:improve-minhash-docs (9ccda5e) with main (844165f)

🎉 Hooray! pytest-codspeed just leveled up to 3.0.0!

A heads-up, this is a breaking change and it might affect your current performance baseline a bit. But here's the exciting part - it's packed with new, cool features and promises improved result stability 🥳!
Curious about what's new? Visit our releases page to delve into all the awesome details about this new version.

Summary

✅ 1 untouched benchmarks

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.

2 participants