TRL 文档

KTO 训练器

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

KTO 训练器

概览

卡尼曼-特沃斯基优化(Kahneman-Tversky Optimization, KTO)由 Kawin EthayarajhWinnie XuNiklas Muennighoff、Dan Jurafsky 和 Douwe Kiela 在论文 KTO: Model Alignment as Prospect Theoretic Optimization 中提出。

论文摘要如下:

卡尼曼和特沃斯基的前景理论告诉我们,人类以一种有偏见但明确的方式感知随机变量;例如,人类是出了名的损失厌恶。我们发现,用于使大型语言模型(LLM)与人类反馈对齐的目标函数,隐式地包含了许多这些偏见——这些目标函数(例如 DPO)相对于交叉熵最小化的成功,部分可以归因于它们是“人类感知损失函数”(human-aware loss functions, HALOs)。然而,这些方法归因于人类的效用函数仍然与前景理论文献中的有所不同。我们使用一个卡尼曼-特沃斯基的人类效用模型,提出了一个直接最大化生成内容效用的 HALO,而不是像现有方法那样最大化偏好数据的对数似然。我们将这种方法称为卡尼曼-特沃斯基优化(KTO),在从 10 亿到 300 亿参数规模的模型上,它的性能与基于偏好的方法相当或更优。关键的是,KTO 不需要偏好数据——只需要一个二元信号,即对于给定的输入,输出是理想的还是不理想的。这使得它在现实世界中更容易使用,因为偏好数据稀少且昂贵。

官方代码可以在 ContextualAI/HALOs 中找到。

此后训练方法由 Kashif RasulYounes BelkadaLewis Tunstall 和 Pablo Vicente 贡献。

快速入门

此示例演示了如何使用 KTO 方法训练模型。我们使用 Qwen 0.5B 模型作为基础模型。我们使用来自 KTO Mix 14k 的偏好数据。你可以在数据集中查看数据。

以下是训练模型的脚本

# train_kto.py
from datasets import load_dataset
from trl import KTOConfig, KTOTrainer
from transformers import AutoModelForCausalLM, AutoTokenizer

model = AutoModelForCausalLM.from_pretrained("Qwen/Qwen2-0.5B-Instruct")
tokenizer = AutoTokenizer.from_pretrained("Qwen/Qwen2-0.5B-Instruct")
train_dataset = load_dataset("trl-lib/kto-mix-14k", split="train")

training_args = KTOConfig(output_dir="Qwen2-0.5B-KTO")
trainer = KTOTrainer(model=model, args=training_args, processing_class=tokenizer, train_dataset=train_dataset)
trainer.train()

使用以下命令执行脚本

accelerate launch train_kto.py

在 8 个 H100 GPU 上进行分布式训练,大约需要 30 分钟。你可以通过检查奖励图来验证训练进度。奖励边际的上升趋势表明模型正在改进并随着时间的推移生成更好的响应。

要查看训练后的模型表现如何,可以使用 Transformers Chat CLI

$ transformers chat trl-lib/Qwen2-0.5B-KTO
<quentin_gallouedec>:
What is the best programming language?

<trl-lib/Qwen2-0.5B-KTO>:
The best programming language can vary depending on individual preferences, industry-specific requirements, technical skills, and familiarity with the specific use case or task. Here are some widely-used programming languages that have been noted as popular and widely used:                                                                                  

Here are some other factors to consider when choosing a programming language for a project:

 1 JavaScript: JavaScript is at the heart of the web and can be used for building web applications, APIs, and interactive front-end applications like frameworks like React and Angular. It's similar to C, C++, and F# in syntax structure and is accessible and easy to learn, making it a popular choice for beginners and professionals alike.                                                                   
 2 Java: Known for its object-oriented programming (OOP) and support for Java 8 and .NET, Java is used for developing enterprise-level software applications, high-performance games, as well as mobile apps, game development, and desktop applications.                                                                                                                                                            
 3 C++: Known for its flexibility and scalability, C++ offers comprehensive object-oriented programming and is a popular choice for high-performance computing and other technical fields. It's a powerful platform for building real-world applications and games at scale.                                                                                                                                         
 4 Python: Developed by Guido van Rossum in 1991, Python is a high-level, interpreted, and dynamically typed language known for its simplicity, readability, and versatility.   

预期数据集格式

KTO 需要一个非成对偏好数据集。或者,您也可以提供一个*成对*偏好数据集(也简称为*偏好数据集*)。在这种情况下,训练器会自动将其转换为非成对格式,方法是分拆“选择的”和“拒绝的”响应,为“选择的”完成分配 `label = True`,为“拒绝的”完成分配 `label = False`。

KTOTrainer 支持对话式标准两种数据集格式。当提供对话式数据集时,训练器会自动将聊天模板应用于该数据集。

理论上,数据集应至少包含一个“选择的”和一个“拒绝的”完成。然而,一些用户仅使用“选择的”或仅使用“拒绝的”数据也成功运行了 KTO。如果仅使用“拒绝的”数据,建议采用保守的学习率。

示例脚本

我们提供了一个使用 KTO 方法训练模型的示例脚本。该脚本位于 trl/scripts/kto.py

要使用Qwen2 0.5B 模型UltraFeedback 数据集上测试 KTO 脚本,请运行以下命令:

accelerate launch trl/scripts/kto.py \
    --model_name_or_path Qwen/Qwen2-0.5B-Instruct \
    --dataset_name trl-lib/kto-mix-14k \
    --num_train_epochs 1 \
    --output_dir Qwen2-0.5B-KTO

使用技巧

对于混合专家模型:启用辅助损失

如果负载在专家之间大致均匀分布,MOE(专家混合模型)效率最高。
为了确保在偏好调整期间类似地训练 MOE,将负载均衡器的辅助损失添加到最终损失中是有益的。

通过在模型配置(例如 MixtralConfig)中设置 output_router_logits=True 来启用此选项。
要调整辅助损失对总损失的贡献程度,请在模型配置中使用超参数 router_aux_loss_coef=...(默认值:0.001)。

批量大小建议

使用每步批量大小至少为 4,有效批量大小在 16 到 128 之间。即使你的有效批量大小很大,如果每步批量大小不佳,KTO 中的 KL 估计也会很差。

学习率建议

每种 `beta` 的选择都有一个在学习性能下降前可以容忍的最大学习率。对于默认设置 `beta = 0.1`,大多数模型的学习率通常不应超过 `1e-6`。随着 `beta` 的减小,学习率也应相应降低。总的来说,我们强烈建议将学习率保持在 `5e-7` 到 `5e-6` 之间。即使对于小数据集,我们也建议不要使用超出此范围的学习率。相反,应选择更多的训练轮次(epochs)以获得更好的结果。

不平衡数据

KTOConfig 中的 `desirable_weight` 和 `undesirable_weight` 分别指对理想/正例和不理想/负例损失施加的权重。默认情况下,它们都是 1。然而,如果你的一种类型的样本比另一种多,那么你应该增加较少类型样本的权重,使得(`desirable_weight`×\times正例数量)与(`undesirable_weight`×\times负例数量)的比率在 1:1 到 4:3 的范围内。

记录的指标

在训练和评估期间,我们记录以下奖励指标

  • `rewards/chosen_sum`: 策略模型对“选择的”响应的对数概率总和,按 beta 缩放
  • `rewards/rejected_sum`: 策略模型对“拒绝的”响应的对数概率总和,按 beta 缩放
  • `logps/chosen_sum`: “选择的”完成的对数概率总和
  • `logps/rejected_sum`: “拒绝的”完成的对数概率总和
  • `logits/chosen_sum`: “选择的”完成的 logits 总和
  • `logits/rejected_sum`: “拒绝的”完成的 logits 总和
  • `count/chosen`: 一个批次中“选择的”样本数量
  • `count/rejected`: 一个批次中“拒绝的”样本数量

KTOTrainer

class trl.KTOTrainer

< >

( model: typing.Union[transformers.modeling_utils.PreTrainedModel, torch.nn.modules.module.Module, str] = None ref_model: typing.Union[transformers.modeling_utils.PreTrainedModel, torch.nn.modules.module.Module, str, NoneType] = None args: KTOConfig = None train_dataset: typing.Optional[datasets.arrow_dataset.Dataset] = None eval_dataset: typing.Union[datasets.arrow_dataset.Dataset, dict[str, datasets.arrow_dataset.Dataset], NoneType] = None processing_class: typing.Union[transformers.tokenization_utils_base.PreTrainedTokenizerBase, transformers.image_processing_utils.BaseImageProcessor, transformers.feature_extraction_utils.FeatureExtractionMixin, transformers.processing_utils.ProcessorMixin, NoneType] = None data_collator: typing.Optional[transformers.data.data_collator.DataCollator] = None model_init: typing.Optional[typing.Callable[[], transformers.modeling_utils.PreTrainedModel]] = None callbacks: typing.Optional[list[transformers.trainer_callback.TrainerCallback]] = None optimizers: tuple = (None, None) preprocess_logits_for_metrics: typing.Optional[typing.Callable[[torch.Tensor, torch.Tensor], torch.Tensor]] = None peft_config: typing.Optional[dict] = None compute_metrics: typing.Optional[typing.Callable[[transformers.trainer_utils.EvalLoopOutput], dict]] = None model_adapter_name: typing.Optional[str] = None ref_adapter_name: typing.Optional[str] = None )

参数

  • model (transformers.PreTrainedModel) — 用于训练的模型,最好是 `AutoModelForSequenceClassification`。
  • ref_model (PreTrainedModelWrapper) — 带有因果语言建模头的 Hugging Face Transformer 模型。用于隐式奖励计算和损失。如果没有提供参考模型,训练器将创建一个与待优化模型相同架构的参考模型。
  • args (KTOConfig) — 用于训练的参数。
  • train_dataset (datasets.Dataset) — 用于训练的数据集。
  • eval_dataset (datasets.Dataset) — 用于评估的数据集。
  • processing_class (PreTrainedTokenizerBase, BaseImageProcessor, FeatureExtractionMixinProcessorMixin, *可选*, 默认为 None) — 用于处理数据的处理类。如果提供,将用于自动处理模型的输入,并将与模型一起保存,以便更容易地重新运行中断的训练或重用微调后的模型。
  • data_collator (transformers.DataCollator, *可选*, 默认为 None) — 用于训练的数据整理器。如果指定为 None,将使用默认的数据整理器 (`DPODataCollatorWithPadding`),它将把序列填充到批次中序列的最大长度,适用于成对序列的数据集。
  • model_init (Callable[[], transformers.PreTrainedModel]) — 用于训练的模型初始化器。如果指定为 None,将使用默认的模型初始化器。
  • callbacks (list[transformers.TrainerCallback]) — 用于训练的回调。
  • optimizers (tuple[torch.optim.Optimizer, torch.optim.lr_scheduler.LambdaLR]) — 用于训练的优化器和调度器。
  • preprocess_logits_for_metrics (Callable[[torch.Tensor, torch.Tensor], torch.Tensor]) — 在计算指标前用于预处理 logits 的函数。
  • peft_config (dict, 默认为 None) — 用于训练的 PEFT 配置。如果传递 PEFT 配置,模型将被包装在 PEFT 模型中。
  • compute_metrics (Callable[[EvalPrediction], dict], *可选*) — 用于计算指标的函数。必须接受一个 `EvalPrediction` 并返回一个从字符串到指标值的字典。
  • model_adapter_name (str, 默认为 None) — 当使用带有多个适配器的 LoRA 时,训练目标 PEFT 适配器的名称。
  • ref_adapter_name (str, 默认为 None) — 当使用带有多个适配器的 LoRA 时,参考 PEFT 适配器的名称。

初始化 KTOTrainer。

train

< >

( resume_from_checkpoint: typing.Union[str, bool, NoneType] = None trial: typing.Union[ForwardRef('optuna.Trial'), dict[str, typing.Any], NoneType] = None ignore_keys_for_eval: typing.Optional[list[str]] = None **kwargs )

参数

  • resume_from_checkpoint (strbool, *可选*) — 如果是 `str`,则为 `Trainer` 的先前实例保存的检查点的本地路径。如果是 `bool` 且等于 `True`,则加载 *args.output_dir* 中由 `Trainer` 的先前实例保存的最新检查点。如果存在,训练将从此处加载的模型/优化器/调度器状态恢复。
  • trial (optuna.Trialdict[str, Any], *可选*) — 超参数搜索的试验运行或超参数字典。
  • ignore_keys_for_eval (list[str], *可选*) — 在训练期间收集评估预测时,模型输出中(如果输出是字典)应忽略的键的列表。
  • kwargs (dict[str, Any], *可选*) — 用于隐藏已弃用参数的附加关键字参数。

主训练入口点。

save_model

< >

( output_dir: typing.Optional[str] = None _internal_call: bool = False )

将保存模型,以便您可以使用 `from_pretrained()` 重新加载它。

仅从主进程保存。

push_to_hub

< >

( commit_message: typing.Optional[str] = 'End of training' blocking: bool = True token: typing.Optional[str] = None revision: typing.Optional[str] = None **kwargs )

参数

  • commit_message (str, *可选*, 默认为 "End of training") — 推送时的提交信息。
  • blocking (bool, *可选*, 默认为 True) — 函数是否应在 `git push` 完成后才返回。
  • token (str, *可选*, 默认为 None) — 具有写入权限的令牌,用于覆盖 Trainer 的原始参数。
  • revision (str, *可选*) — 要提交的 git 修订版本。默认为“main”分支的头部。
  • kwargs (dict[str, Any], *可选*) — 传递给 `~Trainer.create_model_card` 的附加关键字参数。

将 `self.model` 和 `self.processing_class` 上传到 🤗 模型中心的 `self.args.hub_model_id` 存储库。

KTOConfig

class trl.KTOConfig

< >

( output_dir: typing.Optional[str] = None overwrite_output_dir: bool = False do_train: bool = False do_eval: bool = False do_predict: bool = False eval_strategy: typing.Union[transformers.trainer_utils.IntervalStrategy, str] = 'no' prediction_loss_only: bool = False per_device_train_batch_size: int = 8 per_device_eval_batch_size: int = 8 per_gpu_train_batch_size: typing.Optional[int] = None per_gpu_eval_batch_size: typing.Optional[int] = None gradient_accumulation_steps: int = 1 eval_accumulation_steps: typing.Optional[int] = None eval_delay: typing.Optional[float] = 0 torch_empty_cache_steps: typing.Optional[int] = None learning_rate: float = 1e-06 weight_decay: float = 0.0 adam_beta1: float = 0.9 adam_beta2: float = 0.999 adam_epsilon: float = 1e-08 max_grad_norm: float = 1.0 num_train_epochs: float = 3.0 max_steps: int = -1 lr_scheduler_type: typing.Union[transformers.trainer_utils.SchedulerType, str] = 'linear' lr_scheduler_kwargs: typing.Union[dict[str, typing.Any], str, NoneType] = <factory> warmup_ratio: float = 0.0 warmup_steps: int = 0 log_level: str = 'passive' log_level_replica: str = 'warning' log_on_each_node: bool = True logging_dir: typing.Optional[str] = None logging_strategy: typing.Union[transformers.trainer_utils.IntervalStrategy, str] = 'steps' logging_first_step: bool = False logging_steps: float = 10 logging_nan_inf_filter: bool = True save_strategy: typing.Union[transformers.trainer_utils.SaveStrategy, str] = 'steps' save_steps: float = 500 save_total_limit: typing.Optional[int] = None save_safetensors: typing.Optional[bool] = True save_on_each_node: bool = False save_only_model: bool = False restore_callback_states_from_checkpoint: bool = False no_cuda: bool = False use_cpu: bool = False use_mps_device: bool = False seed: int = 42 data_seed: typing.Optional[int] = None jit_mode_eval: bool = False use_ipex: bool = False bf16: typing.Optional[bool] = None fp16: bool = False fp16_opt_level: str = 'O1' half_precision_backend: str = 'auto' bf16_full_eval: bool = False fp16_full_eval: bool = False tf32: typing.Optional[bool] = None local_rank: int = -1 ddp_backend: typing.Optional[str] = None tpu_num_cores: typing.Optional[int] = None tpu_metrics_debug: bool = False debug: typing.Union[str, list[transformers.debug_utils.DebugOption]] = '' dataloader_drop_last: bool = False eval_steps: typing.Optional[float] = None dataloader_num_workers: int = 0 dataloader_prefetch_factor: typing.Optional[int] = None past_index: int = -1 run_name: typing.Optional[str] = None disable_tqdm: typing.Optional[bool] = None remove_unused_columns: typing.Optional[bool] = True label_names: typing.Optional[list[str]] = None load_best_model_at_end: typing.Optional[bool] = False metric_for_best_model: typing.Optional[str] = None greater_is_better: typing.Optional[bool] = None ignore_data_skip: bool = False fsdp: typing.Union[list[transformers.trainer_utils.FSDPOption], str, NoneType] = '' fsdp_min_num_params: int = 0 fsdp_config: typing.Union[dict[str, typing.Any], str, NoneType] = None fsdp_transformer_layer_cls_to_wrap: typing.Optional[str] = None accelerator_config: typing.Union[dict, str, NoneType] = None deepspeed: typing.Union[dict, str, NoneType] = None label_smoothing_factor: float = 0.0 optim: typing.Union[transformers.training_args.OptimizerNames, str] = 'adamw_torch' optim_args: typing.Optional[str] = None adafactor: bool = False group_by_length: bool = False length_column_name: typing.Optional[str] = 'length' report_to: typing.Union[NoneType, str, list[str]] = None ddp_find_unused_parameters: typing.Optional[bool] = None ddp_bucket_cap_mb: typing.Optional[int] = None ddp_broadcast_buffers: typing.Optional[bool] = None dataloader_pin_memory: bool = True dataloader_persistent_workers: bool = False skip_memory_metrics: bool = True use_legacy_prediction_loop: bool = False push_to_hub: bool = False resume_from_checkpoint: typing.Optional[str] = None hub_model_id: typing.Optional[str] = None hub_strategy: typing.Union[transformers.trainer_utils.HubStrategy, str] = 'every_save' hub_token: typing.Optional[str] = None hub_private_repo: typing.Optional[bool] = None hub_always_push: bool = False hub_revision: typing.Optional[str] = None gradient_checkpointing: bool = False gradient_checkpointing_kwargs: typing.Union[dict[str, typing.Any], str, NoneType] = None include_inputs_for_metrics: bool = False include_for_metrics: list = <factory> eval_do_concat_batches: bool = True fp16_backend: str = 'auto' push_to_hub_model_id: typing.Optional[str] = None push_to_hub_organization: typing.Optional[str] = None push_to_hub_token: typing.Optional[str] = None mp_parameters: str = '' auto_find_batch_size: bool = False full_determinism: bool = False torchdynamo: typing.Optional[str] = None ray_scope: typing.Optional[str] = 'last' ddp_timeout: int = 1800 torch_compile: bool = False torch_compile_backend: typing.Optional[str] = None torch_compile_mode: typing.Optional[str] = None include_tokens_per_second: typing.Optional[bool] = False include_num_input_tokens_seen: typing.Optional[bool] = False neftune_noise_alpha: typing.Optional[float] = None optim_target_modules: typing.Union[NoneType, str, list[str]] = None batch_eval_metrics: bool = False eval_on_start: bool = False use_liger_kernel: typing.Optional[bool] = False liger_kernel_config: typing.Optional[dict[str, bool]] = None eval_use_gather_object: typing.Optional[bool] = False average_tokens_across_devices: typing.Optional[bool] = True max_length: typing.Optional[int] = 1024 max_prompt_length: typing.Optional[int] = 512 max_completion_length: typing.Optional[int] = None beta: float = 0.1 loss_type: str = 'kto' desirable_weight: float = 1.0 undesirable_weight: float = 1.0 label_pad_token_id: int = -100 padding_value: typing.Optional[int] = None truncation_mode: str = 'keep_end' generate_during_eval: bool = False is_encoder_decoder: typing.Optional[bool] = None disable_dropout: bool = True precompute_ref_log_probs: bool = False model_init_kwargs: typing.Optional[dict[str, typing.Any]] = None ref_model_init_kwargs: typing.Optional[dict[str, typing.Any]] = None dataset_num_proc: typing.Optional[int] = None use_liger_loss: bool = False base_model_attribute_name: str = 'model' )

参数

  • max_length (intNone, 可选, 默认为 1024) — 批次中序列(提示 + 补全)的最大长度。如果要使用默认的数据整理器,则此参数为必需。
  • max_prompt_length (intNone, 可选, 默认为 512) — 提示的最大长度。如果要使用默认的数据整理器,则此参数为必需。
  • max_completion_length (intNone, 可选, 默认为 None) — 补全的最大长度。如果要使用默认的数据整理器且模型是编码器-解码器模型,则此参数为必需。
  • beta (float, 可选, 默认为 0.1) — 控制与参考模型偏差的参数。更高的 β 意味着与参考模型的偏差更小。
  • loss_type (str, 可选, 默认为 "kto") — 使用的损失类型。可能的值有:

    • "kto":来自 KTO 论文的 KTO 损失。
    • "apo_zero_unpaired":来自 APO 论文的 APO-zero 损失的非配对变体。
  • desirable_weight (float, 可选, 默认为 1.0) — 合意损失会乘以这个因子,以抵消合意和非合意对数量不均等的问题。
  • undesirable_weight (float, 可选, 默认为 1.0) — 不合意损失会乘以这个因子,以抵消合意和非合意对数量不均等的问题。
  • label_pad_token_id (int, 可选, 默认为 -100) — 标签填充标记的 ID。如果要使用默认的数据整理器,则此参数为必需。
  • padding_value (intNone, 可选, 默认为 None) — 要使用的填充值。如果为 None,则使用分词器的填充值。
  • truncation_mode (str, 可选, 默认为 "keep_end") — 当提示过长时使用的截断模式。可能的值为 "keep_end""keep_start"。如果要使用默认的数据整理器,则此参数为必需。
  • generate_during_eval (bool, 可选, 默认为 False) — 如果为 True,则在评估期间从模型和参考模型生成并记录补全到 W&B 或 Comet。
  • is_encoder_decoder (boolNone, 可选, 默认为 None) — 当使用 model_init 参数(可调用对象)来实例化模型而不是 model 参数时,您需要指定可调用对象返回的模型是否为编码器-解码器模型。
  • precompute_ref_log_probs (bool, 可选, 默认为 False) — 是否为训练和评估数据集预先计算参考模型的对数概率。这在不使用参考模型进行训练时非常有用,可以减少所需的总 GPU 内存。
  • model_init_kwargs (dict[str, Any]None, 可选, 默认为 None) — 当从字符串实例化模型时,传递给 AutoModelForCausalLM.from_pretrained 的关键字参数。
  • ref_model_init_kwargs (dict[str, Any]None, 可选, 默认为 None) — 当从字符串实例化参考模型时,传递给 AutoModelForCausalLM.from_pretrained 的关键字参数。
  • dataset_num_proc — (intNone, 可选, 默认为 None): 用于处理数据集的进程数。
  • disable_dropout (bool, 可选, 默认为 True) — 是否在模型和参考模型中禁用 dropout。
  • use_liger_loss (bool, 可选, 默认为 False) — 是否使用 Liger 损失。这需要安装 liger-kernel。
  • base_model_attribute_name (str, 可选, 默认为 "model") — 模型中包含基础模型的属性名称。当 use_liger_lossTrue 且模型没有 get_decoder 方法时,此参数用于从模型中获取基础模型。

KTOTrainer 的配置类。

这个类仅包含特定于 KTO 训练的参数。有关训练参数的完整列表,请参阅 TrainingArguments 文档。请注意,此类中的默认值可能与 TrainingArguments 中的不同。

使用 HfArgumentParser,我们可以将此类别转换为可在命令行上指定的 argparse 参数。

< > 在 GitHub 上更新