Unsup Simcse Ja Base

🚀 unsup-simcse-ja-base

このモデルは、文の埋め込みを生成し、文の類似度を計算するために使用できます。特に、日本語の文に対して効果的に動作します。

🚀 クイックスタート

📦 インストール

sentence-transformers をインストールすると、このモデルの使用が簡単になります。以下のコマンドを実行してください。

pip install -U fugashi[unidic-lite] sentence-transformers

💻 使用例

基本的な使用法 (Sentence-Transformers)

from sentence_transformers import SentenceTransformer
sentences = ["こんにちは、世界！", "文埋め込み最高！文埋め込み最高と叫びなさい", "極度乾燥しなさい"]

model = SentenceTransformer("cl-nagoya/unsup-simcse-ja-base")
embeddings = model.encode(sentences)
print(embeddings)

高度な使用法 (HuggingFace Transformers)

sentence-transformers を使用せずに、このモデルを使用することもできます。まず、入力をトランスフォーマーモデルに通し、次に文脈化された単語埋め込みの上に適切なプーリング操作を適用する必要があります。

from transformers import AutoTokenizer, AutoModel
import torch


def cls_pooling(model_output, attention_mask):
    return model_output[0][:,0]


# Sentences we want sentence embeddings for
sentences = ['This is an example sentence', 'Each sentence is converted']

# Load model from HuggingFace Hub
tokenizer = AutoTokenizer.from_pretrained("cl-nagoya/unsup-simcse-ja-base")
model = AutoModel.from_pretrained("cl-nagoya/unsup-simcse-ja-base")

# Tokenize sentences
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')

# Compute token embeddings
with torch.no_grad():
    model_output = model(**encoded_input)

# Perform pooling. In this case, cls pooling.
sentence_embeddings = cls_pooling(model_output, encoded_input['attention_mask'])

print("Sentence embeddings:")
print(sentence_embeddings)

📚 ドキュメント

🔧 技術詳細

モデルアーキテクチャ

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': True, 'pooling_mode_mean_tokens': False, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False})
)

モデル概要

詳細な実験設定については、GitHubリポジトリ を参照してください。

📄 ライセンス

このモデルは、CC BY-SA 4.0ライセンスの下で提供されています。

📖 引用と著者

@misc{
  hayato-tsukagoshi-2023-simple-simcse-ja,
  author = {Hayato Tsukagoshi},
  title = {Japanese Simple-SimCSE},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/hppRC/simple-simcse-ja}}
}