ldwang commited on
Commit
45e16d1
β€’
1 Parent(s): 0b329b7
Files changed (1) hide show
  1. README.md +7 -6
README.md CHANGED
@@ -17,6 +17,7 @@ language:
17
  <h4 align="center">
18
  <p>
19
  <a href=#model-list>Model List</a> |
 
20
  <a href=#usage>Usage</a> |
21
  <a href="#evaluation">Evaluation</a> |
22
  <a href="#train">Train</a> |
@@ -36,8 +37,8 @@ And it also can be used in vector databases for LLMs.
36
 
37
  ************* 🌟**Updates**🌟 *************
38
  - 09/12/2023: New Release:
39
- - **New reranker model**: release a cross-encoder model bge-reranker-base, which is more powerful than embedding model. We recommend to use/fine-tune it to re-rank top-k documents returned by embedding models.
40
- - **update embedding model**: release bge-*-v1.5 embedding model to alleviate the issue of the similarity distribution, and enhance its retrieval ability without instruction.
41
  - 09/07/2023: Update [fine-tune code](https://github.com/FlagOpen/FlagEmbedding/blob/master/FlagEmbedding/baai_general_embedding/README.md): Add script to mine hard negatives and support adding instruction during fine-tuning.
42
  - 08/09/2023: BGE Models are integrated into **Langchain**, you can use it like [this](#using-langchain); C-MTEB **leaderboard** is [available](https://huggingface.co/spaces/mteb/leaderboard).
43
  - 08/05/2023: Release base-scale and small-scale models, **best performance among the models of the same size πŸ€—**
@@ -69,7 +70,7 @@ And it also can be used in vector databases for LLMs.
69
 
70
  \*: If you need to search the relevant passages to a query, we suggest to add the instruction to the query; in other cases, no instruction is needed, just use the original query directly. In all cases, **no instruction** needs to be added to passages.
71
 
72
- \**: To balance the accuracy and time cost, cross-encoder is widely used to re-rank top-k documents retrieved by other simple models.
73
  For examples, use bge embedding model to retrieve top 100 relevant documents, and then use bge reranker to re-rank the top 100 document to get the final top-3 results.
74
 
75
 
@@ -81,7 +82,7 @@ For examples, use bge embedding model to retrieve top 100 relevant documents, an
81
  <!-- ### How to fine-tune bge embedding model? -->
82
  Following this [example](https://github.com/FlagOpen/FlagEmbedding/tree/master/examples/finetune) to prepare data and fine-tune your model.
83
  Some suggestions:
84
- - Mine hard negatives following this [example](https://github.com/FlagOpen/FlagEmbedding/tree/master/examples/finetune#data-format), which can improve the retrieval performance.
85
  - If you pre-train bge on your data, the pre-trained model cannot be directly used to calculate similarity, and it must be fine-tuned with contrastive learning before computing similarity.
86
  - If the accuracy of the fine-tuned model is still not high, it is recommended to use/fine-tune the cross-encoder model (bge-reranker) to re-rank top-k results. Hard negatives also are needed to fine-tune reranker.
87
 
@@ -365,8 +366,8 @@ Cross-encoder will perform full-attention over the input pair,
365
  which is more accurate than embedding model (i.e., bi-encoder) but more time-consuming than embedding model.
366
  Therefore, it can be used to re-rank the top-k documents returned by embedding model.
367
  We train the cross-encoder on a multilingual pair data,
368
- The data format is the same as embedding model, so you can fine-tune it easily following our example.
369
- More details pelease refer to [./FlagEmbedding/reranker/README.md](./FlagEmbedding/reranker/README.md)
370
 
371
 
372
  ## Contact
 
17
  <h4 align="center">
18
  <p>
19
  <a href=#model-list>Model List</a> |
20
+ <a href=#frequently-asked-questions>FAQ</a> |
21
  <a href=#usage>Usage</a> |
22
  <a href="#evaluation">Evaluation</a> |
23
  <a href="#train">Train</a> |
 
37
 
38
  ************* 🌟**Updates**🌟 *************
39
  - 09/12/2023: New Release:
40
+ - **New reranker model**: release cross-encoder models `BAAI/bge-reranker-base` and `BAAI/bge-reranker-large`, which are more powerful than embedding model. We recommend to use/fine-tune them to re-rank top-k documents returned by embedding models.
41
+ - **update embedding model**: release `bge-*-v1.5` embedding model to alleviate the issue of the similarity distribution, and enhance its retrieval ability without instruction.
42
  - 09/07/2023: Update [fine-tune code](https://github.com/FlagOpen/FlagEmbedding/blob/master/FlagEmbedding/baai_general_embedding/README.md): Add script to mine hard negatives and support adding instruction during fine-tuning.
43
  - 08/09/2023: BGE Models are integrated into **Langchain**, you can use it like [this](#using-langchain); C-MTEB **leaderboard** is [available](https://huggingface.co/spaces/mteb/leaderboard).
44
  - 08/05/2023: Release base-scale and small-scale models, **best performance among the models of the same size πŸ€—**
 
70
 
71
  \*: If you need to search the relevant passages to a query, we suggest to add the instruction to the query; in other cases, no instruction is needed, just use the original query directly. In all cases, **no instruction** needs to be added to passages.
72
 
73
+ \**: Different embedding model, reranker is a cross-encoder, which cannot be used to generate embedding. To balance the accuracy and time cost, cross-encoder is widely used to re-rank top-k documents retrieved by other simple models.
74
  For examples, use bge embedding model to retrieve top 100 relevant documents, and then use bge reranker to re-rank the top 100 document to get the final top-3 results.
75
 
76
 
 
82
  <!-- ### How to fine-tune bge embedding model? -->
83
  Following this [example](https://github.com/FlagOpen/FlagEmbedding/tree/master/examples/finetune) to prepare data and fine-tune your model.
84
  Some suggestions:
85
+ - Mine hard negatives following this [example](https://github.com/FlagOpen/FlagEmbedding/tree/master/examples/finetune#hard-negatives), which can improve the retrieval performance.
86
  - If you pre-train bge on your data, the pre-trained model cannot be directly used to calculate similarity, and it must be fine-tuned with contrastive learning before computing similarity.
87
  - If the accuracy of the fine-tuned model is still not high, it is recommended to use/fine-tune the cross-encoder model (bge-reranker) to re-rank top-k results. Hard negatives also are needed to fine-tune reranker.
88
 
 
366
  which is more accurate than embedding model (i.e., bi-encoder) but more time-consuming than embedding model.
367
  Therefore, it can be used to re-rank the top-k documents returned by embedding model.
368
  We train the cross-encoder on a multilingual pair data,
369
+ The data format is the same as embedding model, so you can fine-tune it easily following our [example](https://github.com/FlagOpen/FlagEmbedding/tree/master/examples/reranker).
370
+ More details pelease refer to [./FlagEmbedding/reranker/README.md](https://github.com/FlagOpen/FlagEmbedding/tree/master/FlagEmbedding/reranker)
371
 
372
 
373
  ## Contact