Ruri Small V2

🚀 Ruri：日語通用文本嵌入模型

Ruri 是一個用於日語通用文本嵌入的模型，能夠實現句子相似度計算和特徵提取等功能，在相關任務中表現出色。

🚀 快速開始

安裝依賴庫

首先，你需要安裝Sentence Transformers庫及其相關依賴：

pip install -U sentence-transformers fugashi sentencepiece unidic-lite

加載模型並進行推理

安裝完成後，你可以加載模型並進行推理：

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

# 從 🤗 Hub 下載模型
model = SentenceTransformer("cl-nagoya/ruri-small-v2", trust_remote_code=True)

# 別忘了在查詢文本前添加前綴 "クエリ: "，在段落文本前添加前綴 "文章: "
sentences = [
    "クエリ: 瑠璃色はどんな色？",
    "文章: 瑠璃色（るりいろ）は、紫みを帯びた濃い青。名は、半貴石の瑠璃（ラピスラズリ、英: lapis lazuli）による。JIS慣用色名では「こい紫みの青」（略號 dp-pB）と定義している[1][2]。",
    "クエリ: ワシやタカのように、鋭いくちばしと爪を持った大型の鳥類を総稱して「何類」というでしょう?",
    "文章: ワシ、タカ、ハゲワシ、ハヤブサ、コンドル、フクロウが代表的である。これらの猛禽類はリンネ前後の時代(17~18世紀)には鷲類・鷹類・隼類及び梟類に分類された。ちなみにリンネは狩りをする鳥を単一の目(もく)にまとめ、vultur(コンドル、ハゲワシ)、falco(ワシ、タカ、ハヤブサなど)、strix(フクロウ)、lanius(モズ)の4屬を含めている。",
]

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

similarities = F.cosine_similarity(embeddings.unsqueeze(0), embeddings.unsqueeze(1), dim=2)
print(similarities)

✨ 主要特性

• 多版本可選：目前有 v3 系列的多個模型可供選擇，不同模型在參數數量、最大長度和平均 JMTEB 得分等方面有所差異。
• 性能出色：在 JMTEB 基準測試中，Ruri 系列模型在多個任務上表現良好，如檢索、語義文本相似度、分類、重排序、聚類和成對分類等。

📦 安裝指南

安裝Sentence Transformers庫及其相關依賴：

pip install -U sentence-transformers fugashi sentencepiece unidic-lite

💻 使用示例

基礎用法

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

# 從 🤗 Hub 下載模型
model = SentenceTransformer("cl-nagoya/ruri-small-v2", trust_remote_code=True)

# 別忘了在查詢文本前添加前綴 "クエリ: "，在段落文本前添加前綴 "文章: "
sentences = [
    "クエリ: 瑠璃色はどんな色？",
    "文章: 瑠璃色（るりいろ）は、紫みを帯びた濃い青。名は、半貴石の瑠璃（ラピスラズリ、英: lapis lazuli）による。JIS慣用色名では「こい紫みの青」（略號 dp-pB）と定義している[1][2]。",
    "クエリ: ワシやタカのように、鋭いくちばしと爪を持った大型の鳥類を総稱して「何類」というでしょう?",
    "文章: ワシ、タカ、ハゲワシ、ハヤブサ、コンドル、フクロウが代表的である。これらの猛禽類はリンネ前後の時代(17~18世紀)には鷲類・鷹類・隼類及び梟類に分類された。ちなみにリンネは狩りをする鳥を単一の目(もく)にまとめ、vultur(コンドル、ハゲワシ)、falco(ワシ、タカ、ハヤブサなど)、strix(フクロウ)、lanius(モズ)の4屬を含めている。",
]

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

similarities = F.cosine_similarity(embeddings.unsqueeze(0), embeddings.unsqueeze(1), dim=2)
print(similarities)

📚 詳細文檔

基準測試

JMTEB

使用 JMTEB 進行評估，以下是部分模型的評估結果：

模型詳情

模型描述

完整模型架構

SentenceTransformer(
  (0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: BertModel 
  (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})
)

框架版本

• Python: 3.10.13
• Sentence Transformers: 3.0.0
• Transformers: 4.41.2
• PyTorch: 2.3.1+cu118
• Accelerate: 0.30.1
• Datasets: 2.19.1
• Tokenizers: 0.19.1

引用信息

@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}, 
}

🔧 技術細節

模型基於Sentence Transformer架構，使用BertModel進行特徵提取，並通過池化層將詞嵌入轉換為句子嵌入。具體的池化方式為平均池化，即對所有詞嵌入的平均值作為句子嵌入。

📄 許可證

該模型遵循 Apache 許可證 2.0 版 發佈。