Update README.md

README.md

@@ -16,6 +16,7 @@ The easiest way to use our models is through the `rerankers` package. After inst
 
 ```python
 from rerankers import Reranker
+import torch
 
 query = "O futebol é uma paixão nacional"
 docs = [
@@ -24,54 +25,37 @@ docs = [
 ]
 
 ranker = Reranker(
-    "unicamp-dl/monoptt5-small",
+    "unicamp-dl/monoptt5-large",
     inputs_template="Pergunta: {query} Documento: {text} Relevante:",
+    dtype=torch.float32  # or bfloat16 if supported by your GPU
 )
-# Relevant logging:
-# Loading T5Ranker model unicamp-dl/monoptt5-small
+
+results = ranker.rank(query, docs)
+
+print("Classification results:")
+for result in results:
+    print(result)
+
+# Loading T5Ranker model unicamp-dl/monoptt5-large
 # No device set
-# Using device cpu
-# No dtype set
-# Device set to `cpu`, setting dtype to `float32`
+# Using device cuda
 # Using dtype torch.float32
-# Loading model unicamp-dl/monoptt5-small, this might take a while...
-# Using device cpu.
+# Loading model unicamp-dl/monoptt5-large, this might take a while...
+# Using device cuda.
 # Using dtype torch.float32.
+# /usr/local/lib/python3.10/dist-packages/huggingface_hub/file_download.py:1132: FutureWarning: `resume_download` is deprecated and will be removed in version 1.0.0. Downloads always resume when possible. If you want to force a new download, use `force_download=True`.
+#   warnings.warn(
 # T5 true token set to ▁Sim
 # T5 false token set to ▁Não
 # Returning normalised scores...
 # Inputs template set to Pergunta: {query} Documento: {text} Relevante:
 
-results = ranker.rerank(query, docs)
-# Results should be something like (can vary depending on the model, the example below uses the "unicamp-dl/monoptt5-small" model)
-RankedResults(
-    results=[
-        Result(
-            document=Document(
-                text="O futebol é uma parte essencial da cultura brasileira e une as pessoas.",
-                doc_id=1,
-                metadata={},
-            ),
-            score=0.91943359375,
-            rank=1,
-        ),
-        Result(
-            document=Document(
-                text="O futebol é superestimado e não deveria receber tanta atenção.",
-                doc_id=0,
-                metadata={},
-            ),
-            score=0.0267486572265625,
-            rank=2,
-        ),
-    ],
-    query="O futebol é uma paixão nacional",
-    has_scores=True,
-)
-
+# Classification results:
+# document=Document(text='O futebol é uma parte essencial da cultura brasileira e une as pessoas.', doc_id=1, metadata={}) score=0.923164963722229 rank=1
+# document=Document(text='O futebol é superestimado e não deveria receber tanta atenção.', doc_id=0, metadata={}) score=0.08710747957229614 rank=2
 ```
 
-For additional configurations and more advanced usage, consult the rerankers documentation.
+For additional configurations and more advanced usage, consult the `rerankers` [GitHub repository](https://github.com/AnswerDotAI/rerankers).
 
 # Citation
 If you use our models, please cite: