TD0Estimator

class torchrl.objectives.value.TD0Estimator(*args, **kwargs)

优势函数的时间差分 (TD(0)) 估计。

也称为引导式时间差分或 1 步回报。

关键字参数：

• gamma (标量) – 指数平均折扣。

• value_network (TensorDictModule) – 用于检索价值估计的价值算子。

• shifted (bool, 可选) – 如果 True，则使用对价值网络的单次调用来估计价值和下一个价值。这更快，但仅在 (1) "next" 价值仅由一个时间步长移动（例如，在多步价值估计中并非如此）和 (2) 在时间 t 和 t+1 使用的参数相同（在使用目标参数时并非如此）时才有效。默认为 False。

• average_rewards (bool, 可选) – 如果 True，则在计算 TD 之前会标准化奖励。

• differentiable (bool, 可选) –

  如果 True，则通过价值函数的计算传播梯度。默认为 False。

  注意

  使函数调用不可微分的正确方法是在 torch.no_grad() 上下文管理器/装饰器中对其进行装饰，或者为函数模块传递分离的参数。

• skip_existing (bool, 可选) – 如果 True，则价值网络将跳过其输出已存在于 tensordict 中的模块。默认为 None，即 tensordict.nn.skip_existing() 的值不受影响。

• advantage_key (str 或 str 元组, 可选) – [已弃用] 优势条目的键。默认为 "advantage"。

• value_target_key (str 或 str 元组, 可选) – [已弃用] 优势条目的键。默认为 "value_target"。

• value_key (str 或 str 元组, 可选) – [已弃用] 要从输入 tensordict 中读取的价值键。默认为 "state_value"。

• device (torch.device, 可选) – 模块的设备。

forward(tensordict: TensorDictBase, *, params: TensorDictBase | None = None, target_params: TensorDictBase | None = None) → TensorDictBase

根据 tensordict 中的数据计算 TD(0) 优势。

如果提供了函数式模块，则可以将包含参数（以及相关目标参数）的嵌套 TensorDict 传递给模块。

参数：

tensordict (TensorDictBase) – 包含计算价值估计和 TD 估计所需的数据（观测键、"action"、("next", "reward")、("next", "done")、("next", "terminated") 和 "next" tensordict 状态，如环境返回）的 TensorDict。传递给此模块的数据应结构化为 [*B, T, *F]，其中 B 是批次大小，T 是时间维度，F 是特征维度。tensordict 必须具有形状 [*B, T]。

关键字参数：

• params (TensorDictBase, 可选) – 包含要传递给函数式价值网络模块的参数的嵌套 TensorDict。

• target_params (TensorDictBase, 可选) – 包含要传递给函数式价值网络模块的目标参数的嵌套 TensorDict。

返回值：

一个更新后的 TensorDict，其中包含在构造函数中定义的优势和价值误差键。

示例

>>> from tensordict import TensorDict
>>> value_net = TensorDictModule(
...     nn.Linear(3, 1), in_keys=["obs"], out_keys=["state_value"]
... )
>>> module = TDEstimate(
...     gamma=0.98,
...     value_network=value_net,
... )
>>> obs, next_obs = torch.randn(2, 1, 10, 3)
>>> reward = torch.randn(1, 10, 1)
>>> done = torch.zeros(1, 10, 1, dtype=torch.bool)
>>> terminated = torch.zeros(1, 10, 1, dtype=torch.bool)
>>> tensordict = TensorDict({"obs": obs, "next": {"obs": next_obs, "done": done, "terminated": terminated, "reward": reward}}, [1, 10])
>>> _ = module(tensordict)
>>> assert "advantage" in tensordict.keys()

该模块也支持非 tensordict（即解包的 tensordict）输入

示例

>>> value_net = TensorDictModule(
...     nn.Linear(3, 1), in_keys=["obs"], out_keys=["state_value"]
... )
>>> module = TDEstimate(
...     gamma=0.98,
...     value_network=value_net,
... )
>>> obs, next_obs = torch.randn(2, 1, 10, 3)
>>> reward = torch.randn(1, 10, 1)
>>> done = torch.zeros(1, 10, 1, dtype=torch.bool)
>>> terminated = torch.zeros(1, 10, 1, dtype=torch.bool)
>>> advantage, value_target = module(obs=obs, next_reward=reward, next_done=done, next_obs=next_obs, next_terminated=terminated)

value_estimate(tensordict, target_params: TensorDictBase | None = None, next_value: torch.Tensor | None = None, **kwargs)

获取价值估计，通常用作价值网络的目标值。

如果状态值键存在于 tensordict.get(("next", self.tensor_keys.value)) 中，则将使用此值，而无需求助于价值网络。

参数：

• tensordict (TensorDictBase) – 包含要读取数据的 TensorDict。

• target_params (TensorDictBase, 可选) – 包含要传递给函数式价值网络模块的目标参数的嵌套 TensorDict。

• next_value (torch.Tensor, 可选) – 下一个状态或状态-动作对的值。与 target_params 互斥。

• **kwargs – 要传递给价值网络的关键字参数。

返回值：与状态值对应的张量。