Ruri V3 310m

🚀 瑠璃 (Ruri): 日本語汎用テキスト埋め込みモデル

瑠璃 (Ruri) v3 は、ModernBERT-Ja をベースに構築された汎用的な日本語テキスト埋め込みモデルです。瑠璃 v3 はいくつかの重要な技術的な利点を提供します。

• 日本語テキスト埋め込みタスクにおける最先端の性能。
• 最大8192トークンのシーケンス長をサポート
  • 以前のバージョン（v1、v2）は512トークンまでに制限されていました。
• 10万トークンの拡張語彙。v1とv2の3.2万トークンに比べて増加。
  • より大きな語彙により入力シーケンスが短くなり、効率が向上します。
• ModernBERTのアーキテクチャに基づくFlashAttentionの統合
  • 高速な推論と微調整を可能にします。
• SentencePieceのみに基づくトークナイザ
  • 以前のバージョンは日本語固有のBERTトークナイザに依存し、事前にトークン化された入力が必要でしたが、瑠璃 v3 はSentencePieceのみでトークン化を行い、外部の単語分割ツールは必要ありません。

✨ 主な機能

モデルシリーズ

我々は瑠璃 v3 をいくつかのモデルサイズで提供しています。以下は各モデルの概要です。

📦 インストール

このモデルを使用するには、transformers ライブラリ v4.48.0 以上が必要です。以下のコマンドでインストールできます。

pip install -U "transformers>=4.48.0" sentence-transformers

また、GPUがFlash Attention 2をサポートしている場合は、Flash Attention 2 を使用することをお勧めします。

pip install flash-attn --no-build-isolation

💻 使用例

基本的な使用法

import torch
import torch.nn.functional as F
from sentence_transformers import SentenceTransformer

# Download from the 🤗 Hub
device = "cuda" if torch.cuda.is_available() else "cpu"
model = SentenceTransformer("cl-nagoya/ruri-v3-310m", device=device)

# Ruri v3 employs a 1+3 prefix scheme to distinguish between different types of text inputs:
# "" (empty string) is used for encoding semantic meaning.
# "トピック: " is used for classification, clustering, and encoding topical information.
# "検索クエリ: " is used for queries in retrieval tasks.
# "検索文書: " is used for documents to be retrieved.
sentences = [
    "川べりでサーフボードを持った人たちがいます",
    "サーファーたちが川べりに立っています",
    "トピック: 瑠璃色のサーファー",
    "検索クエリ: 瑠璃色はどんな色？",
    "検索文書: 瑠璃色（るりいろ）は、紫みを帯びた濃い青。名は、半貴石の瑠璃（ラピスラズリ、英: lapis lazuli）による。JIS慣用色名では「こい紫みの青」（略号 dp-pB）と定義している[1][2]。",
]

embeddings = model.encode(sentences, convert_to_tensor=True)
print(embeddings.size())
# [5, 768]

similarities = F.cosine_similarity(embeddings.unsqueeze(0), embeddings.unsqueeze(1), dim=2)
print(similarities)
# [[1.0000, 0.9603, 0.8157, 0.7074, 0.6916],
#  [0.9603, 1.0000, 0.8192, 0.7014, 0.6819],
#  [0.8157, 0.8192, 1.0000, 0.8701, 0.8470],
#  [0.7074, 0.7014, 0.8701, 1.0000, 0.9746],
#  [0.6916, 0.6819, 0.8470, 0.9746, 1.0000]]

📚 ドキュメント

ベンチマーク

JMTEB

JMTEB を使用して評価されました。

モデル詳細

モデルの説明

完全なモデルアーキテクチャ

SentenceTransformer(
  (0): Transformer({'max_seq_length': 8192, 'do_lower_case': False}) with Transformer model: ModernBertModel 
  (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
)

引用

@misc{
  Ruri,
  title={{Ruri: Japanese General Text Embeddings}}, 
  author={Hayato Tsukagoshi and Ryohei Sasano},
  year={2024},
  eprint={2409.07737},
  archivePrefix={arXiv},
  primaryClass={cs.CL},
  url={https://arxiv.org/abs/2409.07737}, 
}

📄 ライセンス

このモデルは Apache License, Version 2.0 の下で公開されています。