Lyrics Bert

🚀 {lyrics-bert}

このモデルはsentence-transformersモデルです。文章や段落を300次元の密ベクトル空間にマッピングし、クラスタリングや意味検索などのタスクに使用できます。

このモデルは、Pythonのlangdetectパッケージで英語と分類された約480,000の歌詞を使って学習されました。コントラスト学習と複数の負例ランキング損失を使用してゼロから学習されました。ベースモデルはbert-base-uncasedモデルです。損失関数が$1.16 * 10^{-4}$で停滞した後、17エポック学習されました。

🚀 クイックスタート

このモデルの使用方法を説明します。

✨ 主な機能

• 文章や段落を300次元の密ベクトル空間にマッピングします。
• クラスタリングや意味検索などのタスクに使用できます。

📦 インストール

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

pip install -U sentence-transformers

💻 使用例

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

from sentence_transformers import SentenceTransformer
sentences = ["This is an example sentence", "Each sentence is converted"]

model = SentenceTransformer('brunokreiner/lyrics-bert')
embeddings = model.encode(sentences)
print(embeddings)

高度な使用法 (HuggingFace Transformers)

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
sentences = ['This is an example sentence', 'Each sentence is converted']

# Load model from HuggingFace Hub
tokenizer = AutoTokenizer.from_pretrained('{MODEL_NAME}')
model = AutoModel.from_pretrained('{MODEL_NAME}')

# 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, mean pooling.
sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])

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

📚 ドキュメント

評価結果

このモデルの自動評価については、Sentence Embeddings Benchmarkを参照してください: https://seb.sbert.net

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

SentenceTransformer(
  (0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: BertModel 
  (1): Pooling({'word_embedding_dimension': 300, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False})
)

引用と作者

このモデルに関する詳細情報は、README内の記載を参照してください。