All Mpnet Base V2 Feature Extraction Pipeline

🚀 all-mpnet-base-v2

このモデルはsentence-transformersを使用したもので、文章や段落を768次元の密ベクトル空間にマッピングし、クラスタリングや意味検索などのタスクに使用できます。

🚀 クイックスタート

sentence-transformersを使用する場合

sentence-transformersをインストールすると、このモデルの使用が簡単になります。

pip install -U sentence-transformers

その後、以下のようにモデルを使用できます。

from sentence_transformers import SentenceTransformer
sentences = ["This is an example sentence", "Each sentence is converted"]

model = SentenceTransformer('sentence-transformers/all-mpnet-base-v2')
embeddings = model.encode(sentences)
print(embeddings)

HuggingFace Transformersを使用する場合

sentence-transformersを使用せずに、以下のようにモデルを使用できます。まず、入力をTransformerモデルに通し、その後、文脈化された単語埋め込みに対して適切なプーリング操作を適用する必要があります。

from transformers import AutoTokenizer, AutoModel
import torch
import torch.nn.functional as F

#Mean Pooling - Take attention mask into account for correct averaging
def mean_pooling(model_output, attention_mask):
    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)


# Sentences we want sentence embeddings for
sentences = ['This is an example sentence', 'Each sentence is converted']

# Load model from HuggingFace Hub
tokenizer = AutoTokenizer.from_pretrained('sentence-transformers/all-mpnet-base-v2')
model = AutoModel.from_pretrained('sentence-transformers/all-mpnet-base-v2')

# Tokenize sentences
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')

# Compute token embeddings
with torch.no_grad():
    model_output = model(**encoded_input)

# Perform pooling
sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])

# Normalize embeddings
sentence_embeddings = F.normalize(sentence_embeddings, p=2, dim=1)

print("Sentence embeddings:")
print(sentence_embeddings)

📚 ドキュメント

評価結果

このモデルの自動評価については、Sentence Embeddings Benchmarkを参照してください: https://seb.sbert.net

背景

このプロジェクトの目的は、自己教師付きのコントラスト学習目標を使用して、非常に大規模な文章レベルのデータセットで文章埋め込みモデルを学習させることです。事前学習されたmicrosoft/mpnet-baseモデルを使用し、10億件の文章ペアデータセットでファインチューニングを行いました。コントラスト学習目標を使用しており、ペアからの文章が与えられた場合、モデルはランダムにサンプリングされた他の文章のセットの中から、実際にデータセットでペアになっている文章を予測する必要があります。

このモデルは、Hugging Faceが主催するCommunity week using JAX/Flax for NLP & CVの間に開発されました。Train the Best Sentence Embedding Model Ever with 1B Training Pairsというプロジェクトの一環として開発され、7台のTPU v3 - 8という効率的なハードウェアインフラストラクチャを利用し、GoogleのFlax、JAX、Cloudチームメンバーからの効率的な深層学習フレームワークに関する助言も得ました。

想定される用途

このモデルは、文章や短い段落のエンコーダーとして使用することを想定しています。入力テキストが与えられると、意味情報を捉えたベクトルを出力します。この文章ベクトルは、情報検索、クラスタリング、文章類似度タスクに使用できます。

デフォルトでは、384語片より長い入力テキストは切り捨てられます。

学習手順

事前学習

事前学習済みのmicrosoft/mpnet-baseモデルを使用しています。事前学習手順の詳細については、モデルカードを参照してください。

ファインチューニング

コントラスト目標を使用してモデルをファインチューニングしています。正式には、バッチ内のすべての可能な文章ペアからコサイン類似度を計算し、真のペアと比較して交差エントロピー損失を適用します。

ハイパーパラメータ

このモデルはTPU v3 - 8で学習されました。バッチサイズ1024（TPUコアあたり128）を使用して100,000ステップ学習されました。学習率のウォームアップは500ステップで行い、シーケンス長は128トークンに制限されました。AdamWオプティマイザーを使用し、学習率は2e - 5です。完全な学習スクリプトはこのリポジトリのtrain_script.pyで入手できます。

学習データ

複数のデータセットを連結してモデルをファインチューニングしています。文章ペアの総数は10億を超えています。各データセットは重み付き確率に基づいてサンプリングされ、その設定はdata_config.jsonファイルに詳細が記載されています。

📄 ライセンス

このプロジェクトは、Apache 2.0ライセンスの下で公開されています。