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

Clarify BM25 Documentation in Gensim Core Tutorials (Document Fix) #3597

Closed
wants to merge 1 commit into from

Conversation

r4plh
Copy link

@r4plh r4plh commented Dec 24, 2024

What changes were proposed in this pull request?

This pull request corrects the documentation for the BM25 algorithm within the core tutorials of the Gensim library. The previous documentation misleadingly implied that BM25 transforms vectors into other vectors while altering their values based on feature rarity. This update provides an accurate description of BM25, highlighting its actual function as a scoring algorithm that does not manipulate the dimensionality of its input data.

Why are these changes needed?

The correction ensures the Gensim documentation accurately reflects the true nature of BM25 as a relevance scoring mechanism, not a vector transformation tool. It rectifies misconceptions and provides clarity, which is vital for users and developers relying on the Gensim documentation for implementing and understanding BM25.

File Modified

  • gensim/docs/src/gallery/core/run_topics_and_transformations.py

@r4plh r4plh changed the title Clarify BM25 Documentation in Gensim Core Tutorials Clarify BM25 Documentation in Gensim Core Tutorials (Document Fix) Dec 24, 2024
@piskvorky
Copy link
Owner

piskvorky commented Dec 25, 2024

Thanks but that doesn't sound right – the model really is a transformation. Plus the verbiage smells of LLMs.

@piskvorky piskvorky closed this Dec 25, 2024
@r4plh r4plh deleted the fix-doc-bm25 branch December 25, 2024 02:59
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.

2 participants