BCO 训练器

TRL 支持二元分类器优化 (BCO)。BCO 的作者训练一个二元分类器，其 logits 值作为奖励，以便分类器将 {提示, 选择的完成} 对映射到 1，将 {提示, 拒绝的完成} 对映射到 0。完整示例请查看 examples/scripts/bco.py。

预期数据集类型

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

预期模型格式

BCO 训练器期望使用 AutoModelForCausalLM 模型，而 PPO 则期望为价值函数使用 AutoModelForCausalLMWithValueHead。

使用 BCOTrainer

详细示例请查看 examples/scripts/bco.py 脚本。在高层面上，我们需要使用我们希望训练的 model 和一个参考 ref_model 初始化 BCOTrainer，我们将使用 ref_model 来计算首选和拒绝响应的隐式奖励。

beta 指的是隐式奖励的超参数，数据集包含上面列出的 3 个条目。请注意，model 和 ref_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，将来自负载均衡器的辅助损失添加到最终损失中是有益的。

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

BCOTrainer

class trl.BCOTrainer

< source >

( 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 或 ProcessorMixin, 可选) — 用于处理数据的处理类。如果提供，将用于自动处理模型的输入，并与模型一起保存，以便更容易地重新运行中断的训练或重用微调的模型。
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 适配器的名称。

从 BCO 论文初始化 BCOTrainer。

bco_loss

< source >

( policy_chosen_logps: FloatTensor policy_rejected_logps: FloatTensor reference_chosen_logps: FloatTensor reference_rejected_logps: FloatTensor chosen_embeddings: typing.Optional[torch.FloatTensor] rejected_embeddings: typing.Optional[torch.FloatTensor] ) → 四个张量的元组

参数

policy_chosen_logps — 策略模型对于选定响应的对数概率。形状：(batch_size 中的 num(chosen),)
policy_rejected_logps — 策略模型对于拒绝响应的对数概率。形状：(batch_size 中的 num(rejected),)
reference_chosen_logps — 参考模型对于选定响应的对数概率。形状：(batch_size 中的 num(chosen),)
reference_rejected_logps — 参考模型对于拒绝响应的对数概率。形状：(batch_size 中的 num(rejected),)
chosen_embeddings — 期望提示的嵌入
rejected_embeddings — 不期望提示的嵌入

四个张量的元组

(losses, chosen_rewards, rejected_rewards, delta)。losses 张量包含批次中每个示例的 BCO 损失。chosen_rewards 和 rejected_rewards 张量分别包含选定和拒绝响应的奖励。delta 值包含所有隐式奖励的移动平均值。

计算一批策略和参考模型对数概率的 BCO 损失。

compute_reference_log_probs

< source >

( padded_batch: dict )

计算参考模型对于 BCO 特定数据集的单个填充批次的对数概率。

create_model_card

< source >

( model_name: typing.Optional[str] = None dataset_name: typing.Optional[str] = None tags: typing.Union[str, list[str], NoneType] = None )

参数

model_name (str 或 None, 可选, 默认为 None) — 模型名称。
dataset_name (str 或 None, 可选, 默认为 None) — 用于训练的数据集名称。
tags (str, list[str] 或 None, 可选, 默认为 None) — 要与模型卡关联的标签。

使用 Trainer 可用的信息创建模型卡的草稿。

evaluation_loop

< source >

( dataloader: DataLoader description: str prediction_loss_only: typing.Optional[bool] = None ignore_keys: typing.Optional[list[str]] = None metric_key_prefix: str = 'eval' )

重写内置的评估循环，以存储每个批次的指标。预测/评估循环，由 Trainer.evaluate() 和 Trainer.predict() 共享。

有标签和无标签均可工作。

generate_from_model_and_ref

< source >

( model batch: dict )

从模型和参考模型为给定的输入批次生成样本。

get_batch_logps

< source >

( logits: FloatTensor labels: LongTensor average_log_prob: bool = False label_pad_token_id: int = -100 is_encoder_decoder: bool = False )

参数

logits — 模型的 logits（未归一化）。形状：(batch_size, sequence_length, vocab_size)
labels — 用于计算对数概率的标签。标签 token 值为 label_pad_token_id 的将被忽略。形状：(batch_size, sequence_length)
average_log_prob — 如果为 True，则返回每个（非掩码）token 的平均对数概率。否则，返回（非掩码）token 的对数概率之和。

计算给定 logits 下给定标签的对数概率。

get_batch_loss_metrics

< source >

( model batch: dict )

计算给定的训练或测试输入批次的 BCO 损失和其他指标。

get_eval_dataloader

< source >

( eval_dataset: typing.Optional[datasets.arrow_dataset.Dataset] = None )

参数

eval_dataset (torch.utils.data.Dataset, 可选) — 如果提供，将覆盖 self.eval_dataset。如果它是一个 Dataset，则会自动删除 model.forward() 方法不接受的列。它必须实现 __len__。

返回评估 ~torch.utils.data.DataLoader。

transformers.src.transformers.trainer.get_eval_dataloader 的子类，用于预计算 ref_log_probs。

get_train_dataloader

< source >

( )

返回训练 ~torch.utils.data.DataLoader。

transformers.src.transformers.trainer.get_train_dataloader 的子类，用于预计算 ref_log_probs。

日志

< source >

( logs: dict start_time: typing.Optional[float] = None )

参数

logs (dict[str, float]) — 要记录的值。
start_time (float 或 None, 可选, 默认为 None) — 训练的开始时间。

在监视训练的各种对象上记录 logs，包括存储的指标。

null_ref_context

< source >

( )

用于处理空引用模型（即 peft 适配器操作）的上下文管理器。

BCOConfig

class trl.BCOConfig

< source >

( 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, NoneType] = <factory> warmup_ratio: float = 0.0 warmup_steps: int = 0 log_level: typing.Optional[str] = 'passive' log_level_replica: typing.Optional[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 = 500 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: bool = False 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, NoneType] = None tp_size: typing.Optional[int] = 0 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 gradient_checkpointing: bool = False gradient_checkpointing_kwargs: typing.Union[dict, 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: typing.Optional[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 eval_use_gather_object: typing.Optional[bool] = False average_tokens_across_devices: typing.Optional[bool] = False 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 或 None, *可选*, 默认为 1024) — 批次中序列（提示 + 完成）的最大长度。如果您想使用默认数据整理器，则此参数是必需的。
max_prompt_length (int 或 None, *可选*, 默认为 512) — 提示的最大长度。如果您想使用默认数据整理器，则此参数是必需的。
max_completion_length (int 或 None, 可选, 默认为 None) — 补全的最大长度。如果您想使用默认数据 collator 并且您的模型是 encoder-decoder 模型，则此参数是必需的。
beta (float, 可选, 默认为 0.1) — 控制与参考模型偏差的参数。 β 值越高，表示与参考模型的偏差越小。
label_pad_token_id (int, 可选, 默认为 -100) — 标签填充 token id。如果您想使用默认数据 collator，则此参数是必需的。
padding_value (int 或 None, 可选, 默认为 None) — 要使用的填充值。如果为 None，则使用 tokenizer 的填充值。
truncation_mode (str, 可选, 默认为 "keep_end") — 当 prompt 过长时使用的截断模式。可能的值为 "keep_end" 或 "keep_start"。如果您想使用默认数据 collator，则此参数是必需的。
disable_dropout (bool, 可选, 默认为 True) — 是否在模型和参考模型中禁用 dropout。
generate_during_eval (bool, 可选, 默认为 False) — 如果为 True，则在评估期间从模型和参考模型生成并记录补全到 W&B 或 Comet。
is_encoder_decoder (bool 或 None, 可选, 默认为 None) — 当使用 model_init 参数（可调用对象）来实例化模型而不是 model 参数时，您需要指定可调用对象返回的模型是否为 encoder-decoder 模型。
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 (int 或 None, 可选, 默认为 None) — 用于处理数据集的进程数。
prompt_sample_size (int, 可选, 默认为 1024) — 输入到密度比分类器的 prompt 数量。
min_density_ratio (float, 可选, 默认为 0.5) — 密度比的最小值。估计的密度比将被限制为此值。
max_density_ratio (float, 可选, 默认为 10.0) — 密度比的最大值。估计的密度比将被限制为此值。

用于 BCOTrainer 的配置类。

使用 HfArgumentParser 我们可以将此类转换为 argparse 参数，这些参数可以在命令行中指定。

< > 在 GitHub 上更新