🚀 juridics/bertimbau-base-portuguese-sts-scale
このモデルはsentence-transformersを使用したもので、文章や段落を768次元の密ベクトル空間にマッピングし、クラスタリングや意味検索などのタスクに利用できます。
🚀 クイックスタート
📦 インストール
sentence-transformersをインストールすると、このモデルを簡単に使用できます。
pip install -U sentence-transformers
💻 使用例
基本的な使用法
from sentence_transformers import SentenceTransformer
sentences = ["This is an example sentence", "Each sentence is converted"]
model = SentenceTransformer('juridics/bertimbau-base-portuguese-sts-scale')
embeddings = model.encode(sentences)
print(embeddings)
高度な使用法
sentence-transformersを使用せずにモデルを利用する場合、入力をTransformerモデルに通した後、文脈化された単語埋め込みに対して適切なプーリング操作を適用する必要があります。
from transformers import AutoTokenizer, AutoModel
import torch
def mean_pooling(model_output, attention_mask):
token_embeddings = model_output[0]
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 = ['This is an example sentence', 'Each sentence is converted']
tokenizer = AutoTokenizer.from_pretrained('juridics/bertimbau-base-portuguese-sts-scale')
model = AutoModel.from_pretrained('juridics/bertimbau-base-portuguese-sts-scale')
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
with torch.no_grad():
model_output = model(**encoded_input)
sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])
print("Sentence embeddings:")
print(sentence_embeddings)
📚 ドキュメント
評価結果
このモデルの自動評価については、Sentence Embeddings Benchmarkを参照してください。https://seb.sbert.net
学習
このモデルは以下のパラメータで学習されました。
DataLoader:
torch.utils.data.dataloader.DataLoader
の長さは2492で、以下のパラメータが設定されています。
{'batch_size': 8, 'sampler': 'torch.utils.data.sampler.RandomSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}
Loss:
sentence_transformers.losses.CosineSimilarityLoss.CosineSimilarityLoss
fit()メソッドのパラメータ:
{
"epochs": 3,
"evaluation_steps": 2492,
"evaluator": "sentence_transformers.evaluation.EmbeddingSimilarityEvaluator.EmbeddingSimilarityEvaluator",
"max_grad_norm": 1,
"optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
"optimizer_params": {
"lr": 5e-05
},
"scheduler": "WarmupLinear",
"steps_per_epoch": null,
"warmup_steps": 748,
"weight_decay": 0.01
}
完全なモデルアーキテクチャ
SentenceTransformer(
(0): Transformer({'max_seq_length': 384, 'do_lower_case': False}) with Transformer model: BertModel
(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})
)
引用と著者
このモデルを使用する場合は、以下の文献を引用してください。
@incollection{Viegas_2023,
doi = {10.1007/978-3-031-36805-9_24},
url = {https://doi.org/10.1007%2F978-3-031-36805-9_24},
year = 2023,
publisher = {Springer Nature Switzerland},
pages = {349--365},
author = {Charles F. O. Viegas and Bruno C. Costa and Renato P. Ishii},
title = {{JurisBERT}: A New Approach that~Converts a~Classification Corpus into~an~{STS} One},
booktitle = {Computational Science and Its Applications {\textendash} {ICCSA} 2023}
}