new: add reranker example to readme (#390)

* new: add reranker example to readme * Update README.md Co-authored-by: Anush <[email protected]> * fix: compute the scores --------- Co-authored-by: Anush <[email protected]>
qdrant · Nov 7, 2024 · e868bba · e868bba
1 parent a5f3f11
commit e868bba
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -137,6 +137,21 @@ embeddings = list(model.embed(images))
 # ]
 ```
 
+### 🔄 Rerankers
+```python
+from typing import List
+from fastembed.rerank.cross_encoder import TextCrossEncoder
+
+query = "Who is maintaining Qdrant?"
+documents: List[str] = [
+    "This is built to be faster and lighter than other embedding libraries e.g. Transformers, Sentence-Transformers, etc.",
+    "fastembed is supported by and maintained by Qdrant.",
+]
+encoder = TextCrossEncoder(model_name="Xenova/ms-marco-MiniLM-L-6-v2")
+scores = list(encoder.rerank(query, documents))
+
+# [-11.48061752319336, 5.472434997558594]
+```
 
 ## ⚡️ FastEmbed on a GPU