M2 BERT 128 Retrieval Encoder V1

🚀 Monarch Mixer-BERT

論文 Benchmarking and Building Long-Context Retrieval Models with LoCo and M2-BERT の M2-BERT-128 用の80Mチェックポイントです。

このモデルのダウンロードとファインチューニングの手順については、GitHub をご覧ください！

🚀 クイックスタート

このモデルは、文章の埋め込みを生成して検索に利用します。埋め込みの次元数は768です。

💻 使用例

基本的な使用法

Hugging Face の AutoModel を使用してこのモデルをロードできます。

from transformers import AutoModelForMaskedLM
model = AutoModelForMaskedLM.from_pretrained("jonsaadfalcon/M2-BERT-128-Retrieval-Encoder-V1", trust_remote_code=True)

このモデルは、Hugging Face の bert-base-uncased tokenizer を使用します。

from transformers import BertTokenizer
tokenizer = BertTokenizer.from_pretrained('bert-base-uncased')

高度な使用法

このコード例では、文章の埋め込みを生成する方法を示しています。

from transformers import AutoTokenizer, AutoModelForMaskedLM

max_seq_length = 128
testing_string = "Every morning, I make a cup of coffee to start my day."
model = AutoModelForMaskedLM.from_pretrained("jonsaadfalcon/M2-BERT-128-Retrieval-Encoder-V1", trust_remote_code=True)

tokenizer = AutoTokenizer.from_pretrained("bert-base-uncased", model_max_length=max_seq_length)
input_ids = tokenizer([testing_string], return_tensors="pt", padding="max_length", return_token_type_ids=False, truncation=True, max_length=max_seq_length)

outputs = model(**input_ids)
embeddings = outputs['sentence_embedding']

リモートコード

このモデルを from_pretrained メソッドでロードする際には、trust_remote_code=True を渡す必要があります。これは、カスタムのPyTorchコードを使用しているためです（詳細はGitHubを参照）。また、コードの正確なgitコミットを指定する revision 引数を渡すことを検討してください。

mlm = AutoModelForMaskedLM.from_pretrained(
   "jonsaadfalcon/M2-BERT-128-Retrieval-Encoder-V1",
   trust_remote_code=True,
)

設定

use_flash_mm はデフォルトで false です。現在、FlashMMの使用はサポートされていません。

📄 ライセンス

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