🚀 Brendan/refpydst-5p-referredstates-split-v1
本模型基于sentence-transformers/all-mpnet-base-v2
进行初始化,随后使用MultiWOZ数据集5%的小样本分割数据和监督对比损失进行微调。该模型经过微调后,可作为上下文示例检索器使用,小样本训练集已在关联仓库中提供。更多详细信息可查看仓库和其中引用的论文。若要引用此模型,请参考关联GitHub仓库README中的引用信息。
本README的其余部分由sentence_transformers
自动生成,内容准确,但该模型并非通用的句子编码器:它期望来自MultiWOZ的上下文示例以特定方式格式化,具体细节请查看关联仓库。
这是一个sentence-transformers模型:它能将句子和段落映射到768维的密集向量空间,可用于聚类或语义搜索等任务。
🚀 快速开始
本模型基于sentence-transformers/all-mpnet-base-v2
初始化,并使用MultiWOZ数据集的小样本进行微调,可用于上下文示例检索。下面将介绍不同环境下的使用方法。
✨ 主要特性
- 基于
sentence-transformers/all-mpnet-base-v2
初始化。
- 使用MultiWOZ数据集5%的小样本分割数据和监督对比损失进行微调。
- 可作为上下文示例检索器使用。
- 能将句子和段落映射到768维的密集向量空间,适用于聚类或语义搜索等任务。
📦 安装指南
若要使用此模型,需安装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('Brendan/refpydst-5p-referredstates-split-v1')
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('Brendan/refpydst-5p-referredstates-split-v1')
model = AutoModel.from_pretrained('Brendan/refpydst-5p-referredstates-split-v1')
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
训练
该模型的训练参数如下:
数据加载器:
torch.utils.data.dataloader.DataLoader
,长度为2276,参数如下:
{'batch_size': 24, 'sampler': 'torch.utils.data.sampler.RandomSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}
损失函数:
sentence_transformers.losses.OnlineContrastiveLoss.OnlineContrastiveLoss
fit()
方法的参数:
{
"epochs": 15,
"evaluation_steps": 800,
"evaluator": "refpydst.retriever.code.st_evaluator.RetrievalEvaluator",
"max_grad_norm": 1,
"optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
"optimizer_params": {
"lr": 2e-05
},
"scheduler": "WarmupLinear",
"steps_per_epoch": null,
"warmup_steps": 100,
"weight_decay": 0.01
}
完整模型架构
SentenceTransformer(
(0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: MPNetModel
(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})
)
引用与作者
若要引用此模型,请参考关联GitHub仓库README中的引用信息。