Refpydst 1p Referredstates Split V3

🚀 Brendan/refpydst-1p-referredstates-split-v3

本模型以sentence-transformers/all-mpnet-base-v2为基础进行初始化，随后使用MultiWOZ数据集1%的小样本分割数据和监督对比损失进行微调。该模型经过微调后，可作为上下文示例检索器使用，小样本训练集可在链接仓库中获取。更多详细信息可查看仓库及其中引用的论文。若要引用此模型，请参考链接的GitHub仓库README中的引用信息。

本README的其余部分由sentence_transformers自动生成，内容准确无误。不过，此模型并非通用的句子编码器：它期望来自MultiWOZ的上下文示例以特定方式进行格式化，具体细节请查看链接的仓库。

这是一个sentence-transformers模型：它可将句子和段落映射到768维的密集向量空间，可用于聚类或语义搜索等任务。

🚀 快速开始

本模型可用于句子相似度计算等任务，通过将句子映射到向量空间，方便进行语义分析。

✨ 主要特性

• 基于sentence-transformers/all-mpnet-base-v2初始化，经过MultiWOZ数据集微调。
• 可作为上下文示例检索器，适用于特定格式的MultiWOZ上下文示例。
• 能将句子和段落映射到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('Brendan/refpydst-1p-referredstates-split-v3')
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('Brendan/refpydst-1p-referredstates-split-v3')
model = AutoModel.from_pretrained('Brendan/refpydst-1p-referredstates-split-v3')

# 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，长度为483，参数如下：

{'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": 200,
    "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中的引用信息。更多信息可查看链接仓库及其中引用的论文。