You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: clarify late interaction embedding output - #880
The LateInteractionTextEmbedding.embed() and Colbert.embed() docstrings describe mean pooling and a returned list, but these generators yield a matrix of token embeddings for each document.
Describe the (num_tokens, embedding_dim) output and note that the number of retained tokens can vary between documents. Only the two docstrings change.
Validation: Ruff 0.3.4 lint and format checks; executable AST comparison excluding docstrings. Model inference tests were not run because executable code is unchanged.
AI assistance: Codex helped prepare this documentation correction and its checks.
All Submissions:
Followed the contributing guidelines.
Checked existing issues and pull requests for this correction.
The reason will be displayed to describe this comment to others. Learn more.
Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.
No actionable comments were generated in the recent review.
Walkthrough
The embed documentation in Colbert and LateInteractionTextEmbedding now describes token embeddings for late interaction. It specifies a (num_tokens, embedding_dim) matrix for each document and notes that the retained token count may vary. The method implementations are unchanged.
This PR only clarifies documentation of the late interaction embedding output shape. It does not change runtime behavior and carries no meaningful merge risk.
Pre-merge checks: 4
Check name
Status
Explanation
Title check
The title names the change: it clarifies the documented output of late interaction embeddings. The docstring edits in Colbert.embed and LateInteractionTextEmbedding.embed match this. The title uses th…
Description check
The description states the purpose: the embed() docstrings describe mean pooling and a returned list, but the output is a per-document token-embedding matrix. It names the changed files, the (num_toke…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title names the change: it clarifies the documented output of late interaction embeddings. The docstring edits in Colbert.embed and LateInteractionTextEmbedding.embed match this. The title uses the conventional docs: prefix and is specific enough for a reader scanning history.
Full details: Description check
Explanation
The description states the purpose: the embed() docstrings describe mean pooling and a returned list, but the output is a per-document token-embedding matrix. It names the changed files, the (num_tokens, embedding_dim) output, and the validation performed. This matches the raw summary.
Finishing Touches
Generate unit tests (beta)
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.
This branch has not been deployed
No deployments
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
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.
The
LateInteractionTextEmbedding.embed()andColbert.embed()docstrings describe mean pooling and a returned list, but these generators yield a matrix of token embeddings for each document.Describe the
(num_tokens, embedding_dim)output and note that the number of retained tokens can vary between documents. Only the two docstrings change.Validation: Ruff 0.3.4 lint and format checks; executable AST comparison excluding docstrings. Model inference tests were not run because executable code is unchanged.
AI assistance: Codex helped prepare this documentation correction and its checks.
All Submissions: