Biencoder Electra Base Mmarcofr

🚀 biencoder-electra-base-french-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-electra-base-french-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-electra-base-french-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-electra-base-french-mmarcoFR')
model = AutoModel.from_pretrained('antoinelouis/biencoder-electra-base-french-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 个不同的密集检索器中采样更难的负样本。

实现

该模型从 dbmdz/electra-base-french-europeana-cased-discriminator 检查点初始化，并通过交叉熵损失（如 DPR 中所述）进行优化，温度设置为 0.05。使用 AdamW 优化器，在一块 32GB 的 NVIDIA V100 GPU 上进行 20 个 epoch（即 62400 步）的微调，批量大小为 160，峰值学习率为 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',
}

📋 模型信息