KLRewardTransform

class torchrl.envs.transforms.KLRewardTransform(actor: ProbabilisticTensorDictModule, coef=1.0, in_keys=None, out_keys=None, requires_grad=False)

一个用于向奖励添加 KL[pi_current||pi_0] 校正项的 transform。

此 transform 用于限制策略保持接近其原始配置，这在使用 RLHF 进行微调时可限制过拟合。

参数:

• actor (ProbabilisticTensorDictModule) – 一个概率 actor。它必须具备以下特性：它必须有一组输入键 (in_keys) 和输出键 (out_keys)。它必须有一个 get_dist 方法，用于输出动作的分布。

• coef (float) – KL 项的系数。默认为 1.0。

• in_keys (str 或 str/str 元组的列表) – 应从中获取奖励的输入键。默认为 "reward"。

• out_keys (str 或 str/str 元组的列表) – 应将奖励写入的输出键。默认为 "reward"。

• requires_grad (bool, 可选) – 如果为 True，冻结的参数将由原始参数的可微分克隆组成。默认为 False。

注意

如果参数不可微分（默认），它们将不随模块进行 dtype 或设备类型转换操作（例如调用 cuda()、to() 等）。当 requires_grad=True 时，转换操作将按预期工作。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> from torchrl.envs import TransformedEnv
>>> from tensordict.nn import TensorDictModule as Mod, NormalParamExtractor
>>> from torchrl.modules import ProbabilisticActor
>>> from tensordict import TensorDict
>>> from torchrl.modules.distributions import TanhNormal
>>> from torch import nn
>>> base_env = GymEnv("Pendulum-v1")
>>> n_obs = base_env.observation_spec["observation"].shape[-1]
>>> n_act = base_env.action_spec.shape[-1]
>>> module = Mod(
...     nn.Sequential(nn.Linear(n_obs, n_act * 2), NormalParamExtractor()),
...     in_keys=["observation"],
...     out_keys=["loc", "scale"],
... )
>>> actor = ProbabilisticActor(
...     module,
...     in_keys=["loc", "scale"],
...     distribution_class=TanhNormal,
...     return_log_prob=True,
... )
>>> transform = KLRewardTransform(actor, out_keys="reward_kl")
>>> env = TransformedEnv(base_env, transform)
>>> with torch.no_grad():
...     # modify the actor parameters
...     _ = TensorDict(dict(actor.named_parameters()), []).apply_(lambda x: x.data.copy_(x.data + 1))
...     td = env.rollout(3, actor)
>>> # check that rewards have been modified
>>> assert (td.get(("next", "reward")) != td.get(("next", "reward_kl"))).all()

注意

由于 KL 公式并非总是可用，并且原始分布的参数可能未被记录，我们使用 KL 散度的随机估计。

forward(tensordict: TensorDictBase) → TensorDictBase

读取输入的 tensordict，并对选定的键应用 transform。

transform_output_spec(output_spec: Composite) → Composite

转换输出 spec，使结果 spec 与 transform 映射匹配。

此方法通常应保持不变。应使用 transform_observation_spec()、transform_reward_spec() 和 transform_full_done_spec() 实现更改。 :param output_spec: transform 之前的 spec :type output_spec: TensorSpec

返回:

transform 后的预期 spec