TD1Estimator

类 torchrl.objectives.value.TD1Estimator(*args, **kwargs)

\(\infty\)-时序差分 (TD(1)) 优势函数估计。

关键字参数:

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

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

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

• differentiable (bool, 可选) –

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

  注意

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

• 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"。

• shifted (bool, 可选) – 如果为 True，价值和下一时刻价值通过对价值网络的一次调用进行估计。这更快，但仅在满足以下条件时有效：(1) “next” 价值仅偏移一个时间步（例如，多步价值估计则不是这种情况）并且 (2) 在时间 t 和 t+1 使用的参数相同时（使用目标参数时则不是这种情况）。默认为 False。

• device (torch.device, 可选) – 将实例化缓冲区的设备。默认为 torch.get_default_device()。

• time_dim (int, 可选) – 输入 tensordict 中对应于时间的维度。如果未提供，则默认为标有 "time" 名称的维度（如果存在），否则默认为最后一个维度。可在调用 value_estimate() 期间覆盖。负维度是相对于输入 tensordict 计算的。

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

计算给定 tensordict 数据中的 TD(1) 优势值。

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

参数:

tensordict (TensorDictBase) – 包含计算价值估计和 TDEstimate 所需数据（观察键、"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，包含构造函数中定义的优势值 (`advantage`) 和价值误差 (`value_error`) 键。

示例

>>> 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, "reward": reward, "terminated": terminated}}, [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, time_dim: int | None = None, **kwargs)

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

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

参数:

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

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

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

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

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