Skip to content

docs: clarify late interaction embedding output - #880

Open
remote-controlled-man wants to merge 1 commit into
qdrant:mainfrom
remote-controlled-man:codex/prflow-de12f32c58bd
Open

remote-controlled-man wants to merge 1 commit into
qdrant:mainfrom
remote-controlled-man:codex/prflow-de12f32c58bd

Conversation

@remote-controlled-man

Copy link
Copy Markdown

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.

Copilot AI balanced review requested due to automatic review settings November 14, 2026 05:16

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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.

@coderabbitai

coderabbitai Bot commented Nov 14, 2026

Copy link
Copy Markdown
Contributor

Explain Change →

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.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: Minimal · up to 42e93

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: Passed 4

Check name Status Explanation
Title check Passed 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 Passed 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 Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed 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.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 67336883-3ca1-4fba-a624-2b2477e4ae9d
Commits

Reviewing files that changed from the base of the PR and between f91d916 and 42e9330.

Files selected for processing: 2

  • fastembed/late_interaction/colbert.py
  • fastembed/late_interaction/late_interaction_text_embedding.py

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
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