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

doc: colbert add score_function & doc section #1592

Merged
merged 3 commits into from
Dec 15, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ evaluation.run(
</details>

<details>
<summary> Saving retrieval task predictions </summary>
<summary> Late Interaction (ColBERT) </summary>

### Using Late Interaction models for retrieval

Expand All @@ -336,10 +336,16 @@ evaluation = MTEB(tasks=tasks)
evaluation.run(
colbert,
eval_splits=eval_splits,
score_function="max_sim",
sam-hey marked this conversation as resolved.
Show resolved Hide resolved
corpus_chunk_size=500,
)
```
This implementation uses the MaxSim operation to calculate the similarity between the sentences. Because of this, the number of embeddings processed is higher, which might lead to higher resource usage. Therefore, you can lower the `corpus_chunk_size` to reduce the load on resources.
This implementation employs the MaxSim operation to compute the similarity between sentences. While MaxSim provides high-quality results, it processes a larger number of embeddings, potentially leading to increased resource usage. To manage resource consumption, consider lowering the `corpus_chunk_size` parameter.

Currently, this implementation does not utilize an index. However, support for indexing will be introduced once PyLate adds compatibility with the PLAID Index. You can track the progress of this feature on the PyLate GitHub repository: [Issue #72](https://github.com/lightonai/pylate/issues/72).
sam-hey marked this conversation as resolved.
Show resolved Hide resolved

<details>
sam-hey marked this conversation as resolved.
Show resolved Hide resolved
<summary> Saving retrieval task predictions </summary>

### Saving retrieval task predictions

Expand Down
Loading