Biencoder Distilcamembert Mmarcofr

🚀 biencoder-distilcamembert-mmarcoFR

このモデルは、セマンティック検索に使用できるフランス語用の高密度シングルベクトルバイエンコーダーモデルです。モデルはクエリとパッセージを768次元の高密度ベクトルにマッピングし、コサイン類似度を使用して関連性を計算します。

🚀 クイックスタート

このモデルを Sentence-Transformers、FlagEmbedding、または Huggingface Transformers で使用する例をいくつか紹介します。

✨ 主な機能

• フランス語用のセマンティック検索に最適化されたバイエンコーダーモデル。
• クエリとパッセージを768次元の高密度ベクトルにマッピングし、コサイン類似度で関連性を計算。

📦 インストール

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-distilcamembert-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-distilcamembert-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を使用する場合

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-distilcamembert-mmarcoFR')
model = AutoModel.from_pretrained('antoinelouis/biencoder-distilcamembert-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万の候補パッセージからなるコーパスに対して6,980のクエリで構成されています。平均逆順位 (MRR)、正規化割引累積ゲイン (NDCG)、平均平均精度 (MAP)、およびさまざまなカットオフでの再現率 (R@k) を報告しています。他のフランス語のニューラルリトリーバーとの比較については、DécouvrIR のリーダーボードを確認してください。

トレーニング

データ

mmarco データセットのフランス語トレーニングサンプルを使用しています。これは、880万のパッセージと539,000のトレーニングクエリを含むMS MARCOの多言語機械翻訳バージョンです。公式データセットが提供するBM25ネイティブを使用せず、msmarco-hard-negatives 蒸留データセットを使用して12の異なる高密度リトリーバーから採掘されたより難しいネガティブをサンプリングしています。

実装

モデルは cmarkea/distilcamembert-base チェックポイントから初期化され、温度0.05の交差エントロピー損失 ( DPR のように) を介して最適化されます。AdamWオプティマイザーを使用して、バッチサイズ152、ピーク学習率2e-5、最初の500ステップでウォームアップし、線形スケジューリングを行いながら、1つの32GB NVIDIA V100 GPUで20エポック (つまり65,700ステップ) ファインチューニングされます。質問とパッセージの最大シーケンス長は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',
}