Serafim 100m Portuguese Pt Sentence Encoder Ir

🚀 Serafim 100m Portuguese (PT) Sentence Encoder

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

🚀 クイックスタート

このモデルを使用するには、sentence-transformers をインストールする必要があります。

✨ 主な機能

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

📦 インストール

pip install -U sentence-transformers

💻 使用例

基本的な使用法

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

model = SentenceTransformer('PORTULAN/serafim-100m-portuguese-pt-sentence-encoder-ir')
embeddings = model.encode(sentences)
print(embeddings)

高度な使用法

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('PORTULAN/serafim-100m-portuguese-pt-sentence-encoder-ir')
model = AutoModel.from_pretrained('PORTULAN/serafim-100m-portuguese-pt-sentence-encoder-ir')

# 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': 128, '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, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
)

引用と著者

この論文はEPIA 2024会議で発表され、Springerによって出版されました。

@InProceedings{epia2024serafim,
    title={Open Sentence Embeddings for Portuguese with the Serafim PT* encoders family}, 
    author={Luís Gomes and António Branco and João Silva and João Rodrigues and Rodrigo Santos},
    editor={Manuel Filipe Santos and José Machado and Paulo Novais and Paulo Cortez and Pedro Miguel Moreira},
    booktitle={Progress in Artificial Intelligence},
    doi={doi.org/10.1007/978-3-031-73503-5_22},
    year={2024},
    publisher={Springer Nature Switzerland},
    address={Cham},
    pages={267--279},
    isbn={978-3-031-73503-5}
}

Springerによる出版前に、プレプリントはarXivで公開されていました。

@misc{gomes2024opensentenceembeddingsportuguese,
    title={Open Sentence Embeddings for Portuguese with the Serafim PT* encoders family}, 
    author={Luís Gomes and António Branco and João Silva and João Rodrigues and Rodrigo Santos},
    year={2024},
    eprint={2407.19527},
    archivePrefix={arXiv},
    primaryClass={cs.CL},
    url={https://arxiv.org/abs/2407.19527}, 
}

📄 ライセンス

このモデルはMITライセンスの下で公開されています。