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

fix(ColbertRerank): calculate ColBERT similarity per token rather than vs pooled query embeds #11335

Merged
merged 1 commit into from
Feb 23, 2024

Conversation

bclavie
Copy link
Contributor

@bclavie bclavie commented Feb 23, 2024

Description

Fixes the similarity calculation for the ColBERTReranker.

The current approach pools the query representation and performs cosine similarity for each document token against the single-vector query representation, whereas the original ColBERT maxsim implementation does so at the token level (i.e. it compares each query token to each document token).
This PR fixes this slight issue by removing the mean pooling.

Fixes # (issue)

Type of Change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Added new unit/integration tests
  • Added new notebook (that tests end-to-end)
  • I stared at the code and made sure it makes sense

Suggested Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added Google Colab support for the newly added notebooks.
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I ran make format; make lint to appease the lint gods

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Feb 23, 2024
@bclavie bclavie changed the title fix: calculate ColBERT similarity per token rather than vs pooled query beds fix(ColbertRerank): calculate ColBERT similarity per token rather than vs pooled query beds Feb 23, 2024
@bclavie bclavie changed the title fix(ColbertRerank): calculate ColBERT similarity per token rather than vs pooled query beds fix(ColbertRerank): calculate ColBERT similarity per token rather than vs pooled query embeds Feb 23, 2024
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Feb 23, 2024
@hatianzhang
Copy link
Contributor

@bclavie thanks for the fix.

@hatianzhang hatianzhang merged commit b285c6f into run-llama:main Feb 23, 2024
8 checks passed
Dominastorm pushed a commit to uptrain-ai/llama_index that referenced this pull request Feb 28, 2024
…n vs pooled query embeds (run-llama#11335)

fix: calculate ColBERT similarity per token rather than vs pooled query embedding
anoopshrma pushed a commit to anoopshrma/llama_index that referenced this pull request Mar 2, 2024
…n vs pooled query embeds (run-llama#11335)

fix: calculate ColBERT similarity per token rather than vs pooled query embedding
Izukimat pushed a commit to Izukimat/llama_index that referenced this pull request Mar 29, 2024
…n vs pooled query embeds (run-llama#11335)

fix: calculate ColBERT similarity per token rather than vs pooled query embedding
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants