Ruri V3 310m

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

Ruri v3 是一个基于 ModernBERT-Ja 构建的通用日语文本嵌入模型。它为日语文本嵌入任务提供了先进的技术解决方案，具有以下显著优势：

• 卓越性能：在日语文本嵌入任务中表现出色。
• 长序列支持：支持长达 8192 个标记的序列长度，而之前的 Ruri 版本（v1、v2）仅支持 512 个标记。
• 丰富词汇：拥有 100K 标记的扩展词汇表，相比 v1 和 v2 的 32K 有显著提升，使输入序列更短，提高了效率。
• 快速推理：集成了 FlashAttention，遵循 ModernBERT 架构，实现了更快的推理和微调。
• 高效分词：仅基于 SentencePiece 的分词器，无需外部分词工具，与之前依赖特定日语 BERT 分词器的版本不同。

🚀 快速开始

你可以使用 transformers 库（版本 4.48.0 或更高）直接使用我们的模型。

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

此外，如果你的 GPU 支持 Flash Attention 2，我们建议使用它来加速模型推理和微调。

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

然后，你可以加载模型并进行推理。

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

# 从 🤗 Hub 下载模型
device = "cuda" if torch.cuda.is_available() else "cpu"
model = SentenceTransformer("cl-nagoya/ruri-v3-310m", device=device)

# Ruri v3 采用 1+3 前缀方案来区分不同类型的文本输入：
# ""（空字符串）用于编码语义含义。
# "トピック: " 用于分类、聚类和编码主题信息。
# "検索クエリ: " 用于检索任务中的查询。
# "検索文書: " 用于待检索的文档。
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]]

✨ 主要特性

• 最先进的性能：在日语文本嵌入任务中表现卓越。
• 长序列支持：支持长达 8192 个标记的序列长度。
• 扩展词汇表：拥有 100K 标记的词汇表，提高了效率。
• 集成 FlashAttention：实现更快的推理和微调。
• 仅使用 SentencePiece 分词器：无需外部分词工具。

📦 安装指南

安装依赖库

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

安装 Flash Attention 2（可选）

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

💻 使用示例

基础用法

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

# 从 🤗 Hub 下载模型
device = "cuda" if torch.cuda.is_available() else "cpu"
model = SentenceTransformer("cl-nagoya/ruri-v3-310m", device=device)

# Ruri v3 采用 1+3 前缀方案来区分不同类型的文本输入：
# ""（空字符串）用于编码语义含义。
# "トピック: " 用于分类、聚类和编码主题信息。
# "検索クエリ: " 用于检索任务中的查询。
# "検索文書: " 用于待检索的文档。
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]]

📚 详细文档

模型系列

我们提供了不同大小的 Ruri-v3 模型。以下是每个模型的摘要：

基准测试

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})
)

🔧 技术细节

Ruri v3 基于 ModernBERT-Ja 构建，具有以下技术优势：

• 长序列支持：支持长达 8192 个标记的序列长度，相比之前的版本有显著提升。
• 扩展词汇表：拥有 100K 标记的词汇表，使输入序列更短，提高了效率。
• 集成 FlashAttention：遵循 ModernBERT 的架构，实现了更快的推理和微调。
• 仅使用 SentencePiece 分词器：无需外部分词工具，简化了输入处理流程。

📄 许可证

本模型根据 Apache 许可证 2.0 版 发布。

引用

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