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 を使用する場合

pip install -U 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)

高度な使用法

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

トレーニング

このモデルは以下のパラメータでトレーニングされました。

DataLoader:

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

Loss: 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})
)

引用と作者

詳細情報については、リンクされたリポジトリを参照してください。