训练概述

为什么要微调？

微调句子 Transformer 模型通常可以大幅提高模型在您的用例中的性能，因为每个任务都需要不同的相似度概念。例如，给定新闻文章

“苹果发布新款 iPad”
“NVIDIA 正在为下一代 GPU 做准备”

那么对于以下用例，我们可能有不同的相似度概念

用于将新闻文章分类为经济、体育、科技、政治等类别的模型，应为这些文本生成相似的嵌入。
用于语义文本相似度的模型应为这些文本生成不相似的嵌入，因为它们具有不同的含义。
用于语义搜索的模型不需要两个文档之间的相似度概念，因为它只需要比较查询和文档。

另请参阅 训练示例，其中包含大量适用于常见实际应用的训练脚本，您可以采纳这些脚本。

训练组件

训练句子 Transformer 模型通常涉及 3 到 5 个组件

了解如何准备用于训练的数据。了解如何准备和选择损失函数。了解哪些 训练参数 有用。了解如何在训练期间和之后进行评估。了解如何启动训练过程。

数据集

SentenceTransformerTrainer 使用 datasets.Dataset（一个数据集）或 datasets.DatasetDict 实例（多个数据集，另请参阅多数据集训练）进行训练和评估。

🤗 Hugging Face Hub 上的数据

如果您想从 Hugging Face Datasets 加载数据，则应使用 datasets.load_dataset()

from datasets import load_dataset

train_dataset = load_dataset("sentence-transformers/all-nli", "pair-class", split="train")
eval_dataset = load_dataset("sentence-transformers/all-nli", "pair-class", split="dev")

print(train_dataset)
"""
Dataset({
    features: ['premise', 'hypothesis', 'label'],
    num_rows: 942069
})
"""

某些数据集（包括 sentence-transformers/all-nli）要求您在数据集名称旁边提供“子集”。sentence-transformers/all-nli 有 4 个子集，每个子集具有不同的数据格式：pair、pair-class、pair-score、triplet。

注意

许多与 Sentence Transformers 开箱即用的 Hugging Face 数据集都已标记为 sentence-transformers，使您可以轻松地浏览 https://hugging-face.cn/datasets?other=sentence-transformers 来找到它们。我们强烈建议您浏览这些数据集，以查找可能对您的任务有用的训练数据集。

本地数据（CSV、JSON、Parquet、Arrow、SQL）

如果您有常见文件格式的本地数据，则可以使用 datasets.load_dataset() 轻松加载此数据

from datasets import load_dataset

dataset = load_dataset("csv", data_files="my_file.csv")

或

from datasets import load_dataset

dataset = load_dataset("json", data_files="my_file.json")

需要预处理的本地数据

如果您有需要一些额外预处理的本地数据，我建议您使用 datasets.Dataset.from_dict() 和列表字典来初始化数据集，如下所示

from datasets import Dataset

anchors = []
positives = []
# Open a file, do preprocessing, filtering, cleaning, etc.
# and append to the lists

dataset = Dataset.from_dict({
    "anchor": anchors,
    "positive": positives,
})

字典中的每个键都将成为结果数据集中的一列。

数据集格式

重要的是，您的数据集格式与您的损失函数相匹配（或者您选择与您的数据集格式相匹配的损失函数）。验证数据集格式是否适用于损失函数涉及两个步骤

如果您的损失函数根据损失概述表需要标签，则您的数据集必须具有名为“label”或“score”的列。此列将自动作为标签。
根据损失概述表，所有未命名为“label”或“score”的列都被视为输入。剩余列的数量必须与您选择的损失的有效输入数量相匹配。这些列的名称无关紧要，只有顺序很重要。

例如，给定一个具有列 ["text1", "text2", "label"] 的数据集，其中“label”列具有介于 0 和 1 之间的浮点相似度分数，我们可以将其与 CoSENTLoss、AnglELoss 和 CosineSimilarityLoss 一起使用，因为它

具有“label”列，这是这些损失函数所要求的。
具有 2 个非标签列，正好是这些损失函数所需的数量。

如果您的列未正确排序，请务必使用 Dataset.select_columns 重新排序数据集列。例如，如果您的数据集具有 ["good_answer", "bad_answer", "question"] 列，那么从技术上讲，此数据集可以与需要（锚点、正例、负例）三元组的损失一起使用，但 good_answer 列将被视为锚点，bad_answer 将被视为正例，而 question 将被视为负例。

此外，如果您的数据集具有无关的列（例如 sample_id、metadata、source、type），则应使用 Dataset.remove_columns 删除这些列，否则它们将被用作输入。您也可以使用 Dataset.select_columns 仅保留所需的列。

损失函数

损失函数量化了模型在给定批量数据下的表现，从而允许优化器更新模型权重，以产生更有利（即更低）的损失值。这是训练过程的核心。

遗憾的是，没有适用于所有用例的最佳损失函数。相反，使用哪种损失函数在很大程度上取决于您的可用数据和目标任务。请参阅数据集格式，了解哪些数据集对哪些损失函数有效。此外，损失概述将是您了解选项的最佳帮手。

大多数损失函数可以使用您正在训练的 SentenceTransformer 以及一些可选参数进行初始化，例如

from datasets import load_dataset
from sentence_transformers import SentenceTransformer
from sentence_transformers.losses import CoSENTLoss

# Load a model to train/finetune
model = SentenceTransformer("xlm-roberta-base")

# Initialize the CoSENTLoss
# This loss requires pairs of text and a float similarity score as a label
loss = CoSENTLoss(model)

# Load an example training dataset that works with our loss function:
train_dataset = load_dataset("sentence-transformers/all-nli", "pair-score", split="train")
"""
Dataset({
    features: ['sentence1', 'sentence2', 'label'],
    num_rows: 942069
})
"""

训练参数

SentenceTransformerTrainingArguments 类可用于指定影响训练性能以及定义跟踪/调试参数的参数。虽然它是可选的，但强烈建议尝试各种有用的参数。

learning_rate lr_scheduler_type warmup_ratio num_train_epochs max_steps per_device_train_batch_size per_device_eval_batch_size auto_find_batch_size fp16 bf16 load_best_model_at_end metric_for_best_model gradient_accumulation_steps gradient_checkpointing eval_accumulation_steps optim batch_sampler multi_dataset_batch_sampler prompts

eval_strategy eval_steps save_strategy save_steps save_total_limit report_to run_name log_level logging_steps push_to_hub hub_model_id hub_strategy hub_private_repo

以下是如何初始化 SentenceTransformerTrainingArguments 的示例

args = SentenceTransformerTrainingArguments(
    # Required parameter:
    output_dir="models/mpnet-base-all-nli-triplet",
    # Optional training parameters:
    num_train_epochs=1,
    per_device_train_batch_size=16,
    per_device_eval_batch_size=16,
    learning_rate=2e-5,
    warmup_ratio=0.1,
    fp16=True,  # Set to False if you get an error that your GPU can't run on FP16
    bf16=False,  # Set to True if you have a GPU that supports BF16
    batch_sampler=BatchSamplers.NO_DUPLICATES,  # losses that use "in-batch negatives" benefit from no duplicates
    # Optional tracking/debugging parameters:
    eval_strategy="steps",
    eval_steps=100,
    save_strategy="steps",
    save_steps=100,
    save_total_limit=2,
    logging_steps=100,
    run_name="mpnet-base-all-nli-triplet",  # Will be used in W&B if `wandb` is installed
)

评估器

您可以为 SentenceTransformerTrainer 提供 eval_dataset 以在训练期间获得评估损失，但获取训练期间更具体的指标也可能很有用。为此，您可以使用评估器在训练之前、期间或之后评估模型的性能以及有用的指标。您可以同时使用 eval_dataset 和评估器，两者之一，或者两者都不使用。它们基于训练参数的 eval_strategy 和 eval_steps 进行评估。

以下是 Sentence Transformers 附带的已实现的评估器

评估器	所需数据
`BinaryClassificationEvaluator`	带有类标签的对。
`EmbeddingSimilarityEvaluator`	带有相似度分数的对。
`InformationRetrievalEvaluator`	查询（qid => 问题）、语料库（cid => 文档）和相关文档（qid => set[cid]）。
`NanoBEIREvaluator`	无需数据。
`MSEEvaluator`	要使用教师模型嵌入的源句子和要使用学生模型嵌入的目标句子。可以是相同的文本。
`ParaphraseMiningEvaluator`	ID 到句子的映射 & 具有重复句子 ID 的对。
`RerankingEvaluator`	`{'query': '...', 'positive': [...], 'negative': [...]}` 字典列表。
`TranslationEvaluator`	两种不同语言的句子对。
`TripletEvaluator`	（锚点、正例、负例）对。

此外，SequentialEvaluator 应用于将多个评估器组合为一个可以传递给 SentenceTransformerTrainer 的评估器。

有时您没有所需的评估数据来准备这些评估器之一，但您仍然想跟踪模型在某些常见基准上的表现。在这种情况下，您可以将这些评估器与来自 Hugging Face 的数据一起使用。

带有 STSb 的 EmbeddingSimilarityEvaluator

from datasets import load_dataset
from sentence_transformers.evaluation import EmbeddingSimilarityEvaluator, SimilarityFunction

# Load the STSB dataset (https://hugging-face.cn/datasets/sentence-transformers/stsb)
eval_dataset = load_dataset("sentence-transformers/stsb", split="validation")

# Initialize the evaluator
dev_evaluator = EmbeddingSimilarityEvaluator(
    sentences1=eval_dataset["sentence1"],
    sentences2=eval_dataset["sentence2"],
    scores=eval_dataset["score"],
    main_similarity=SimilarityFunction.COSINE,
    name="sts-dev",
)
# You can run evaluation like so:
# results = dev_evaluator(model)

带有 AllNLI 的 TripletEvaluator

from datasets import load_dataset
from sentence_transformers.evaluation import TripletEvaluator, SimilarityFunction

# Load triplets from the AllNLI dataset (https://hugging-face.cn/datasets/sentence-transformers/all-nli)
max_samples = 1000
eval_dataset = load_dataset("sentence-transformers/all-nli", "triplet", split=f"dev[:{max_samples}]")

# Initialize the evaluator
dev_evaluator = TripletEvaluator(
    anchors=eval_dataset["anchor"],
    positives=eval_dataset["positive"],
    negatives=eval_dataset["negative"],
    main_distance_function=SimilarityFunction.COSINE,
    name="all-nli-dev",
)
# You can run evaluation like so:
# results = dev_evaluator(model)

NanoBEIREvaluator

from sentence_transformers.evaluation import NanoBEIREvaluator

# Initialize the evaluator. Unlike most other evaluators, this one loads the relevant datasets
# directly from Hugging Face, so there's no mandatory arguments
dev_evaluator = NanoBEIREvaluator()
# You can run evaluation like so:
# results = dev_evaluator(model)

警告

当使用分布式训练时，评估器仅在第一个设备上运行，这与跨所有设备共享的训练和评估数据集不同。

训练器

SentenceTransformerTrainer 是所有先前组件汇集的地方。我们只需要为训练器指定模型、训练参数（可选）、训练数据集、评估数据集（可选）、损失函数、评估器（可选），我们就可以开始训练。让我们看一下一个脚本，其中所有这些组件都组合在一起

from datasets import load_dataset
from sentence_transformers import (
    SentenceTransformer,
    SentenceTransformerTrainer,
    SentenceTransformerTrainingArguments,
    SentenceTransformerModelCardData,
)
from sentence_transformers.losses import MultipleNegativesRankingLoss
from sentence_transformers.training_args import BatchSamplers
from sentence_transformers.evaluation import TripletEvaluator

# 1. Load a model to finetune with 2. (Optional) model card data
model = SentenceTransformer(
    "microsoft/mpnet-base",
    model_card_data=SentenceTransformerModelCardData(
        language="en",
        license="apache-2.0",
        model_name="MPNet base trained on AllNLI triplets",
    )
)

# 3. Load a dataset to finetune on
dataset = load_dataset("sentence-transformers/all-nli", "triplet")
train_dataset = dataset["train"].select(range(100_000))
eval_dataset = dataset["dev"]
test_dataset = dataset["test"]

# 4. Define a loss function
loss = MultipleNegativesRankingLoss(model)

# 5. (Optional) Specify training arguments
args = SentenceTransformerTrainingArguments(
    # Required parameter:
    output_dir="models/mpnet-base-all-nli-triplet",
    # Optional training parameters:
    num_train_epochs=1,
    per_device_train_batch_size=16,
    per_device_eval_batch_size=16,
    learning_rate=2e-5,
    warmup_ratio=0.1,
    fp16=True,  # Set to False if you get an error that your GPU can't run on FP16
    bf16=False,  # Set to True if you have a GPU that supports BF16
    batch_sampler=BatchSamplers.NO_DUPLICATES,  # MultipleNegativesRankingLoss benefits from no duplicate samples in a batch
    # Optional tracking/debugging parameters:
    eval_strategy="steps",
    eval_steps=100,
    save_strategy="steps",
    save_steps=100,
    save_total_limit=2,
    logging_steps=100,
    run_name="mpnet-base-all-nli-triplet",  # Will be used in W&B if `wandb` is installed
)

# 6. (Optional) Create an evaluator & evaluate the base model
dev_evaluator = TripletEvaluator(
    anchors=eval_dataset["anchor"],
    positives=eval_dataset["positive"],
    negatives=eval_dataset["negative"],
    name="all-nli-dev",
)
dev_evaluator(model)

# 7. Create a trainer & train
trainer = SentenceTransformerTrainer(
    model=model,
    args=args,
    train_dataset=train_dataset,
    eval_dataset=eval_dataset,
    loss=loss,
    evaluator=dev_evaluator,
)
trainer.train()

# (Optional) Evaluate the trained model on the test set
test_evaluator = TripletEvaluator(
    anchors=test_dataset["anchor"],
    positives=test_dataset["positive"],
    negatives=test_dataset["negative"],
    name="all-nli-test",
)
test_evaluator(model)

# 8. Save the trained model
model.save_pretrained("models/mpnet-base-all-nli-triplet/final")

# 9. (Optional) Push it to the Hugging Face Hub
model.push_to_hub("mpnet-base-all-nli-triplet")

回调

此 Sentence Transformers 训练器集成了对各种 transformers.TrainerCallback 子类的支持，例如

WandbCallback，如果安装了 wandb，则自动将训练指标记录到 W&B
TensorBoardCallback，如果 tensorboard 可访问，则将训练指标记录到 TensorBoard。
CodeCarbonCallback，如果安装了 codecarbon，则跟踪模型在训练期间的碳排放量。
- 注意：这些碳排放量将包含在您的自动生成的模型卡中。

有关集成回调以及如何编写自己的回调的更多信息，请参阅 Transformers 回调文档。

多数据集训练

性能最佳的模型是同时使用多个数据集进行训练的。通常，这非常棘手，因为每个数据集都有不同的格式。但是，sentence_transformers.trainer.SentenceTransformerTrainer 可以使用多个数据集进行训练，而无需将每个数据集转换为相同的格式。它甚至可以将不同的损失函数应用于每个数据集。使用多个数据集进行训练的步骤是

使用 Dataset 实例的字典（或 DatasetDict）作为 train_dataset（以及可选的 eval_dataset）。
（可选）使用损失函数字典，将数据集名称映射到损失。仅当您希望对不同的数据集使用不同的损失函数时才需要。

每个训练/评估批次将仅包含来自一个数据集的样本。从多个数据集采样批次的顺序由 MultiDatasetBatchSamplers 枚举定义，该枚举可以通过 multi_dataset_batch_sampler 传递给 SentenceTransformerTrainingArguments。有效选项包括

MultiDatasetBatchSamplers.ROUND_ROBIN：轮询方式从每个数据集采样，直到其中一个数据集耗尽。使用此策略，可能并非每个数据集的所有样本都被使用，但每个数据集都被均等地采样。
MultiDatasetBatchSamplers.PROPORTIONAL (默认)：按比例从每个数据集采样。使用此策略，每个数据集的所有样本都会被使用，并且较大的数据集会被更频繁地采样。

这种多任务训练已被证明非常有效，例如，Huang 等人使用了 MultipleNegativesRankingLoss、CoSENTLoss 以及 MultipleNegativesRankingLoss 的变体（不使用批内负样本，仅使用困难负样本）在中国语料库上达到了最先进的性能。他们甚至应用了 MatryoshkaLoss 以使模型能够生成 Matryoshka 嵌入。

在多个数据集上训练看起来像这样

from datasets import load_dataset
from sentence_transformers import SentenceTransformer, SentenceTransformerTrainer
from sentence_transformers.losses import CoSENTLoss, MultipleNegativesRankingLoss, SoftmaxLoss

# 1. Load a model to finetune
model = SentenceTransformer("bert-base-uncased")

# 2. Load several Datasets to train with
# (anchor, positive)
all_nli_pair_train = load_dataset("sentence-transformers/all-nli", "pair", split="train[:10000]")
# (premise, hypothesis) + label
all_nli_pair_class_train = load_dataset("sentence-transformers/all-nli", "pair-class", split="train[:10000]")
# (sentence1, sentence2) + score
all_nli_pair_score_train = load_dataset("sentence-transformers/all-nli", "pair-score", split="train[:10000]")
# (anchor, positive, negative)
all_nli_triplet_train = load_dataset("sentence-transformers/all-nli", "triplet", split="train[:10000]")
# (sentence1, sentence2) + score
stsb_pair_score_train = load_dataset("sentence-transformers/stsb", split="train[:10000]")
# (anchor, positive)
quora_pair_train = load_dataset("sentence-transformers/quora-duplicates", "pair", split="train[:10000]")
# (query, answer)
natural_questions_train = load_dataset("sentence-transformers/natural-questions", split="train[:10000]")

# We can combine all datasets into a dictionary with dataset names to datasets
train_dataset = {
    "all-nli-pair": all_nli_pair_train,
    "all-nli-pair-class": all_nli_pair_class_train,
    "all-nli-pair-score": all_nli_pair_score_train,
    "all-nli-triplet": all_nli_triplet_train,
    "stsb": stsb_pair_score_train,
    "quora": quora_pair_train,
    "natural-questions": natural_questions_train,
}

# 3. Load several Datasets to evaluate with
# (anchor, positive, negative)
all_nli_triplet_dev = load_dataset("sentence-transformers/all-nli", "triplet", split="dev")
# (sentence1, sentence2, score)
stsb_pair_score_dev = load_dataset("sentence-transformers/stsb", split="validation")
# (anchor, positive)
quora_pair_dev = load_dataset("sentence-transformers/quora-duplicates", "pair", split="train[10000:11000]")
# (query, answer)
natural_questions_dev = load_dataset("sentence-transformers/natural-questions", split="train[10000:11000]")

# We can use a dictionary for the evaluation dataset too, but we don't have to. We could also just use
# no evaluation dataset, or one dataset.
eval_dataset = {
    "all-nli-triplet": all_nli_triplet_dev,
    "stsb": stsb_pair_score_dev,
    "quora": quora_pair_dev,
    "natural-questions": natural_questions_dev,
}

# 4. Load several loss functions to train with
# (anchor, positive), (anchor, positive, negative)
mnrl_loss = MultipleNegativesRankingLoss(model)
# (sentence_A, sentence_B) + class
softmax_loss = SoftmaxLoss(model, model.get_sentence_embedding_dimension(), 3)
# (sentence_A, sentence_B) + score
cosent_loss = CoSENTLoss(model)

# Create a mapping with dataset names to loss functions, so the trainer knows which loss to apply where.
# Note that you can also just use one loss if all of your training/evaluation datasets use the same loss
losses = {
    "all-nli-pair": mnrl_loss,
    "all-nli-pair-class": softmax_loss,
    "all-nli-pair-score": cosent_loss,
    "all-nli-triplet": mnrl_loss,
    "stsb": cosent_loss,
    "quora": mnrl_loss,
    "natural-questions": mnrl_loss,
}

# 5. Define a simple trainer, although it's recommended to use one with args & evaluators
trainer = SentenceTransformerTrainer(
    model=model,
    train_dataset=train_dataset,
    eval_dataset=eval_dataset,
    loss=losses,
)
trainer.train()

# 6. save the trained model and optionally push it to the Hugging Face Hub
model.save_pretrained("bert-base-all-nli-stsb-quora-nq")
model.push_to_hub("bert-base-all-nli-stsb-quora-nq")

已弃用的训练

在 Sentence Transformers v3.0 版本之前，模型会使用 SentenceTransformer.fit() 方法和 DataLoader 的 InputExample 来训练，看起来像这样

from sentence_transformers import SentenceTransformer, InputExample, losses
from torch.utils.data import DataLoader

# Define the model. Either from scratch of by loading a pre-trained model
model = SentenceTransformer("distilbert/distilbert-base-uncased")

# Define your train examples. You need more than just two examples...
train_examples = [
    InputExample(texts=["My first sentence", "My second sentence"], label=0.8),
    InputExample(texts=["Another pair", "Unrelated sentence"], label=0.3),
]

# Define your train dataset, the dataloader and the train loss
train_dataloader = DataLoader(train_examples, shuffle=True, batch_size=16)
train_loss = losses.CosineSimilarityLoss(model)

# Tune the model
model.fit(train_objectives=[(train_dataloader, train_loss)], epochs=1, warmup_steps=100)

自从 v3.0 版本发布以来，仍然可以使用 SentenceTransformer.fit()，但它会在幕后初始化一个 SentenceTransformerTrainer。建议直接使用 Trainer，因为您可以通过 SentenceTransformerTrainingArguments 获得更多控制权，但依赖于 SentenceTransformer.fit() 的现有训练脚本仍然应该可以工作。

如果更新后的 SentenceTransformer.fit() 存在问题，您还可以通过调用 SentenceTransformer.old_fit() 来获得完全旧的行为，但此方法计划在未来完全弃用。

最佳基础嵌入模型

您的文本嵌入模型的质量取决于您选择的 Transformer 模型。遗憾的是，我们无法从例如 GLUE 或 SuperGLUE 基准测试中更好的性能推断出该模型也会产生更好的表示。

为了测试 Transformer 模型的适用性，我使用了 training_nli_v2.py 脚本，并在 56 万个（anchor，positive，negative）三元组上使用批量大小 64 训练了 1 个 epoch。然后，我在来自不同领域的 14 个不同的文本相似性任务（聚类、语义搜索、重复检测等）上进行了评估。

在下表中，您可以找到不同模型的性能及其在此基准测试中的表现

模型	性能（14 个句子相似性任务）
microsoft/mpnet-base	60.99
nghuyong/ernie-2.0-en	60.73
microsoft/deberta-base	60.21
roberta-base	59.63
t5-base	59.21
bert-base-uncased	59.17
distilbert-base-uncased	59.03
nreimers/TinyBERT_L-6_H-768_v2	58.27
google/t5-v1_1-base	57.63
nreimers/MiniLMv2-L6-H768-distilled-from-BERT-Large	57.31
albert-base-v2	57.14
microsoft/MiniLM-L12-H384-uncased	56.79
microsoft/deberta-v3-base	54.46

与 CrossEncoder 训练的比较

训练 SentenceTransformer 模型与训练 CrossEncoder 模型非常相似，但有一些关键区别

与将 score、scores、label 和 labels 列视为“标签列”不同，只有 score 和 label 是标签列。正如您在 Loss Overview 文档中看到的那样，某些损失函数需要在具有这些名称之一的列中包含特定的标签/分数。
对于 CrossEncoder 训练，您可以在列中使用（可变大小的）文本列表。在 SentenceTransformer 训练中，您不能在训练/评估数据集的列中使用输入列表（例如文本）。简而言之：不支持使用可变数量的负样本进行训练。

有关训练 CrossEncoder 模型的更多详细信息，请参阅 Cross Encoder > 训练概述文档。