Biencoder Mminilmv2 L12 Mmarcofr

🚀 biencoder-mMiniLMv2-L12-mmarcoFR

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

🚀 クイックスタート

このモデルを使用するには、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-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を使用する場合

まず、ライブラリをインストールします。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-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)

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

学習

データ

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

実装

このモデルは、nreimers/mMiniLMv2-L12-H384-distilled-from-XLMR-Largeチェックポイントから初期化され、温度0.05の交差エントロピー損失（DPRのように）を介して最適化されます。AdamWオプティマイザーを使用して、バッチサイズ152、ピーク学習率2e-5、最初の500ステップでウォームアップ、線形スケジューリングで、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',
}