Keyphrase Mpnet V1

🚀 keyphrase-mpnet-v1

このモデルは、フレーズに特化したsentence-transformersモデルです。フレーズを768次元の密ベクトル空間にマッピングし、クラスタリングや意味検索などのタスクに使用できます。元の論文では、このモデルはキーフレーズモデルの意味ベースの評価指標を計算するために使用されています。

このモデルは、sentence-transformers/all-mpnet-base-v2をベースに、100万件のキーフレーズデータでSimCSEを用いてさらに微調整されています。

🚀 クイックスタート

このセクションでは、このモデルの基本的な使い方を説明します。

✨ 主な機能

• フレーズを768次元の密ベクトル空間にマッピングする。
• クラスタリングや意味検索などのタスクに使用可能。
• キーフレーズモデルの意味ベースの評価指標の計算に利用できる。

📦 インストール

sentence-transformersをインストールすることで、このモデルを簡単に使用できます。

pip install -U sentence-transformers

💻 使用例

基本的な使用法

from sentence_transformers import SentenceTransformer
phrases = ["information retrieval", "text mining", "natural language processing"]

model = SentenceTransformer('uclanlp/keyphrase-mpnet-v1')
embeddings = model.encode(phrases)
print(embeddings)

高度な使用法

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

from transformers import AutoTokenizer, AutoModel
import torch


#Mean Pooling - Take attention mask into account for correct averaging
def mean_pooling(model_output, attention_mask):
    token_embeddings = model_output[0] #First element of model_output contains all token embeddings
    input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
    return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9)


# Sentences we want sentence embeddings for
phrases = ["information retrieval", "text mining", "natural language processing"]

# Load model from HuggingFace Hub
tokenizer = AutoTokenizer.from_pretrained('uclanlp/keyphrase-mpnet-v1')
model = AutoModel.from_pretrained('uclanlp/keyphrase-mpnet-v1')

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

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

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

print("Phrase embeddings:")
print(sentence_embeddings)

📚 ドキュメント

引用と著者

論文: KPEval: Towards Fine-grained Semantic-based Keyphrase Evaluation

@inproceedings{wu-etal-2024-kpeval,
    title = "{KPE}val: Towards Fine-Grained Semantic-Based Keyphrase Evaluation",
    author = "Wu, Di  and
      Yin, Da  and
      Chang, Kai-Wei",
    editor = "Ku, Lun-Wei  and
      Martins, Andre  and
      Srikumar, Vivek",
    booktitle = "Findings of the Association for Computational Linguistics ACL 2024",
    month = aug,
    year = "2024",
    address = "Bangkok, Thailand and virtual meeting",
    publisher = "Association for Computational Linguistics",
    url = "https://aclanthology.org/2024.findings-acl.117",
    pages = "1959--1981",
}

トレーニング

このモデルは、幅広いドメインをカバーする4つのキーフレーズデータセットのフレーズを使用してトレーニングされています。

このモデルは以下のパラメータでトレーニングされています。

DataLoader: torch.utils.data.dataloader.DataLoader の長さは2025で、以下のパラメータが使用されています。

{'batch_size': 512, 'sampler': 'torch.utils.data.sampler.RandomSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}

Loss: sentence_transformers.losses.MultipleNegativesRankingLoss.MultipleNegativesRankingLoss が使用され、以下のパラメータが設定されています。

{'scale': 20.0, 'similarity_fct': 'cos_sim'}

fit() メソッドのパラメータ:

{
    "epochs": 1,
    "evaluation_steps": 0,
    "evaluator": "NoneType",
    "max_grad_norm": 1,
    "optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
    "optimizer_params": {
        "lr": 1e-06
    },
    "scheduler": "WarmupLinear",
    "steps_per_epoch": null,
    "warmup_steps": 203,
    "weight_decay": 0.01
}

完全なモデルアーキテクチャ

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