M2 Bert 80M 2k Retrieval

🚀 Monarch Mixer-BERT

Monarch Mixer-BERTは、M2-BERTの80Mパラメータのチェックポイントで、シーケンス長2048で事前学習され、長文脈の検索に対してファインチューニングされています。

論文 Monarch Mixer: A Simple Sub-Quadratic GEMM-Based Architecture と、長シーケンスのモデル学習方法に関する ブログ記事 をご覧ください。

このモデルは、Jon Saad-Falcon、Dan Fu、Simran Aroraによって学習されました。

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

🚀 クイックスタート

✨ 主な機能

このモデルは、長文脈の検索に特化しており、768次元の埋め込みベクトルを生成します。

📦 インストール

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

💻 使用例

基本的な使用法

from transformers import AutoModelForSequenceClassification
model = AutoModelForSequenceClassification.from_pretrained(
  "togethercomputer/m2-bert-80M-2k-retrieval",
  trust_remote_code=True
)

高度な使用法

このモデルは、長文脈の検索に使用するために、768次元の埋め込みベクトルを生成します。

from transformers import AutoTokenizer, AutoModelForSequenceClassification

max_seq_length = 2048
testing_string = "Every morning, I make a cup of coffee to start my day."
model = AutoModelForSequenceClassification.from_pretrained(
  "togethercomputer/m2-bert-80M-2k-retrieval",
  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']

また、Together APIを使用してこのモデルから埋め込みベクトルを取得することもできます（APIキーは こちら から取得できます）。

import os
import requests

def generate_together_embeddings(text: str, model_api_string: str, api_key: str):
    url = "https://api.together.xyz/api/v1/embeddings"
    headers = {
        "accept": "application/json",
        "content-type": "application/json",
        "Authorization": f"Bearer {api_key}"
    }
    session = requests.Session()
    response = session.post(
        url,
        headers=headers,
        json={
            "input": text,
            "model": model_api_string
        }
    )
    if response.status_code != 200:
        raise ValueError(f"Request failed with status code {response.status_code}: {response.text}")
    return response.json()['data'][0]['embedding']

print(generate_together_embeddings(
  'Hello world',
  'togethercomputer/m2-bert-80M-2k-retrieval',
  os.environ['TOGETHER_API_KEY'])[:10]
)

📚 ドキュメント

FlashFFTConvに関する未使用パラメータについての大きなエラーメッセージが表示されることがあります。FlashFFTConvを使用してモデルをロードする場合は、GitHub をご覧ください。

📄 ライセンス

このモデルは、Apache-2.0ライセンスの下で公開されています。

謝辞

Alycia LeeがAutoModelのサポートに協力してくれました。

引用

このモデルを使用した場合、または私たちの研究が役に立った場合は、以下のように引用してください。

@inproceedings{fu2023monarch,
  title={Monarch Mixer: A Simple Sub-Quadratic GEMM-Based Architecture},
  author={Fu, Daniel Y and Arora, Simran and Grogan, Jessica and Johnson, Isys and Eyuboglu, Sabri and Thomas, Armin W and Spector, Benjamin and Poli, Michael and Rudra, Atri and R{\'e}, Christopher},
  booktitle={Advances in Neural Information Processing Systems},
  year={2023}
}