RolloutFromModel

class torchrl.data.RolloutFromModel(model, ref_model, reward_model, kl_coef=0.1, max_new_tokens=50, score_clip=10.0, kl_scheduler: Optional[KLControllerBase] = None, num_steps: Optional[int] = None)

用于使用因果语言模型执行 rollout 的类。

假定此类包装的模型将分词文本作为输入，其任务是预测句子中在阅读了前 n 个词之后的下一个词。

参数:

• model (transformers.Transformer) – 要使用的模型。应具有 generate() 方法。

• ref_model (transformers.Transformer) – model 的冻结版本，其中参数处于其初始配置。这用于计算奖励的 KL 惩罚，以阻止模型在训练期间偏离参考模型太远。

• reward_model – (nn.Module, tensordict.nn.TensorDictModule): 一个模型，给定 input_ids 和 attention_mask，计算每个 token 的奖励和 end_scores（每个序列中最后一个 token 的奖励）。

• kl_coef – (float, optional): 初始 kl 系数。

• max_new_tokens (int, optional) – 序列的最大长度。默认为 50。

• score_clip (float, optional) – 来自奖励模型的分数被裁剪到范围 (-score_clip, score_clip)。默认为 10。

• kl_scheduler (KLControllerBase, optional) – KL 系数调度器。

• num_steps (int, optional) – 两次优化之间的步数。

示例

>>> from tensordict.nn import TensorDictModule
>>> from torchrl.modules.models.rlhf import GPT2RewardModel
>>> from torchrl.data.rlhf.utils import RolloutFromModel
>>> from torchrl.data.rlhf.dataset import get_dataloader
>>> from torchrl.data.rlhf.prompt import PromptData
>>> from transformers import GPT2LMHeadModel
>>>
>>> dl = get_dataloader(
...     batch_size=4,
...     block_size=550,
...     tensorclass_type=PromptData,
...     device="cpu",
...     dataset_name="CarperAI/openai_summarize_tldr",
... )
>>> model = GPT2LMHeadModel.from_pretrained("gpt2")
>>> # we load ref_model with random weights so it differs from model
>>> ref_model = GPT2LMHeadModel(GPT2LMHeadModel.config_class())
>>> reward_model = GPT2RewardModel(model_path="gpt2")
>>> rollout_from_model = RolloutFromModel(model, ref_model, reward_model)
>>>
>>> batch = next(dl)
>>> rollout = rollout_from_model.rollout_from_data(batch)
>>> rollout
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([4, 50]), device=cpu, dtype=torch.int64, is_shared=False),
        attention_mask: Tensor(shape=torch.Size([4, 50, 600]), device=cpu, dtype=torch.bool, is_shared=False),
        input_ids: Tensor(shape=torch.Size([4, 50, 600]), device=cpu, dtype=torch.int64, is_shared=False),
        next: TensorDict(
            fields={
                attention_mask: Tensor(shape=torch.Size([4, 50, 600]), device=cpu, dtype=torch.bool, is_shared=False),
                done: Tensor(shape=torch.Size([4, 50, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                input_ids: Tensor(shape=torch.Size([4, 50, 600]), device=cpu, dtype=torch.int64, is_shared=False),
                reward: Tensor(shape=torch.Size([4, 50, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                reward_kl: Tensor(shape=torch.Size([4, 50, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                reward_raw: Tensor(shape=torch.Size([4, 50, 1]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([4, 50]),
            device=cpu,
            is_shared=False),
        sample_log_prob: Tensor(shape=torch.Size([4, 50, 1]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([4, 50]),
    device=cpu,
    is_shared=False)

create_rollout_td(batch, generated, log_probs, log_ratio)

用于生成数据的 TensorDict 包装器。

此函数接受一个批次以及生成的 token，并复制将从 TorchRL env rollout 中获得的 tensordict 结构，该 rollout 在每个时间步采样一个 token。

参数:

• batch (TensorDict) – 包含原始提示以及指示提示右侧索引的字段“rindex”的数据批次。

• generated (torch.Tensor) – 分词后的提示，后跟生成的 token。这可以通过调用 generate 方法获得。

• log_probs (torch.Tensor) – 生成 token 的对数概率。可以通过调用 generate 方法获得。

• log_ratio (torch.Tensor) – 根据生成模型和参考模型，生成 token 的概率的对数比率。可以通过调用 generate 方法获得。

返回:

• "action"：动作序列（生成的 token）

• "input_ids"：在每个时间步传递给生成模型的 input_ids。

• "attention_mask"：在每个时间步传递给生成模型的 attention_masks

• "sample_log_prob"：生成期间每个 token 的对数概率

• ("next", "input_ids")：生成后的 token 序列。构成将用于生成下一个 token 的输入的一部分。

• ("next", "attention_mask")：在生成 token 后更新的 attention_mask。在下一个时间步传递给生成模型

• ("next", "terminated")：布尔数组，指示是否已达到终端状态（要么是因为我们生成了 EOS token，要么是因为我们达到了 token 限制）

• ("next", "done")：布尔数组，指示是否已达到最终状态。当前是 "terminated" 的副本。

• ("next", "reward")：在每个时间步收到的奖励

• ("next", "reward_raw")：来自奖励模型的原始奖励，不包含 KL 项。这主要用于调试和日志记录，不用于训练

• ("next", "reward_kl")：来自奖励的 KL 项。这主要用于调试和日志记录，不用于训练。

返回类型:

具有以下键的 TensorDict

generate(batch: PromptData, generation_config=None)

从数据收集器采样的数据批次生成 token 序列。

参数:

• batch (PromptData) – 要使用的数据。必须具有 input_ids 和 prompt_rindex 字段。

• generation_config (GenerationConfig, optional) – 调用 generate 的配置。

返回:

a [B x (Ti +To)] 整数序列（token），

其中 Ti 是输入序列的长度，To 是生成序列的长度。

log_probs_gen：生成的 token 的对数概率。 log_ratio：生成模型下概率与冻结版本之间的对数比率。

模型和冻结版本。

返回类型:

generated (torch.Tensor)

static logprobs_of_labels(logits, labels)

标签的对数概率。

这些是从 logits 计算出来的。标签（token id）用于索引 logits 沿相关维度。