Docs updates to reranker section from audit workflow#228
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reranking docs gaps — fixes from audit run
20260504T152409ZAddresses the six gaps flagged in the docs-audit report for the reranking area, cross-checked against the
lancedbsource repo.Overview page
.with_row_id(True)on each search call and a warning explaining thatdeduplicate=TrueraisesValueErrorwithout_rowid(which is opt-in, so this is the default failure mode). Also calls out thatRRFReranker.rerank_multivector(...)requires_rowidregardless of the flag.CohereReranker/CrossEncoderReranker/ColbertRerankerare Python-only — TypeScript and Rust currently expose only the genericRerankerinterface andRRFReranker.Custom rerankers page
rerank_hybrid()required;rerank_vector()/rerank_fts()optional) and to flag that the base class raisesNotImplementedErrorif you call rerank on a single-modality path you didn't override._relevance_scorecolumn sorted descending, otherwise LanceDB rejects the table or.limit(...)returns rows in the wrong order.Evaluation page
.rerank()defaults toRRFReranker().normalizeparameter: added a tip documentingnormalize="score"(default) vsnormalize="rank"and why it matters when evaluating score-based rerankers.No test files changed, so no snippet regeneration was done as a result.