TensorDictPrimer¶

用於在重置時初始化 TensorDict 的 primer。

此轉換將在重置時使用初始化時提供的相對 tensorspec 中的值填充 tensordict。如果在環境上下文之外使用此轉換（例如作為 nn.Module 或附加到經驗回放緩衝區），呼叫 forward 也會使用所需特徵填充 tensordict。

引數：

primers (dict 或 Composite, 可選) – 一個包含鍵-spec 對的字典，將用於填充輸入 tensordict。Composite 例項也受支援。
random (bool, 可選) – 如果為 True，將從 TensorSpec 域中隨機抽取值（如果無界，則從標準高斯分佈中抽取）。否則將使用固定值。預設為 False。
default_value (float, Callable, Dict[NestedKey, float], Dict[NestedKey, Callable], 可選) – 如果選擇非隨機填充，將使用 default_value 填充張量。如果 default_value 是一個 float，張量的所有元素都將設定為該值。如果它是一個 callable，則預期該 callable 返回一個符合 specs 的張量，並將用於生成張量。最後，如果 default_value 是一個張量字典或一個 callable 字典，且鍵與 specs 的鍵匹配，這些將用於生成相應的張量。預設為 0.0。
reset_key (NestedKey, 可選) – 用作部分重置指示器的重置鍵。必須唯一。如果未提供，則預設為父環境的唯一重置鍵（如果只有一個），否則丟擲異常。
**kwargs – 每個關鍵字引數對應 tensordict 中的一個鍵。相應的值必須是一個 TensorSpec 例項，指示該值必須是什麼。

在 TransformedEnv 中使用時，如果父環境是 batch-locked (env.batch_locked=True)，則 spec 的形狀必須與環境的形狀匹配。如果 spec 形狀與父環境形狀不匹配，則會原地修改 spec 形狀以匹配父環境批處理大小的前導維度。進行此調整是為了處理在例項化期間父環境批處理大小維度未知的情況。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> from torchrl.envs import SerialEnv
>>> base_env = SerialEnv(2, lambda: GymEnv("Pendulum-v1"))
>>> env = TransformedEnv(base_env)
>>> # the env is batch-locked, so the leading dims of the spec must match those of the env
>>> env.append_transform(TensorDictPrimer(mykey=Unbounded([2, 3])))
>>> td = env.reset()
>>> print(td)
TensorDict(
    fields={
        done: Tensor(shape=torch.Size([2, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        mykey: Tensor(shape=torch.Size([2, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        observation: Tensor(shape=torch.Size([2, 3]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([2]),
    device=cpu,
    is_shared=False)
>>> # the entry is populated with 0s
>>> print(td.get("mykey"))
tensor([[0., 0., 0.],
        [0., 0., 0.]])

呼叫 env.step() 時，鍵的當前值將保留在 "next" tensordict 中，__除非它已經存在__。

示例

>>> td = env.rand_step(td)
>>> print(td.get(("next", "mykey")))
tensor([[0., 0., 0.],
        [0., 0., 0.]])
>>> # with another value for "mykey", the previous value is not carried on
>>> td = env.reset()
>>> td = td.set(("next", "mykey"), torch.ones(2, 3))
>>> td = env.rand_step(td)
>>> print(td.get(("next", "mykey")))
tensor([[1., 1., 1.],
        [1., 1., 1.]])

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> from torchrl.envs import SerialEnv, TransformedEnv
>>> from torchrl.modules.utils import get_primers_from_module
>>> from torchrl.modules import GRUModule
>>> base_env = SerialEnv(2, lambda: GymEnv("Pendulum-v1"))
>>> env = TransformedEnv(base_env)
>>> model = GRUModule(input_size=2, hidden_size=2, in_key="observation", out_key="action")
>>> primers = get_primers_from_module(model)
>>> print(primers) # Primers shape is independent of the env batch size
TensorDictPrimer(primers=Composite(
    recurrent_state: UnboundedContinuous(
        shape=torch.Size([1, 2]),
        space=ContinuousBox(
            low=Tensor(shape=torch.Size([1, 2]), device=cpu, dtype=torch.float32, contiguous=True),
            high=Tensor(shape=torch.Size([1, 2]), device=cpu, dtype=torch.float32, contiguous=True)),
        device=cpu,
        dtype=torch.float32,
        domain=continuous),
    device=None,
    shape=torch.Size([])), default_value={'recurrent_state': 0.0}, random=None)
>>> env.append_transform(primers)
>>> print(env.reset()) # The primers are automatically expanded to match the env batch size
TensorDict(
    fields={
        done: Tensor(shape=torch.Size([2, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        observation: Tensor(shape=torch.Size([2, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        recurrent_state: Tensor(shape=torch.Size([2, 1, 2]), device=cpu, dtype=torch.float32, is_shared=False),
        terminated: Tensor(shape=torch.Size([2, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        truncated: Tensor(shape=torch.Size([2, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([2]),
    device=None,
    is_shared=False)

注意

一些 TorchRL 模組依賴於環境 TensorDict 中存在特定的鍵，例如 LSTM 或 GRU。為了簡化此過程，方法 get_primers_from_module() 會自動檢查模組及其子模組中所需的 primer 轉換並生成它們。

forward(tensordict: TensorDictBase) → TensorDictBase[源]¶: 讀取輸入的 tensordict，並對選定的鍵應用轉換。

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，整數型引數和緩衝區將被移動到該裝置，但 dtype 保持不變。當設定了 non_blocking 時，如果可能，它會嘗試相對於主機非同步轉換/移動，例如將帶有固定記憶體的 CPU 張量移動到 CUDA 裝置。

請參見下面的示例。

注意

此方法會原地修改模組。

引數：

device (torch.device) – 此模組中引數和緩衝區的目標裝置
dtype (torch.dtype) – 此模組中引數和緩衝區的目標浮點型或複數型 dtype
tensor (torch.Tensor) – 一個 Tensor，其 dtype 和 device 是此模組中所有引數和緩衝區的目標 dtype 和 device
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_input_spec(input_spec: TensorSpec) → TensorSpec[源]¶

轉換輸入 spec，使結果 spec 與轉換對映匹配。

引數：: input_spec (TensorSpec) – 轉換前的 spec
返回：: 轉換後預期的 spec

transform_observation_spec(observation_spec: Composite) → Composite[源]¶

轉換觀察 spec，使結果 spec 與轉換對映匹配。

引數：: observation_spec (TensorSpec) – 轉換前的 spec
返回：: 轉換後預期的 spec

TensorDictPrimer¶

文件

教程

資源