Serafim 100m Portuguese Pt Sentence Encoder

🚀 塞拉菲姆100m葡萄牙语（PT）句子编码器

塞拉菲姆100m葡萄牙语（PT）句子编码器是一个基于 sentence-transformers 的模型，它可以将句子和段落映射到一个768维的密集向量空间，可用于聚类或语义搜索等任务。

🚀 快速开始

📦 安装指南

若要使用此模型，你需要安装 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('PORTULAN/serafim-100m-portuguese-pt-sentence-encoder')
embeddings = model.encode(sentences)
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
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')
model = AutoModel.from_pretrained('PORTULAN/serafim-100m-portuguese-pt-sentence-encoder')

# 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

训练详情

该模型的训练参数如下：

数据加载器

torch.utils.data.dataloader.DataLoader，长度为296，参数如下：

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

损失函数

sentence_transformers.losses.CoSENTLoss.CoSENTLoss，参数如下：

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

训练方法参数

{
    "epochs": 20,
    "evaluation_steps": 30,
    "evaluator": "sentence_transformers.evaluation.EmbeddingSimilarityEvaluator.EmbeddingSimilarityEvaluator",
    "max_grad_norm": 1,
    "optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
    "optimizer_params": {
        "lr": 1e-05
    },
    "scheduler": "WarmupLinear",
    "steps_per_epoch": 296,
    "warmup_steps": 592,
    "weight_decay": 0.01
}

完整模型架构

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许可证。