转换

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)

环境转换父类。

原则上，转换接收一个张量字典作为输入并返回（相同或另一个）张量字典作为输出，其中一系列值已修改或使用新键创建。在实例化新的转换时，要从中读取的键通过 keys 参数传递给构造函数。

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

值得注意的是，Transform 子类负责转换环境中的受影响规范：当查询 transformed_env.observation_spec 时，生成的物体将描述转换后的 in 张量的规范。

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) → TensorDictBase

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

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（如果给出），但数据类型保持不变。当设置 non_blocking 时，如果可能，它会尝试相对于主机异步转换/移动，例如，将具有固定内存的 CPU 张量移动到 CUDA 设备。

请参见下面的示例。

注意

此方法就地修改模块。

参数：

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

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

• tensor (torch.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_done_spec(done_spec: TensorSpec) → TensorSpec

转换 done spec，使其结果 spec 与转换映射匹配。

参数：

done_spec (TensorSpec) – 转换前的 spec

返回值：

转换后的预期 spec

transform_env_batch_size(batch_size: Size)

转换父环境的批次大小。

transform_env_device(device: device)

转换父环境的设备。

transform_input_spec(input_spec: TensorSpec) → TensorSpec

转换输入 spec，使其结果 spec 与转换映射匹配。

参数：

input_spec (TensorSpec) – 转换前的 spec

返回值：

转换后的预期 spec

transform_observation_spec(observation_spec: TensorSpec) → TensorSpec

转换观察 spec，使其结果 spec 与转换映射匹配。

参数：

observation_spec (TensorSpec) – 转换前的 spec

返回值：

转换后的预期 spec

transform_output_spec(output_spec: CompositeSpec) → CompositeSpec

转换输出 spec，使其结果 spec 与转换映射匹配。

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

返回值：

转换后的预期 spec

transform_reward_spec(reward_spec: TensorSpec) → TensorSpec

转换奖励 spec，使其结果 spec 与转换映射匹配。

参数：

reward_spec (TensorSpec) – 转换前的 spec

返回值：

转换后的预期 spec