变换

class torchrl.envs.transforms.Transform(in_keys: Sequence[NestedKey] = None, out_keys: Sequence[NestedKey] | None = None, in_keys_inv: Sequence[NestedKey] | None = None, out_keys_inv: Sequence[NestedKey] | None = None)

环境变换父类。

原则上，变换接收一个 tensordict 作为输入，并返回（相同或不同的）tensordict 作为输出，其中一系列值已通过新键进行修改或创建。实例化新变换时，要读取的键通过 keys 参数传递给构造函数。

变换应与目标环境结合使用 TransformedEnv 类，该类接受 EnvBase 实例和变换作为参数。如果需要使用多个变换，可以使用 Compose 类进行串联。变换可以是无状态的或有状态的（例如 CatTransform）。因此，变换支持 reset 操作，该操作应将变换重置为初始状态（以便保持后续轨迹的独立性）。

值得注意的是，Transform 子类会处理来自环境的影响到的规范（spec）的变换：当查询 transformed_env.observation_spec 时，结果对象将描述变换后输入的张量（tensor）的规范。

property container

返回包含该变换的环境。

示例

>>> from torchrl.envs import TransformedEnv, Compose, RewardSum, StepCounter
>>> from torchrl.envs.libs.gym import GymEnv
>>> env = TransformedEnv(GymEnv("Pendulum-v1"), Compose(RewardSum(), StepCounter()))
>>> env.transform[0].container is env
True

forward(tensordict: TensorDictBase = None) → TensorDictBase

读取输入的 tensordict，并对选定的键应用变换。

property parent: Optional[EnvBase]

返回该变换的父环境。

父环境是包含直到当前变换为止的所有变换的环境。

示例

>>> from torchrl.envs import TransformedEnv, Compose, RewardSum, StepCounter
>>> from torchrl.envs.libs.gym import GymEnv
>>> env = TransformedEnv(GymEnv("Pendulum-v1"), Compose(RewardSum(), StepCounter()))
>>> env.transform[1].parent
TransformedEnv(
    env=GymEnv(env=Pendulum-v1, batch_size=torch.Size([]), device=cpu),
    transform=Compose(
            RewardSum(keys=['reward'])))

to(*args, **kwargs)

移动和/或转换参数和缓冲区。

可以如下调用：

to(device=None, dtype=None, non_blocking=False)

to(dtype, non_blocking=False)

to(tensor, non_blocking=False)

to(memory_format=torch.channels_last)

其签名类似于 torch.Tensor.to()，但只接受浮点或复数 dtype。此外，此方法只会将浮点或复数参数和缓冲区转换为 dtype（如果提供）。整数参数和缓冲区如果提供 device，则会移动到该设备，但其 dtypes 保持不变。设置 non_blocking 时，它会尽量相对于主机异步转换/移动，例如，将带有固定内存的 CPU 张量移动到 CUDA 设备。

请参阅下面的示例。

注意

此方法会就地修改模块。

参数:

• device (torch.device) – 此模块中参数和缓冲区的目标设备

• dtype (torch.dtype) – 此模块中参数和缓冲区的目标浮点或复数 dtype

• tensor (torch.Tensor) – 其 dtype 和设备是此模块中所有参数和缓冲区的目标 dtype 和设备的 Tensor

• memory_format (torch.memory_format) – 此模块中 4D 参数和缓冲区的目标内存格式（仅关键字参数）

返回:

self

返回类型:

Module

示例

>>> # xdoctest: +IGNORE_WANT("non-deterministic")
>>> linear = nn.Linear(2, 2)
>>> linear.weight
Parameter containing:
tensor([[ 0.1913, -0.3420],
        [-0.5113, -0.2325]])
>>> linear.to(torch.double)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1913, -0.3420],
        [-0.5113, -0.2325]], dtype=torch.float64)
>>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1)
>>> gpu1 = torch.device("cuda:1")
>>> linear.to(gpu1, dtype=torch.half, non_blocking=True)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1914, -0.3420],
        [-0.5112, -0.2324]], dtype=torch.float16, device='cuda:1')
>>> cpu = torch.device("cpu")
>>> linear.to(cpu)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1914, -0.3420],
        [-0.5112, -0.2324]], dtype=torch.float16)

>>> linear = nn.Linear(2, 2, bias=None).to(torch.cdouble)
>>> linear.weight
Parameter containing:
tensor([[ 0.3741+0.j,  0.2382+0.j],
        [ 0.5593+0.j, -0.4443+0.j]], dtype=torch.complex128)
>>> linear(torch.ones(3, 2, dtype=torch.cdouble))
tensor([[0.6122+0.j, 0.1150+0.j],
        [0.6122+0.j, 0.1150+0.j],
        [0.6122+0.j, 0.1150+0.j]], dtype=torch.complex128)

transform_action_spec(action_spec: TensorSpec) → TensorSpec

变换 action spec，使得结果 spec 与变换映射匹配。

参数:

action_spec (TensorSpec) – 变换前的 spec

返回:

变换后的预期 spec

transform_done_spec(done_spec: TensorSpec) → TensorSpec

变换 done spec，使得结果 spec 与变换映射匹配。

参数:

done_spec (TensorSpec) – 变换前的 spec

返回:

变换后的预期 spec

transform_env_batch_size(batch_size: Size)

变换父环境的 batch-size。

transform_env_device(device: device)

变换父环境的 device。

transform_input_spec(input_spec: TensorSpec) → TensorSpec

变换 input spec，使得结果 spec 与变换映射匹配。

参数:

input_spec (TensorSpec) – 变换前的 spec

返回:

变换后的预期 spec

transform_observation_spec(observation_spec: TensorSpec) → TensorSpec

变换 observation spec，使得结果 spec 与变换映射匹配。

参数:

observation_spec (TensorSpec) – 变换前的 spec

返回:

变换后的预期 spec

transform_output_spec(output_spec: Composite) → Composite

变换 output spec，使得结果 spec 与变换映射匹配。

通常应保留此方法不变。应使用 transform_observation_spec()、transform_reward_spec() 和 transform_full_done_spec() 实现更改。 :param output_spec: 变换前的 spec :type output_spec: TensorSpec

返回:

变换后的预期 spec

transform_reward_spec(reward_spec: TensorSpec) → TensorSpec

变换 reward spec，使得结果 spec 与变换映射匹配。

参数:

reward_spec (TensorSpec) – 变换前的 spec

返回:

变换后的预期 spec

transform_state_spec(state_spec: TensorSpec) → TensorSpec

变换 state spec，使得结果 spec 与变换映射匹配。

参数:

state_spec (TensorSpec) – 变换前的 spec

返回:

变换后的预期 spec