Refpydst 5p Referredstates Split V1

🚀 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


#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-5p-referredstates-split-v1')
model = AutoModel.from_pretrained('Brendan/refpydst-5p-referredstates-split-v1')

# 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，長度為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中的引用信息。