numb3r3 commited on
Commit
36e8c67
·
1 Parent(s): b77f123

chore: init readme

Browse files
Files changed (1) hide show
  1. README.md +31 -3
README.md CHANGED
@@ -36,7 +36,32 @@ As you can see, the `jina-reranker-v1-turbo-en` offers a balanced approach with
36
 
37
  # Usage
38
 
39
- You can use `jina-reranker-v1-turbo-en` directly from transformers package:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
40
 
41
  ```python
42
  !pip install transformers
@@ -82,9 +107,12 @@ We evaluated Jina Reranker on 3 key benchmarks to ensure top-tier performance an
82
  | `ms-marco-MiniLM-L-4-v2` | 47.81 | - | 83.82 |
83
  | `bge-reranker-base` | 47.89 | - | 83.03 |
84
 
85
- For more details, please refer to our [benchmarking page](https://jina.ai/reranker/).
 
 
 
86
 
87
- > `NDCG@10` is a measure of ranking quality, with higher scores indicating better search results. `Hit Rate` measures the percentage of relevant documents that appear in the top 10 search results.
88
 
89
  # Contact
90
 
 
36
 
37
  # Usage
38
 
39
+ The easiest way to starting using `jina-reranker-v1-turbo-en` is to use Jina AI's [Reranker API](https://jina.ai/reranker/).
40
+
41
+ ```bash
42
+ curl https://api.jina.ai/v1/rerank \
43
+ -H "Content-Type: application/json" \
44
+ -H "Authorization: Bearer YOUR_API_KEY" \
45
+ -d '{
46
+ "model": "jina-reranker-v1-turbo-en",
47
+ "query": "Organic skincare products for sensitive skin",
48
+ "documents": [
49
+ "Eco-friendly kitchenware for modern homes",
50
+ "Biodegradable cleaning supplies for eco-conscious consumers",
51
+ "Organic cotton baby clothes for sensitive skin",
52
+ "Natural organic skincare range for sensitive skin",
53
+ "Tech gadgets for smart homes: 2024 edition",
54
+ "Sustainable gardening tools and compost solutions",
55
+ "Sensitive skin-friendly facial cleansers and toners",
56
+ "Organic food wraps and storage solutions",
57
+ "All-natural pet food for dogs with allergies",
58
+ "Yoga mats made from recycled materials"
59
+ ],
60
+ "top_n": 3
61
+ }'
62
+ ```
63
+
64
+ Alternatively, you can use the `transformers` library to interact with the model programmatically.
65
 
66
  ```python
67
  !pip install transformers
 
107
  | `ms-marco-MiniLM-L-4-v2` | 47.81 | - | 83.82 |
108
  | `bge-reranker-base` | 47.89 | - | 83.03 |
109
 
110
+ **Note:**
111
+
112
+ - `NDCG@10` is a measure of ranking quality, with higher scores indicating better search results. `Hit Rate` measures the percentage of relevant documents that appear in the top 10 search results.
113
+ - The results of LoCo datasets on other models are not available since they **do not support** long documents more than 512 tokens.
114
 
115
+ For more details, please refer to our [benchmarking page](https://jina.ai/reranker/).
116
 
117
  # Contact
118