juliuslipp commited on
Commit
5c8386d
1 Parent(s): d60b0d4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +22 -14
README.md CHANGED
@@ -22,7 +22,9 @@ You can learn more about the models in our [blog post](https://www.mixedbread.ai
22
 
23
  We recommend using the [RAGatouille](https://github.com/bclavie/RAGatouille) for using our ColBERT model.
24
 
25
- `pip install ragatouille`
 
 
26
 
27
 
28
 
@@ -52,17 +54,23 @@ results = RAG.search(query)
52
  The result looks like this:
53
 
54
  ```
55
- [{'content': "'To Kill a Mockingbird' is a novel by Harper Lee published in 1960. It was immediately successful, winning the Pulitzer Prize, and has become a classic of modern American literature.",
56
- 'score': 28.453125,
57
- 'rank': 1,
58
- 'document_id': '9d564e82-f14f-433a-ab40-b10bda9dc370',
59
- 'passage_id': 0},
60
- {'content': "Harper Lee, an American novelist widely known for her novel 'To Kill a Mockingbird', was born in 1926 in Monroeville, Alabama. She received the Pulitzer Prize for Fiction in 1961.",
61
- 'score': 27.03125,
62
- 'rank': 2,
63
- 'document_id': 'a35a89c3-b610-4e2e-863e-fa1e7e0710a6',
64
- 'passage_id': 2},
65
- ...]
 
 
 
 
 
 
66
  ```
67
 
68
  ## Using API
@@ -99,7 +107,7 @@ Find more in our [blog-post](https://www.mixedbread.ai/blog/mxbai-rerank-v1) and
99
 
100
  ### 2. Retrieval Performance
101
 
102
- ColBERT is mainly used for reranking. Here, we also test our model's performance on retrieval tasks on a subset of the BEIR benchmarks.
103
 
104
  Due to resource limitations, we only test our model on three beir tasks. NDCG@10 servers as the main metric.
105
 
@@ -110,7 +118,7 @@ Due to resource limitations, we only test our model on three beir tasks. NDCG@10
110
  | SciFact | 68.9 | 70.1 | **71.3** |
111
  | TREC-COVID | 72.6 | 75.0 | **80.5** |
112
 
113
- Although our ColBERT also performs well on retrieval, we recommend using our embedding model [mixedbread-ai/mxbai-embed-large-v1](https://huggingface.co/mixedbread-ai/mxbai-embed-large-v1) for retrieval.
114
 
115
 
116
  ## Community
 
22
 
23
  We recommend using the [RAGatouille](https://github.com/bclavie/RAGatouille) for using our ColBERT model.
24
 
25
+ ```sh
26
+ pip install ragatouille
27
+ ```
28
 
29
 
30
 
 
54
  The result looks like this:
55
 
56
  ```
57
+ [
58
+ {
59
+ 'content': "'To Kill a Mockingbird' is a novel by Harper Lee published in 1960. It was immediately successful, winning the Pulitzer Prize, and has become a classic of modern American literature.",
60
+ 'score': 28.453125,
61
+ 'rank': 1,
62
+ 'document_id': '9d564e82-f14f-433a-ab40-b10bda9dc370',
63
+ 'passage_id': 0
64
+ },
65
+ {
66
+ 'content': "Harper Lee, an American novelist widely known for her novel 'To Kill a Mockingbird', was born in 1926 in Monroeville, Alabama. She received the Pulitzer Prize for Fiction in 1961.",
67
+ 'score': 27.03125,
68
+ 'rank': 2,
69
+ 'document_id': 'a35a89c3-b610-4e2e-863e-fa1e7e0710a6',
70
+ 'passage_id': 2
71
+ },
72
+ ...
73
+ ]
74
  ```
75
 
76
  ## Using API
 
107
 
108
  ### 2. Retrieval Performance
109
 
110
+ We also test our model's performance on retrieval tasks on a subset of the BEIR benchmarks. We'll be providing the full results for the benchmark soon (actively working on it).
111
 
112
  Due to resource limitations, we only test our model on three beir tasks. NDCG@10 servers as the main metric.
113
 
 
118
  | SciFact | 68.9 | 70.1 | **71.3** |
119
  | TREC-COVID | 72.6 | 75.0 | **80.5** |
120
 
121
+ Although our ColBERT also performs well on retrieval tasks, we still recommend using our flagship embedding model [mixedbread-ai/mxbai-embed-large-v1](https://huggingface.co/mixedbread-ai/mxbai-embed-large-v1) for that.
122
 
123
 
124
  ## Community