🚀 {MODEL_NAME}
这是一个句子转换器模型:它可以将句子和段落映射到一个768维的密集向量空间,可用于聚类或语义搜索等任务。
🚀 快速开始
本模型可通过两种方式使用,分别是使用sentence-transformers
库和使用HuggingFace Transformers
库,下面为你详细介绍。
📦 安装指南
若要使用sentence-transformers
库调用本模型,你需要先安装该库:
pip install -U sentence-transformers
💻 使用示例
基础用法(Sentence-Transformers)
安装好sentence-transformers
库后,你可以按照以下方式使用本模型:
from sentence_transformers import SentenceTransformer
sentences = ["This is an example sentence", "Each sentence is converted"]
model = SentenceTransformer('{MODEL_NAME}')
embeddings = model.encode(sentences)
print(embeddings)
高级用法(HuggingFace Transformers)
若你未安装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('{MODEL_NAME}')
model = AutoModel.from_pretrained('{MODEL_NAME}')
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)
📚 详细文档
评估结果
若要对本模型进行自动评估,请参考句子嵌入基准测试:https://seb.sbert.net
训练信息
本模型使用以下参数进行训练:
数据加载器
__main__.PubmedLowMemoryLoader
,长度为26041,参数如下:
{'batch_size': 128}
损失函数
sentence_transformers.losses.MultipleNegativesRankingLoss.MultipleNegativesRankingLoss
,参数如下:
{'scale': 20.0, 'similarity_fct': 'cos_sim'}
fit()方法的参数
{
"epochs": 1,
"evaluation_steps": 2000,
"evaluator": "__main__.PubmedTruePositiveIRetrievalEvaluator",
"max_grad_norm": 1,
"optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
"optimizer_params": {
"lr": 2e-05
},
"scheduler": "WarmupLinear",
"steps_per_epoch": null,
"warmup_steps": 21,
"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})
)
引用与作者