RewardSum

class torchrl.envs.transforms.RewardSum(in_keys: Optional[Sequence[NestedKey]] = None, out_keys: Optional[Sequence[NestedKey]] = None, reset_keys: Optional[Sequence[NestedKey]] = None, *, reward_spec: bool = False)

跟踪 episode 累积奖励。

此转换接受张量字典奖励键列表 (即 ´in_keys´)，并跟踪每个 episode 沿时间维度的累积值。

调用时，此转换为每个名为 episode_{in_key} 的 in_key 写入一个新的张量字典条目，其中写入累积值。

参数:

• in_keys (NestedKeys 列表, 可选) – 输入奖励键。所有 ´in_keys´ 都应是环境 reward_spec 的一部分。如果未指定 in_keys，则此转换假定 "reward" 为输入键。但是，也可以指定多个奖励（例如 "reward1" 和 "reward2""）。

• out_keys (NestedKeys 列表, 可选) – 输出总和键，每个输入键应有一个。

• reset_keys (NestedKeys 列表, 可选) – 要使用的 reset_keys 列表，如果找不到父环境。如果提供，此值将优先于环境 reset_keys。

关键字参数:

reward_spec (bool, 可选) – 如果为 True，则新的奖励条目将注册在 reward specs 中。默认为 False（注册在 observation_specs 中）。

示例

>>> from torchrl.envs.transforms import RewardSum, TransformedEnv
>>> from torchrl.envs.libs.gym import GymEnv
>>> env = TransformedEnv(GymEnv("CartPole-v1"), RewardSum())
>>> env.set_seed(0)
>>> torch.manual_seed(0)
>>> td = env.reset()
>>> print(td["episode_reward"])
tensor([0.])
>>> td = env.rollout(3)
>>> print(td["next", "episode_reward"])
tensor([[1.],
        [2.],
        [3.]])

forward(tensordict: TensorDictBase) → TensorDictBase

读取输入张量字典，并对选定的键应用转换。

transform_input_spec(input_spec: TensorSpec) → TensorSpec

转换输入规范，使结果规范与转换映射匹配。

参数:

input_spec (TensorSpec) – 转换前的规范

返回:

转换后的预期规范

transform_observation_spec(observation_spec: TensorSpec) → TensorSpec

转换观察规范，添加 RewardSum 生成的新键。

transform_reward_spec(reward_spec: TensorSpec) → TensorSpec

转换奖励规范，使结果规范与转换映射匹配。

参数:

reward_spec (TensorSpec) – 转换前的规范

返回:

转换后的预期规范