GAE¶
- class torchrl.objectives.value.GAE(*args, **kwargs)[source]¶
围绕广义优势估计函数类的包装器。
有关更多背景信息，请参阅 “使用广义优势估计进行高维连续控制” https://arxiv.org/pdf/1506.02438.pdf。
- 参数:
gamma (标量) – 指数均值折扣。
lmbda (标量) – 轨迹折扣。
value_network (TensorDictModule) – 用于检索价值估计值的价值算子。
average_gae (bool) – 如果为
True，则生成的 GAE 值将被标准化。默认为False。differentiable (bool, optional) –
如果为
True，则梯度会通过价值函数的计算进行传播。默认为False。注意
使函数调用不可微分的正确方法是在 torch.no_grad() 上下文管理器/装饰器中修饰它，或为函数模块传递分离的参数。
vectorized (bool, optional) – 是否使用 lambda 返回的向量化版本。默认为 True。
skip_existing (bool, optional) – 如果为
True，则价值网络将跳过输出已存在于 tensordict 中的模块。默认为None，即tensordict.nn.skip_existing()的值不受影响。默认为 “state_value”。advantage_key (str 或 str 元组, optional) – [已弃用] 优势条目的键。默认为
"advantage"。value_target_key (str 或 str 元组, optional) – [已弃用] 优势条目的键。默认为
"value_target"。value_key (str 或 str 元组, optional) – [已弃用] 从输入 tensordict 读取的价值键。默认为
"state_value"。shifted (bool, optional) – 如果为
True，则价值和下一个价值通过对价值网络的一次调用进行估计。这更快，但仅在以下情况下有效：(1)"next"值仅移动一个时间步（例如，多步价值估计并非如此），以及 (2) 时间t和t+1使用的参数相同（当要使用目标参数时并非如此）。默认为False。device (torch.device, optional) – 模块的设备。
time_dim (int, optional) – 输入 tensordict 中对应于时间的维度。如果未提供，则默认为标有
"time"名称的维度（如果有），否则默认为最后一个维度。可以在调用value_estimate()期间覆盖。负维度相对于输入 tensordict 进行考虑。
GAE 将返回一个包含优势值的
"advantage"条目。它还将返回一个"value_target"条目，其中包含用于训练价值网络的返回值。最后，如果gradient_mode为True，则将返回一个额外的可微分"value_error"条目，该条目仅表示返回值与价值网络输出之间的差异（即，应将额外的距离损失应用于该有符号值）。注意
与其他优势函数一样，如果输入 tensordict 中已存在
value_key，则 GAE 模块将忽略对价值网络的调用（如果有），并使用提供的价值代替。- forward(tensordict: TensorDictBase = None, *, params: Optional[List[Tensor]] = None, target_params: Optional[List[Tensor]] = None, time_dim: int | None = None) TensorDictBase[source]¶
计算给定 tensordict 中数据的 GAE。
如果提供了函数模块，则可以将包含参数（以及相关的目标参数）的嵌套 TensorDict 传递给该模块。
- 参数:
tensordict (TensorDictBase) – 一个 TensorDict，包含计算价值估计值和 GAE 所需的数据（观察键、
"action"、("next", "reward")、("next", "done")、("next", "terminated")和"next"tensordict 状态，由环境返回）。传递给此模块的数据应结构化为[*B, T, *F]，其中B是批次大小，T是时间维度，F是特征维度。tensordict 必须具有形状[*B, T]。- 关键字参数:
params (TensorDictBase, optional) – 一个嵌套的 TensorDict，包含要传递给函数价值网络模块的参数。
target_params (TensorDictBase, optional) – 一个嵌套的 TensorDict，包含要传递给函数价值网络模块的目标参数。
time_dim (int, optional) – 输入 tensordict 中对应于时间的维度。如果未提供，则默认为标有
"time"名称的维度（如果有），否则默认为最后一个维度。负维度相对于输入 tensordict 进行考虑。
- 返回:
一个更新后的 TensorDict，其中包含构造函数中定义的优势和 value_error 键。
示例
>>> from tensordict import TensorDict >>> value_net = TensorDictModule( ... nn.Linear(3, 1), in_keys=["obs"], out_keys=["state_value"] ... ) >>> module = GAE( ... gamma=0.98, ... lmbda=0.94, ... value_network=value_net, ... differentiable=False, ... ) >>> 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 = GAE( ... gamma=0.98, ... lmbda=0.94, ... value_network=value_net, ... differentiable=False, ... ) >>> 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, params: Optional[TensorDictBase] = None, target_params: Optional[TensorDictBase] = None, time_dim: Optional[int] = None, **kwargs)[source]¶
获取价值估计值，通常用作价值网络的目标价值。
如果状态价值键存在于
tensordict.get(("next", self.tensor_keys.value))下，则将使用此值，而无需再次调用价值网络。- 参数:
tensordict (TensorDictBase) – 包含要读取数据的 tensordict。
target_params (TensorDictBase, optional) – 一个嵌套的 TensorDict，包含要传递给函数价值网络模块的目标参数。
next_value (torch.Tensor, optional) – 下一个状态或状态-动作对的价值。与
target_params互斥。**kwargs – 要传递给价值网络的关键字参数。
返回：与状态价值相对应的张量。
