🚀 瑠璃（Ruri）：日语通用文本嵌入模型

瑠璃（Ruri）v3 是一个基于 ModernBERT-Ja 构建的通用日语文本嵌入模型。它能够将日语文本转换为向量表示，在语义搜索、文本分类、聚类等自然语言处理任务中发挥重要作用。

🚀 快速开始

你可以使用 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-130m", 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, 512]

similarities = F.cosine_similarity(embeddings.unsqueeze(0), embeddings.unsqueeze(1), dim=2)
print(similarities)
# [[1.0000, 0.9564, 0.8183, 0.7000, 0.7108],
#  [0.9564, 1.0000, 0.8112, 0.6994, 0.7117],
#  [0.8183, 0.8112, 1.0000, 0.8788, 0.8514],
#  [0.7000, 0.6994, 0.8788, 1.0000, 0.9448],
#  [0.7108, 0.7117, 0.8514, 0.9448, 1.0000]]

✨ 主要特性

瑠璃（Ruri）v3 在日语文本嵌入任务中具有多个关键技术优势：

• 最先进的性能：在日语文本嵌入任务中表现出色。
• 支持长达 8192 个标记的序列长度：相比之下，之前版本的瑠璃（v1、v2）仅限于 512 个标记。
• 扩展到 100K 标记的词汇表：而 v1 和 v2 只有 32K。更大的词汇表使输入序列更短，提高了效率。
• 集成 FlashAttention：遵循 ModernBERT 的架构，实现了更快的推理和微调。
• 仅基于 SentencePiece 的分词器：与之前依赖特定于日语的 BERT 分词器且需要预分词输入的版本不同，瑠璃（Ruri）v3 仅使用 SentencePiece 进行分词，无需外部分词工具。

📦 安装指南

你可以使用 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-130m", 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, 512]

similarities = F.cosine_similarity(embeddings.unsqueeze(0), embeddings.unsqueeze(1), dim=2)
print(similarities)
# [[1.0000, 0.9564, 0.8183, 0.7000, 0.7108],
#  [0.9564, 1.0000, 0.8112, 0.6994, 0.7117],
#  [0.8183, 0.8112, 1.0000, 0.8788, 0.8514],
#  [0.7000, 0.6994, 0.8788, 1.0000, 0.9448],
#  [0.7108, 0.7117, 0.8514, 0.9448, 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': 512, '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 以及仅基于 SentencePiece 的分词器。这些技术改进使得瑠璃（Ruri）v3 在性能和效率上都有显著提升。

📄 许可证

本模型根据 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}, 
}