RolloutFromModel

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

一个用于进行因果语言模型滚动的类。

假定此类包装的模型接收标记化的文本作为输入，其任务是在读取前 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, 可选)：初始 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.llm import GPT2RewardModel
>>> from torchrl.data.llm.utils import RolloutFromModel
>>> from torchrl.data.llm.dataset import get_dataloader
>>> from torchrl.data.llm.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 环境滚动（每个时间步采样一个 token）中获得的 tensordict 结构。

参数:

• 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 的配置。

返回:

一个 [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。