Declutr Base

🚀 DeCLUTR-base

「DeCLUTR-base」モデルは、文の類似度を測定するためのモデルで、文の特徴抽出や文の類似性分析に役立ちます。

🚀 クイックスタート

このモデルは、GoogleのUniversal Sentence Encoder や Sentence Transformers のように、普遍的な文エンコーダとして使用することを目的としています。

✨ 主な機能

• 文の特徴抽出を行い、文のベクトル表現を生成します。
• 文同士の類似度を計算することができます。

📦 インストール

インストールに関する具体的な手順は、公式リポジトリ を参照してください。

💻 使用例

基本的な使用法

SentenceTransformers を使用する場合

from scipy.spatial.distance import cosine
from sentence_transformers import SentenceTransformer

# モデルをロードする
model = SentenceTransformer("johngiorgi/declutr-base")

# 埋め込むテキストを準備する
texts = [
    "A smiling costumed woman is holding an umbrella.",
    "A happy woman in a fairy costume holds an umbrella.",
]

# テキストを埋め込む
embeddings = model.encode(texts)

# コサイン距離を用いて意味的な類似度を計算する
semantic_sim = 1 - cosine(embeddings[0], embeddings[1])

🤗 Transformers を使用する場合

import torch
from scipy.spatial.distance import cosine
from transformers import AutoModel, AutoTokenizer

# モデルをロードする
tokenizer = AutoTokenizer.from_pretrained("johngiorgi/declutr-base")
model = AutoModel.from_pretrained("johngiorgi/declutr-base")

# 埋め込むテキストを準備する
text = [
    "A smiling costumed woman is holding an umbrella.",
    "A happy woman in a fairy costume holds an umbrella.",
]
inputs = tokenizer(text, padding=True, truncation=True, return_tensors="pt")

# テキストを埋め込む
with torch.no_grad():
    sequence_output = model(**inputs)[0]

# トークンレベルの埋め込みを平均プーリングして文レベルの埋め込みを取得する
embeddings = torch.sum(
    sequence_output * inputs["attention_mask"].unsqueeze(-1), dim=1
) / torch.clamp(torch.sum(inputs["attention_mask"], dim=1, keepdims=True), min=1e-9)

# コサイン距離を用いて意味的な類似度を計算する
semantic_sim = 1 - cosine(embeddings[0], embeddings[1])

📚 ドキュメント

モデルの説明

「DeCLUTR-base」モデルは、論文 DeCLUTR: Deep Contrastive Learning for Unsupervised Textual Representations で提案されたモデルです。

BibTeXエントリと引用情報

@inproceedings{giorgi-etal-2021-declutr,
    title        = {{D}e{CLUTR}: Deep Contrastive Learning for Unsupervised Textual Representations},
    author       = {Giorgi, John  and Nitski, Osvald  and Wang, Bo  and Bader, Gary},
    year         = 2021,
    month        = aug,
    booktitle    = {Proceedings of the 59th Annual Meeting of the Association for Computational Linguistics and the 11th International Joint Conference on Natural Language Processing (Volume 1: Long Papers)},
    publisher    = {Association for Computational Linguistics},
    address      = {Online},
    pages        = {879--895},
    doi          = {10.18653/v1/2021.acl-long.72},
    url          = {https://aclanthology.org/2021.acl-long.72}
}

📄 ライセンス

このモデルは、Apache 2.0ライセンスの下で提供されています。