🚀 biencoder-mMiniLMv2-L12-mmarcoFR
这是一个用于法语的密集单向量双编码器模型,可用于语义搜索。该模型将查询和段落映射到384维的密集向量,通过余弦相似度计算相关性。
🚀 快速开始
以下是使用 Sentence-Transformers、FlagEmbedding 或 Huggingface Transformers 调用此模型的示例。
📦 安装指南
使用 Sentence-Transformers
首先安装 库:
pip install -U sentence-transformers
使用 FlagEmbedding
首先安装 库:
pip install -U FlagEmbedding
使用 Huggingface Transformers
首先安装 库:
pip install -U transformers
💻 使用示例
基础用法
使用 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-mMiniLMv2-L12-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
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-mMiniLMv2-L12-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)
使用 Huggingface 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]
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-mMiniLMv2-L12-mmarcoFR')
model = AutoModel.from_pretrained('antoinelouis/biencoder-mMiniLMv2-L12-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 的较小开发集上进行评估,该开发集包含880万个候选段落语料库中的6980个查询。我们报告了平均倒数排名(MRR)、归一化折损累积增益(NDCG)、平均精度均值(MAP)以及不同截断点的召回率(R@k)。要查看该模型与其他法语神经检索器的比较情况,请查看 DécouvrIR 排行榜。
训练
数据
我们使用 mMARCO 数据集中的法语训练样本,这是MS MARCO的多语言机器翻译版本,包含880万个段落和53.9万个训练查询。我们没有使用官方数据集提供的BM25负样本,而是使用 msmarco-hard-negatives 蒸馏数据集,从12个不同的密集检索器中挖掘出更难的负样本。
实现
该模型从 nreimers/mMiniLMv2-L12-H384-distilled-from-XLMR-Large 检查点初始化,并通过交叉熵损失(如 DPR 中所述)进行优化,温度设置为0.05。使用AdamW优化器,在一个32GB的NVIDIA V100 GPU上进行20个epoch(即65700步)的微调,批量大小为152,峰值学习率为2e-5,在前500步进行热身并采用线性调度。我们将问题和段落的最大序列长度都设置为128个标记。使用余弦相似度计算相关性得分。
📄 许可证
本项目采用MIT许可证。
📚 引用
@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',
}
信息表格