fleshed readme

jcntrl · Dec 6, 2023 · a4fcec5 · a4fcec5
1 parent 15b5bb7
commit a4fcec5
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -30,11 +30,11 @@ pip install flashrank
 ## Usage:
 ```python
 from flashrank.Ranker import Ranker
-# for default blazing fast model and competitive performance.
+# for short to medium passages, default blazing fast model and competitive performance.
 ranker = Ranker()
 
 or 
-# for a slower deeper model for a slightly better performance.
+# for medium to long passages (slower model) with slightly better performance.
 ranker = Ranker(model_name="ms-marco-MiniLM-L-12-v2", cache_dir="/opt")
 ```