All Mpnet Base V2

🚀 all-mpnet-base-v2

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

🚀 クイックスタート

✨ 主な機能

• 文章や段落を768次元の密ベクトル空間にマッピングします。
• クラスタリングや意味検索などのタスクに利用できます。

📦 インストール

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

pip install -U sentence-transformers

💻 使用例

基本的な使用法

# Using this model becomes easy when you have [sentence-transformers](https://www.SBERT.net) installed:
from sentence_transformers import SentenceTransformer
sentences = ["This is an example sentence", "Each sentence is converted"]

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

高度な使用法

# Without [sentence-transformers](https://www.SBERT.net), you can use the model like this: First, you pass your input through the transformer model, then you have to apply the right pooling-operation on-top of the contextualized word embeddings.
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('obrizum/all-mpnet-base-v2')
model = AutoModel.from_pretrained('obrizum/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）で100kステップ学習しました。学習率のウォームアップは500で行いました。シーケンス長は128トークンに制限されました。学習率2e - 5のAdamWオプティマイザを使用しました。完全な学習スクリプトは、このリポジトリのtrain_script.pyで入手できます。

学習データ

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

📄 ライセンス

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