logo
在社区内搜索

bge-large-en

智源研究院 (开源)文本表示
前往使用

bge-large-en

将任意文本映射为低维稠密向量,以用于检索、分类、聚类或语义匹配等任务,并可支持为大模型调用外部知识。

************* 🌟Updates🌟 *************

  • 08/09/2023: BGE模型整合入Langchain, 可以在langchain中非常简单的使用它; C-MTEB中文榜单已在线更新.
  • 08/05/2023: 发布更小的模型(base, small), 在同尺寸模型中取得最好的性能! 🤗
  • 08/02/2023: 🎉 🎉 发布中英文向量模型BGE(BAAI General Embedding的缩写), 在MTEB和C-MTEB榜单上取得最好的性能
  • 08/01/2023: 发布大规模中文文本向量评测榜单 (C-MTEB), 其包括31个测试任务.

Model List

ModelLanguageDescriptionquery instruction for retrieval*
BAAI/bge-large-enEnglish🏆 在 MTEB 榜单上排名第一Represent this sentence for searching relevant passages:
BAAI/bge-base-enEnglishMTEB 榜单上排名第二Represent this sentence for searching relevant passages:
BAAI/bge-small-enEnglishsmall-scale模型,性能高于很多开源large-scale模型,推理更高效Represent this sentence for searching relevant passages:
BAAI/bge-large-zhChinese🏆 在 C-MTEB 榜单上排名第一为这个句子生成表示以用于检索相关文章:
BAAI/bge-large-zh-noinstructChineseC-MTEB 榜单上排名第二--
BAAI/bge-base-zhChinesebase-scale模型,与bge-large性能类似,但推理更快,向量维度更小为这个句子生成表示以用于检索相关文章:
BAAI/bge-small-zhChinesesmall-scale模型,推理比base模型更快为这个句子生成表示以用于检索相关文章:

*: 如果您需要为一个简短的查询搜索相关的长文档,您需要在查询中添加指令;在其他情况下,不需要指令,直接使用原始查询即可。在任何情况下,您都不需要为候选文档增加指令

常见问题

  1. 不相似句子之间的相似度分数很高

由于采取了对比学习进行训练且温度系数设置为0.01, 当前BGE模型的相似度分布并不是[0, 1]区间的均匀分布,其大概处于[0.6, 1]这个区间,因此并不是大于0.6就代表相似。 尤其是对于长度较短句子之间的相似度,当前模型的相似度数值会偏高。

对于检索任务或者相似度任务,影响结果的是不同句子间相似度的相对大小关系,而不是绝对数值。 如若需要根据相似度阈值筛选相似句子,请根据实际数据上的相似度分布情况,使用一个合适的相似度阈值(如0.8, 0.85,甚至是0.9)。 如果你想调整相似度分布,你可以在你的数据上使用更大的温度系数微调模型或者尝试使用其他损失函数。

  1. 什么时候需要添加查询指令

对于一个使用短查询寻找相关长文档的检索任务,查询与文档之间长度非常不一致,推荐为短查询添加指令。 其他任务,推荐不添加指令,例如,像quora这类用一个较短的问题去搜索其他相关的短问题,推荐不添加指令。 具体是否添加指令,可以根据实际情况选择其中表现最好的方式。 在所有情况下,文档端都不用添加指令,只是查询端可以选择是否添加指令。

使用方法

这里展示了一些通过 FlagEmbedding, Sentence-Transformers, Langchain, or Huggingface Transformers. 使用bge模型的方法。

Using FlagEmbedding

pip install -U FlagEmbedding

如果您使用了镜像,可能无法找到最新版的FlagEmbedding。 可以参考FlagEmbedding 下载改项目进行安装。

from FlagEmbedding import FlagModel
sentences = ["样例数据-1", "样例数据-2"]
model = FlagModel('BAAI/bge-large-zh', query_instruction_for_retrieval="为这个句子生成表示以用于检索相关文章:")
embeddings_1 = model.encode(sentences)
embeddings_2 = model.encode(sentences)
similarity = embeddings_1 @ embeddings_2.T
print(similarity)

# 对于短查询到长文档的检索任务,请对查询使用 encode_queries() 函数,其会自动为每个查询加上指令
# 由于候选文本不需要添加指令,检索中的候选集依然使用 encode() 或 encode_corpus() 函数
queries = ['query_1', 'query_2']
passages = ["样例文档-1", "样例文档-2"]
q_embeddings = model.encode_queries(queries)
p_embeddings = model.encode(passages)
scores = q_embeddings @ p_embeddings.T

Instruction参数 query_instruction_for_retrieval 请参照: Model List. 当加载你微调后的模型时,如果你没有在训练的json文件中为query添加指令,则将其设置为空字符串""; 如果你在训练数据中为query添加了指令,更改为你新设置的指令。

FlagModel支持GPU也支持CPU推理。如果GPU可用,其默认优先使用GPU。如果想禁止其使用GPU,设置os.environ["CUDA_VISIBLE_DEVICES"]="" 为提高效率,FlagModel默认会使用所有的GPU进行推理。如果想要使用具体的GPU,请设置os.environ["CUDA_VISIBLE_DEVICES"]

Using Sentence-Transformers

安装 sentence-transformers:

pip install -U sentence-transformers

基于Sentence-Transformers的使用方法:

from sentence_transformers import SentenceTransformer
sentences = ["样例数据-1", "样例数据-2"]
model = SentenceTransformer('BAAI/bge-large-zh')
embeddings_1 = model.encode(sentences, normalize_embeddings=True)
embeddings_2 = model.encode(sentences, normalize_embeddings=True)
similarity = embeddings_1 @ embeddings_2.T
print(similarity)

对于短查询到长文档的检索任务, 每个查询都应该以一条指令开始(指令参考 Model List). 但对于文档,不需要添加任何指令。

queries = ['query_1', 'query_2']
passages = ["样例文档-1", "样例文档-2"]
instruction = "为这个句子生成表示以用于检索相关文章:"
model = SentenceTransformer('BAAI/bge-large-zh')
q_embeddings = model.encode([instruction+q for q in queries], normalize_embeddings=True)
p_embeddings = model.encode(passages, normalize_embeddings=True)
scores = q_embeddings @ p_embeddings.T

如果想使用sentence_transformers加载你微调后的模型,可以参考这里 。 同时,对于instruction, 如果你没有在训练的json文件中为query添加指令,则将其设置为空字符串""; 如果你在训练数据中为query添加了指令,更改为你新设置的指令。

Using Langchain

在Langchian中使用bge模型:

from langchain.embeddings import HuggingFaceBgeEmbeddings
model_name = "BAAI/bge-small-en"
model_kwargs = {'device': 'cpu'}
encode_kwargs = {'normalize_embeddings': True} # set True to compute cosine similarity
model = HuggingFaceBgeEmbeddings(
    model_name=model_name,
    model_kwargs=model_kwargs,
    encode_kwargs=encode_kwargs
)

Using HuggingFace Transformers

使用transformers库时,您可以这样使用模型:首先,将输入传递给transformer模型,然后选择第一个标记的最后一个隐藏状态(即[CLS])作为句子嵌入。

from transformers import AutoTokenizer, AutoModel
import torch
# Sentences we want sentence embeddings for
sentences = ["样例数据-1", "样例数据-2"]

# Load model from HuggingFace Hub
tokenizer = AutoTokenizer.from_pretrained('BAAI/bge-large-zh')
model = AutoModel.from_pretrained('BAAI/bge-large-zh')

# Tokenize sentences
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
# 对于短查询到长文档的检索任务, 为查询加上指令
# encoded_input = tokenizer([instruction + q for q in queries], padding=True, truncation=True, return_tensors='pt')

# Compute embeddings
with torch.no_grad():
    model_output = model(**encoded_input)
    # Perform pooling. In this case, cls pooling.
    sentence_embeddings = model_output[0][:, 0]
# normalize embeddings
sentence_embeddings = torch.nn.functional.normalize(sentence_embeddings, p=2, dim=1)
print("Sentence embeddings:", sentence_embeddings)

评分

baai-general-embedding 模型在MTEB和C-MTEB排行榜上都实现了最先进的性能! 更多细节和评估脚本请参见 C_MTEB.

  • MTEB:
Model NameDimensionSequence LengthAverage (56)Retrieval (15)Clustering (11)Pair Classification (3)Reranking (4)STS (10)Summarization (1)Classification (12)
bge-large-en102451263.9853.946.9885.859.4881.5632.0676.21
bge-base-en76851263.3653.046.3285.8658.781.8429.2775.27
gte-large102451263.1352.2246.8485.0059.1383.3531.6673.33
gte-base76851262.3951.1446.284.5758.6182.331.1773.01
e5-large-v2102451262.2550.5644.4986.0356.6182.0530.1975.24
bge-small-en38451262.1151.8244.3183.7857.9780.7230.5374.37
instructor-xl76851261.7949.2644.7486.6257.2983.0632.3261.79
e5-base-v276851261.550.2943.8085.7355.9181.0530.2873.84
gte-small38451261.3649.4644.8983.5457.782.0730.4272.31
text-embedding-ada-0021536819260.9949.2545.984.8956.3280.9730.870.93
e5-small-v238451259.9349.0439.9284.6754.3280.3931.1672.94
sentence-t5-xxl76851259.5142.2443.7285.0656.4282.6330.0873.42
all-mpnet-base-v276851457.7843.8143.6983.0459.3680.2827.4965.07
sgpt-bloom-7b1-msmarco4096204857.5948.2238.9381.955.6577.7433.666.19
all-MiniLM-L12-v238451256.5342.6941.8182.4158.4479.827.963.21
all-MiniLM-L6-v238451256.2641.9542.3582.3758.0478.930.8163.05
contriever-base-msmarco76851256.0041.8841.182.5453.1476.5130.3666.68
sentence-t5-base76851255.2733.6340.2185.1853.0981.1431.3969.81
  • C-MTEB:

我们建立了一个中文文本嵌入的基准测试集合C-MTEB,其包括6个任务的31个数据集。 请参阅C_MTEB获取详细介绍。

ModelEmbedding dimensionAvgRetrievalSTSPairClassificationClassificationRerankingClustering
bge-large-zh102464.2071.5354.9878.9468.3265.1148.39
bge-large-zh-noinstruct102463.5370.555376.7768.5864.9150.01
BAAI/bge-base-zh76862.9669.5354.1277.567.0764.9147.63
multilingual-e5-large102458.7963.6648.4469.8967.3456.0048.23
BAAI/bge-small-zh51258.2763.0749.4570.3563.6461.4845.09
m3e-base76857.1056.9150.4763.9967.5259.3447.68
m3e-large102457.0554.7550.4264.368.259.6648.88
multilingual-e5-base76855.4861.6346.4967.0765.3554.3540.68
multilingual-e5-small38455.3859.9545.2766.4565.8553.8645.26
text-embedding-ada-002(OpenAI)153653.0252.043.3569.5664.3154.2845.68
luotuo102449.3744.442.7866.626149.2544.39
text2vec-base76847.6338.7943.4167.4162.1949.4537.66
text2vec-large102447.3641.9444.9770.8660.6649.1630.02

大模型训练

本节将介绍我们用于训练通用嵌入向量的方法。 训练脚本在FlagEmbedding中。 同时,我们提供了一些示例来进行预训练微调

1. RetroMAE Pre-train

我们按照 retromae 方法对模型进行预训练, 其在检索任务中表现出了良好的性能( 参考论文 )。 预训练是在24块A100(40G) gpu上进行的,batch大小为720。在retromae中,编码器和解码器的掩码率分别为0.3和0.5。 使用AdamW优化器,学习率为2e-5。

Pre-training data:

2. Finetune

我们使用对比学习训练模型,输入数据的格式是一个三元组' (query, positive, negative) '。 除了三元组中的负样本,我们还使用了in-batch的负样本。我们采用 跨设备负样本共享方法 在不同的gpu之间共享负样本,这会显著地增加负样本的数量。 我们在48块A100(40G) gpu上训练模型,batch大小为32,768。 我们使用AdamW优化器,学习率为1e-5。 对比损失的温度系数为0.01。

同时,我们在训练中为短查询到长文档的检索任务中的查询添加了instruction。 对于英语,指令是Represent this sentence for searching relevant passages: ; 对于中文,指令是为这个句子生成表示以用于检索相关文章:. 在评测中,针对段落检索任务,需要在查询中添加指令,但不需要为段落文档添加指令。

微调脚本可以在这个存储库中访问:FlagEmbedding, 你可以用它轻松地微调你的模型。

Training data:

-对于英语,我们从 wikipediacc-net 等收集了2.3亿个文本对。 -对于中文,我们从 悟道simclue等收集了1.2亿对文本。

我们计划在将来发布训练数据集。

协议

FlagEmbedding基于MIT License开源协议。发布的模型权重可商用。

免责声明

bge-large-en模型来源于第三方,百度智能云千帆大模型平台不保证其合规性,请您在使用前慎重考虑,确保合法合规使用并遵守第三方的要求。具体请查看模型的开源协议MIT License及模型开源页面展示信息等。如您发现模型/数据集/文件等有任何问题,请及时联系我们处理。