''' DPO utils Adapted from https://github.com/eric-mitchell/direct-preference-optimization/blob/main/trainers.py ''' import torch torch.backends.cuda.matmul.allow_tf32 = True import torch.nn.functional as F import torch.nn as nn from typing import Dict, List, Union, Tuple from dataclasses import dataclass from transformers import DataCollatorForSeq2Seq def dpo_loss(policy_chosen_logps: torch.FloatTensor, policy_rejected_logps: torch.FloatTensor, reference_chosen_logps: torch.FloatTensor, reference_rejected_logps: torch.FloatTensor, beta: float, reference_free: bool = False) -> Tuple[torch.FloatTensor, torch.FloatTensor, torch.FloatTensor]: """Compute the DPO loss for a batch of policy and reference model log probabilities. Args: policy_chosen_logps: Log probabilities of the policy model for the chosen responses. Shape: (batch_size,) policy_rejected_logps: Log probabilities of the policy model for the rejected responses. Shape: (batch_size,) reference_chosen_logps: Log probabilities of the reference model for the chosen responses. Shape: (batch_size,) reference_rejected_logps: Log probabilities of the reference model for the rejected responses. Shape: (batch_size,) beta: Temperature parameter for the DPO loss, typically something in the range of 0.1 to 0.5. We ignore the reference model as beta -> 0. reference_free: If True, we ignore the _provided_ reference model and implicitly use a reference model that assigns equal probability to all responses. Returns: A tuple of three tensors: (losses, chosen_rewards, rejected_rewards). The losses tensor contains the DPO loss for each example in the batch. The chosen_rewards and rejected_rewards tensors contain the rewards for the chosen and rejected responses, respectively. """ pi_logratios = policy_chosen_logps - policy_rejected_logps ref_logratios = reference_chosen_logps - reference_rejected_logps if reference_free: ref_logratios = 0 logits = pi_logratios - ref_logratios losses = -F.logsigmoid(beta * logits) chosen_rewards = beta * (policy_chosen_logps - reference_chosen_logps).detach() rejected_rewards = beta * (policy_rejected_logps - reference_rejected_logps).detach() return losses, chosen_rewards, rejected_rewards def _get_batch_logps(logits: torch.FloatTensor, labels: torch.LongTensor, average_log_prob: bool = False) -> torch.FloatTensor: """Compute the log probabilities of the given labels under the given logits. Args: logits: Logits of the model (unnormalized). Shape: (batch_size, sequence_length, vocab_size) labels: Labels for which to compute the log probabilities. Label tokens with a value of -100 are ignored. Shape: (batch_size, sequence_length) average_log_prob: If True, return the average log probability per (non-masked) token. Otherwise, return the sum of the log probabilities of the (non-masked) tokens. Returns: A tensor of shape (batch_size,) containing the average/sum log probabilities of the given labels under the given logits. """ assert logits.shape[:-1] == labels.shape labels = labels[:, 1:].clone() logits = logits[:, :-1, :] loss_mask = (labels != -100) # dummy token; we'll ignore the losses on these tokens later labels[labels == -100] = 0 per_token_logps = torch.gather(logits.log_softmax(-1), dim=2, index=labels.unsqueeze(2)).squeeze(2) if average_log_prob: return (per_token_logps * loss_mask).sum(-1) / loss_mask.sum(-1) else: return (per_token_logps * loss_mask).sum(-1) def concatenated_inputs(batch: Dict[str, Union[List, torch.LongTensor]]) -> Dict[str, torch.LongTensor]: """Concatenate the chosen and rejected inputs into a single tensor. Args: batch: A batch of data. Must contain the keys 'chosen_input_ids' and 'rejected_input_ids', which are tensors of shape (batch_size, sequence_length). Returns: A dictionary containing the concatenated inputs under the key 'concatenated_input_ids'. """ max_length = max(batch['chosen_input_ids'].shape[1], batch['rejected_input_ids'].shape[1]) concatenated_batch = {} for k in batch: if k.startswith('chosen') and isinstance(batch[k], torch.Tensor): pad_value = -100 if 'labels' in k else 0 concatenated_key = k.replace('chosen', 'concatenated') concatenated_batch[concatenated_key] = pad_to_length(batch[k], max_length, pad_value=pad_value) for k in batch: if k.startswith('rejected') and isinstance(batch[k], torch.Tensor): pad_value = -100 if 'labels' in k else 0 concatenated_key = k.replace('rejected', 'concatenated') concatenated_batch[concatenated_key] = torch.cat(( concatenated_batch[concatenated_key], pad_to_length(batch[k], max_length, pad_value=pad_value), ), dim=0) return concatenated_batch def concatenated_forward(model: nn.Module, batch: Dict[str, Union[List, torch.LongTensor]]) -> Tuple[torch.FloatTensor, torch.FloatTensor]: """Run the given model on the given batch of inputs, concatenating the chosen and rejected inputs together. We do this to avoid doing two forward passes, because it's faster for FSDP. """ concatenated_batch = concatenated_inputs(batch) all_logits = model( input_ids=concatenated_batch['concatenated_input_ids'], attention_mask=concatenated_batch['concatenated_attention_mask'] ).logits.to(torch.float32) all_logps = _get_batch_logps(all_logits, concatenated_batch['concatenated_labels'], average_log_prob=False) chosen_logps = all_logps[:batch['chosen_input_ids'].shape[0]] rejected_logps = all_logps[batch['chosen_input_ids'].shape[0]:] return chosen_logps, rejected_logps def pad_to_length(tensor: torch.Tensor, length: int, pad_value: Union[int, float], dim: int = -1) -> torch.Tensor: if tensor.size(dim) >= length: return tensor else: pad_size = list(tensor.shape) pad_size[dim] = length - tensor.size(dim) return torch.cat([tensor, pad_value * torch.ones(*pad_size, dtype=tensor.dtype, device=tensor.device)], dim=dim) @dataclass class DataCollatorForSeq2SeqDPO(DataCollatorForSeq2Seq): """ Alternate version of the hf DataCollatorForSeq2Seq for use with DPO. adapted from https://github.com/huggingface/transformers/blob/main/src/transformers/data/data_collator.py#L517C1 """ def __call__(self, features, return_tensors=None): # call the original collator on chosen and rejected separately, then combine def filter_batch(match_string, features): return [ {k.replace(match_string, ''): v for k, v in f.items() if match_string in k} for f in features ] chosen_features = super().__call__( filter_batch('chosen_', features), return_tensors=return_tensors ) rejected_features = super().__call__( filter_batch('rejected_', features), return_tensors=return_tensors ) result = {} for k in chosen_features: result['chosen_' + k] = chosen_features[k] for k in rejected_features: result['rejected_' + k] = rejected_features[k] return result