模型简介
模型特点
模型能力
使用案例
🚀 biencoder-camembert-base-mmarcoFR
这是一个用于法语的密集单向量双编码器模型,可用于语义搜索。该模型将查询和段落映射到768维的密集向量,通过余弦相似度计算相关性。
🚀 快速开始
本模型可以使用 Sentence-Transformers、FlagEmbedding 或 Huggingface Transformers 进行调用,以下是使用示例。
💻 使用示例
基础用法
使用 Sentence-Transformers
首先安装 库:pip install -U sentence-transformers
。然后,你可以这样使用该模型:
from sentence_transformers import SentenceTransformer
queries = ["Ceci est un exemple de requête.", "Voici un second exemple."]
passages = ["Ceci est un exemple de passage.", "Et voilà un deuxième exemple."]
model = SentenceTransformer('antoinelouis/biencoder-camembert-base-mmarcoFR')
q_embeddings = model.encode(queries, normalize_embeddings=True)
p_embeddings = model.encode(passages, normalize_embeddings=True)
similarity = q_embeddings @ p_embeddings.T
print(similarity)
使用 FlagEmbedding
首先安装 库:pip install -U FlagEmbedding
。然后,你可以这样使用该模型:
from FlagEmbedding import FlagModel
queries = ["Ceci est un exemple de requête.", "Voici un second exemple."]
passages = ["Ceci est un exemple de passage.", "Et voilà un deuxième exemple."]
model = FlagModel('antoinelouis/biencoder-camembert-base-mmarcoFR')
q_embeddings = model.encode(queries, normalize_embeddings=True)
p_embeddings = model.encode(passages, normalize_embeddings=True)
similarity = q_embeddings @ p_embeddings.T
print(similarity)
使用 Transformers
首先安装 库:pip install -U transformers
。然后,你可以这样使用该模型:
from transformers import AutoTokenizer, AutoModel
from torch.nn.functional import normalize
def mean_pooling(model_output, attention_mask):
""" Perform mean pooling on-top of the contextualized word embeddings, while ignoring mask tokens in the mean computation."""
token_embeddings = model_output[0] #First element of model_output contains all token embeddings
input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9)
queries = ["Ceci est un exemple de requête.", "Voici un second exemple."]
passages = ["Ceci est un exemple de passage.", "Et voilà un deuxième exemple."]
tokenizer = AutoTokenizer.from_pretrained('antoinelouis/biencoder-camembert-base-mmarcoFR')
model = AutoModel.from_pretrained('antoinelouis/biencoder-camembert-base-mmarcoFR')
q_input = tokenizer(queries, padding=True, truncation=True, return_tensors='pt')
p_input = tokenizer(passages, padding=True, truncation=True, return_tensors='pt')
with torch.no_grad():
q_output = model(**encoded_queries)
p_output = model(**encoded_passages)
q_embeddings = mean_pooling(q_output, q_input['attention_mask'])
q_embedddings = normalize(q_embeddings, p=2, dim=1)
p_embeddings = mean_pooling(p_output, p_input['attention_mask'])
p_embedddings = normalize(p_embeddings, p=2, dim=1)
similarity = q_embeddings @ p_embeddings.T
print(similarity)
📚 详细文档
评估
该模型在 mMARCO-fr 的较小开发集上进行评估,该数据集包含 6980 个查询和 880 万个候选段落的语料库。我们报告了平均倒数排名(MRR)、归一化折损累计增益(NDCG)、平均精度均值(MAP)以及不同截断点的召回率(R@k)。要查看它与其他法语神经检索器的比较情况,请查看 DécouvrIR 排行榜。
训练
数据
我们使用 mMARCO 数据集中的法语训练样本,这是 MS MARCO 的多语言机器翻译版本,包含 880 万个段落和 53.9 万个训练查询。我们没有使用官方数据集提供的 BM25 负样本,而是使用 msmarco-hard-negatives 蒸馏数据集,从 12 个不同的密集检索器中挖掘出更难的负样本。
实现
该模型从 camembert-base 检查点初始化,并通过交叉熵损失(如 DPR 中所述)进行优化,温度为 0.05。使用 AdamW 优化器在一个 32GB NVIDIA V100 GPU 上进行 20 个 epoch(即 65700 步)的微调,批量大小为 152,峰值学习率为 2e-5,在前 500 步进行热身并采用线性调度。我们将问题和段落的最大序列长度都设置为 128 个标记。使用余弦相似度来计算相关性得分。
引用
@online{louis2024decouvrir,
author = 'Antoine Louis',
title = 'DécouvrIR: A Benchmark for Evaluating the Robustness of Information Retrieval Models in French',
publisher = 'Hugging Face',
month = 'mar',
year = '2024',
url = 'https://huggingface.co/spaces/antoinelouis/decouvrir',
}
📄 许可证
本项目采用 MIT 许可证。
📦 模型信息
属性 | 详情 |
---|---|
模型类型 | 密集单向量双编码器模型 |
训练数据 | mMARCO 数据集中的法语训练样本 |
评估指标 | 平均倒数排名(MRR)、归一化折损累计增益(NDCG)、平均精度均值(MAP)、不同截断点的召回率(R@k) |
基础模型 | camembert-base |
库名称 | sentence-transformers |
任务类型 | 句子相似度、段落检索 |
数据集 | unicamp-dl/mmarco |
评估数据集 | mMARCO-fr |
评估结果 | Recall@500: 89.1;Recall@100: 77.8;Recall@10: 51.5;MAP@10: 27.9;nDCG@10: 33.7;MRR@10: 28.5 |







