TRL 文档

BCO 训练器

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

BCO 训练器

TRL 支持二元分类器优化(Binary Classifier Optimization, BCO)。BCO 的作者训练了一个二元分类器,其 logit 作为奖励,使得分类器将 {提示, 选择的补全} 对映射为 1,将 {提示, 拒绝的补全} 对映射为 0。要查看完整示例,请参阅 examples/scripts/bco.py

期望的数据集类型

BCOTrainer 需要一个非配对偏好数据集BCOTrainer 同时支持对话式标准数据集格式。当提供对话式数据集时,训练器将自动对数据集应用聊天模板。

期望的模型格式

BCO 训练器需要一个 `AutoModelForCausalLM` 类型的模型,而 PPO 则需要一个 `AutoModelForCausalLMWithValueHead` 类型的模型用于价值函数。

使用 BCOTrainer

要查看详细示例,请参阅 examples/scripts/bco.py 脚本。在高层次上,我们需要用我们希望训练的 model 和一个参考 ref_model 来初始化 BCOTrainer,我们将使用参考模型来计算偏好和非偏好响应的隐含奖励。

beta 指的是隐含奖励的超参数,数据集包含上面列出的 3 个条目。请注意,modelref_model 需要具有相同的架构(即仅解码器或编码器-解码器)。

training_args = BCOConfig(
    beta=0.1,
)

bco_trainer = BCOTrainer(
    model,
    model_ref,
    args=training_args,
    train_dataset=train_dataset,
    processing_class=tokenizer,
)

之后就可以调用

bco_trainer.train()

底层分布匹配 (UDM)

在实际场景中,“赞”和“踩”数据集的提示底层分布很可能会有差异。考虑一个部署用于用户反馈的 LLM:如果模型在写作任务上表现出色,但在编码任务上表现不佳,那么“赞”数据集将主要由写作相关的提示主导,而“踩”数据集将包含大部分编码相关的提示。
如果您期望的和不期望的数据集中的提示差异很大,启用 UDM 会很有用。

选择一个嵌入模型和分词器

embedding_model = AutoModel.from_pretrained(your_model_id)
embedding_tokenizer = AutoTokenizer.from_pretrained(your_model_id)

# customize this function depending on your embedding model
def embed_prompt(input_ids, attention_mask, model):
    outputs = model(input_ids=input_ids, attention_mask=attention_mask)
    return outputs.last_hidden_state.mean(dim=1)

embedding_model = Accelerator().prepare_model(self.embedding_model)
embedding_func = partial(embed_prompt, model=embedding_model)

设置 prompt_sample_size 来定义选择多少个提示来训练 UDM 分类器,并使用提供的嵌入函数开始训练

training_args = BCOConfig(
    beta=0.1,
    prompt_sample_size=512,
)

bco_trainer = BCOTrainer(
    model,
    model_ref,
    args=training_args,
    train_dataset=train_dataset,
    processing_class=tokenizer,
    embedding_func=embedding_func,
    embedding_tokenizer=self.embedding_tokenizer,
)

bco_trainer.train()

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

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

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

BCOTrainer

class trl.BCOTrainer

< >

( 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: BCOConfig = 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 embedding_func: typing.Optional[typing.Callable] = None embedding_tokenizer: typing.Optional[transformers.tokenization_utils_base.PreTrainedTokenizerBase] = None )

参数

  • model (transformers.PreTrainedModel) — 要训练的模型,最好是 AutoModelForSequenceClassification
  • ref_model (PreTrainedModelWrapper) — 带有因果语言建模头的 Hugging Face Transformer 模型。用于隐式奖励计算和损失。如果没有提供参考模型,训练器将创建一个与待优化模型具有相同架构的参考模型。
  • args (BCOConfig) — 用于训练的参数。
  • train_dataset (datasets.Dataset) — 用于训练的数据集。
  • eval_dataset (datasets.Dataset) — 用于评估的数据集。
  • processing_class (PreTrainedTokenizerBase, BaseImageProcessor, FeatureExtractionMixin or ProcessorMixin, 可选, 默认为 None) — 用于处理数据的处理类。如果提供,将用于自动处理模型的输入,并将与模型一起保存,以便更容易地重新运行中断的训练或重用微调后的模型。
  • data_collator (transformers.DataCollator, 可选, 默认为 None) — 用于训练的数据整理器。如果未指定,将使用默认的数据整理器 (DPODataCollatorWithPadding),它将序列填充到批次中序列的最大长度,给定一个成对序列的数据集。
  • model_init (Callable[[], transformers.PreTrainedModel]) — 用于训练的模型初始化器。如果未指定,将使用默认的模型初始化器。
  • 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 适配器的名称。

根据 BCO 论文初始化 BCOTrainer。

训练

< >

( 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 (str or bool, 可选) — 如果是 str,则为之前 `Trainer` 实例保存的检查点的本地路径。如果是 bool 且等于 `True`,则加载由之前 `Trainer` 实例保存在 *args.output_dir* 中的最后一个检查点。如果存在,训练将从此处加载的模型/优化器/调度器状态恢复。
  • 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` 存储库。

BCOConfig

class trl.BCOConfig

< >

( 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 = 5e-05 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 label_pad_token_id: int = -100 padding_value: typing.Optional[int] = None truncation_mode: str = 'keep_end' disable_dropout: bool = True generate_during_eval: bool = False is_encoder_decoder: typing.Optional[bool] = None 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 prompt_sample_size: int = 1024 min_density_ratio: float = 0.5 max_density_ratio: float = 10.0 )

参数

  • max_length (int or None, 可选, 默认为 1024) — 批次中序列(提示 + 补全)的最大长度。如果要使用默认的数据整理器,则此参数是必需的。
  • max_prompt_length (int or None, 可选, 默认为 512) — 提示的最大长度。如果要使用默认的数据整理器,则此参数是必需的。
  • max_completion_length (int or None, 可选, 默认为 None) — 补全的最大长度。如果要使用默认的数据整理器且模型是编码器-解码器模型,则此参数是必需的。
  • beta (float, 可选, 默认为 0.1) — 控制与参考模型偏差的参数。较高的 β 意味着与参考模型的偏差较小。
  • label_pad_token_id (int, 可选, 默认为 -100) — 标签填充标记 ID。如果要使用默认的数据整理器,则此参数是必需的。
  • padding_value (int or None, 可选, 默认为 None) — 要使用的填充值。如果为 None,则使用分词器的填充值。
  • truncation_mode (str, 可选, 默认为 "keep_end") — 当提示过长时使用的截断模式。可能的值为 "keep_end""keep_start"。如果要使用默认的数据整理器,则此参数是必需的。
  • disable_dropout (bool, 可选, 默认为 True) — 是否在模型和参考模型中禁用 dropout。
  • generate_during_eval (bool, 可选, 默认为 False) — 如果为 True,则在评估期间生成并记录模型和参考模型的补全内容到 W&B 或 Comet。
  • is_encoder_decoder (bool or None, 可选, 默认为 None) — 当使用 model_init 参数(可调用对象)来实例化模型而不是 model 参数时,您需要指定可调用对象返回的模型是否为编码器-解码器模型。
  • precompute_ref_log_probs (bool, 可选, 默认为 False) — 是否为训练和评估数据集预先计算参考模型的对数概率。这在不使用参考模型进行训练时非常有用,可以减少所需的总 GPU 内存。
  • model_init_kwargs (dict[str, Any] or None, 可选, 默认为 None) — 当从字符串实例化模型时,传递给 AutoModelForCausalLM.from_pretrained 的关键字参数。
  • ref_model_init_kwargs (dict[str, Any] or None, 可选, 默认为 None) — 当从字符串实例化参考模型时,传递给 AutoModelForCausalLM.from_pretrained 的关键字参数。
  • dataset_num_proc (int or None, 可选, 默认为 None) — 用于处理数据集的进程数。
  • prompt_sample_size (int, 可选, 默认为 1024) — 输入到密度比分类器的提示数量。
  • min_density_ratio (float, 可选, 默认为 0.5) — 密度比的最小值。估计的密度比会被限制在这个值。
  • max_density_ratio (float, 可选, 默认为 10.0) — 密度比的最大值。估计的密度比会被限制在这个值。

BCOTrainer 的配置类。

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

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

< > 在 GitHub 上更新