TensorDictPrimer

class torchrl.envs.transforms.TensorDictPrimer(primers: Optional[Union[dict, Composite]] = None, random: Optional[bool] = None, default_value: Optional[Union[float, Callable, Dict[NestedKey, float], Dict[NestedKey, Callable]]] = None, reset_key: Optional[NestedKey] = None, **kwargs)

在重設時用於 TensorDict 初始化的 Primer。

此轉換將在重設時使用在初始化時提供的相關 tensorspecs 中提取的值來填入 tensordict。 如果轉換在環境上下文之外使用（例如，作為 nn.Module 或附加到重播緩衝區），則呼叫 forward 也會使用所需的特徵來填入 tensordict。

參數:

• primers (dict 或 Composite, optional) – 包含鍵-規格配對的字典，將用於填入輸入的 tensordict。 也支援 Composite 實例。

• random (bool, optional) – 如果 True，這些值將從 TensorSpec 域中隨機抽取（如果無界，則從單位高斯分佈中抽取）。 否則，將假定為固定值。 預設值為 False。

• default_value (float, Callable, Dict[NestedKey, float], Dict[NestedKey, Callable], optional) – 如果選擇非隨機填充，則會使用 default_value 來填充 tensors。如果 default_value 是一個浮點數，則 tensors 的所有元素都會被設定為該值。如果它是一個可呼叫物件 (callable)，則預期該可呼叫物件會返回一個符合規格的 tensor，並且它將被用來產生 tensors。最後，如果 default_value 是一個 tensors 的字典或一個可呼叫物件的字典，且其鍵與規格的鍵匹配，則這些將被用來產生相應的 tensors。預設值為 0.0。

• reset_key (NestedKey, optional) – 用作部分重置指示器的重置鍵。必須是唯一的。如果未提供，則預設為父環境的唯一重置鍵 (如果它只有一個)，否則會引發異常。

• **kwargs – 每個關鍵字引數對應於 tensordict 中的一個鍵。對應的值必須是一個 TensorSpec 實例，指示該值必須是什麼。

當在 TransfomedEnv 中使用時，如果父環境是批次鎖定的 (env.batch_locked=True)，則規格形狀必須與 envs 形狀匹配。如果 env 不是批次鎖定的 (例如，基於模型的 envs)，則假定批次由輸入的 tensordict 提供。

範例

>>> 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.]])

注意

某些 TorchRL 模組依賴於環境 TensorDicts 中存在的特定鍵，例如 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 Tensors 移動到 CUDA 設備。

請參閱以下範例。

注意

此方法會就地修改模組。

參數:

• device (torch.device) – 此模組中參數和緩衝區所需的設備

• dtype (torch.dtype) – 此模組中參數和緩衝區所需的浮點數或複數 dtype

• tensor (torch.Tensor) – Tensor，其 dtype 和設備是此模組中所有參數和緩衝區所需的 dtype 和設備

• 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

轉換輸入規格，使產生的規格與轉換映射匹配。

參數:

input_spec (TensorSpec) – 轉換前的規格

傳回:

轉換後預期的規格

transform_observation_spec(observation_spec: Composite) → Composite

轉換 observation spec，使結果 spec 符合轉換映射。

參數:

observation_spec (TensorSpec) – 轉換前的 spec

傳回:

轉換後預期的規格