變換

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