快捷方式

KLRewardTransform

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

一個用於向獎勵新增 KL[pi_current||pi_0] 校正項的 transform。

此 transform 用於限制策略保持接近其原始配置,這在使用 RLHF 進行微調時可限制過擬合。

引數:
  • actor (ProbabilisticTensorDictModule) – 一個機率 actor。它必須具備以下特性:它必須有一組輸入鍵 (in_keys) 和輸出鍵 (out_keys)。它必須有一個 get_dist 方法,用於輸出動作的分佈。

  • coef (float) – KL 項的係數。預設為 1.0

  • in_keys (strstr/str 元組的列表) – 應從中獲取獎勵的輸入鍵。預設為 "reward"

  • out_keys (strstr/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[source]

轉換輸出 spec,使結果 spec 與 transform 對映匹配。

此方法通常應保持不變。應使用 transform_observation_spec()transform_reward_spec()transform_full_done_spec() 實現更改。 :param output_spec: transform 之前的 spec :type output_spec: TensorSpec

返回:

transform 後的預期 spec

文件

查閱 PyTorch 的全面開發者文件

檢視文件

教程

獲取面向初學者和高階開發者的深度教程

檢視教程

資源

查詢開發資源並獲得問題解答

檢視資源