TensorDictPrimer

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

在重置时用于初始化 TensorDict 的引导程序。

此转换将在重置时使用初始化时提供的相关 TensorSpec 从 tensordict 中提取值。如果该转换是在环境上下文之外使用（例如，作为 nn.Module 或附加到回放缓冲区），则调用 forward 也将使用所需的特征填充 tensordict。

参数:

• primers (dict or CompositeSpec, optional) – 包含用于填充输入 tensordict 的键-规范对的字典。 CompositeSpec 实例也受支持。

• random (bool, optional) – 如果为 True，则将从 TensorSpec 域中随机提取值（如果无界，则为单位高斯分布）。否则将假定固定值。默认为 False.

• default_value (float, Callable, Dict[NestedKey, float], Dict[NestedKey, Callable], optional) – 如果选择非随机填充，则将使用 default_value 来填充张量。如果 default_value 是一个浮点数，则所有张量元素将被设置为该值。如果它是一个可调用对象，则此可调用对象应返回一个符合规范的张量，并用于生成张量。最后，如果 default_value 是一个张量字典或一个可调用对象字典，其键与规范的键相匹配，则这些将用于生成相应的张量。默认为 0.0.

• reset_key (NestedKey, optional) – 用作部分重置指示器的重置键。必须是唯一的。如果没有提供，则默认为父环境的唯一重置键（如果父环境只有一个），否则会引发异常。

• **kwargs – 每个关键字参数对应 tensordict 中的一个键。相应的 value 必须是 TensorSpec 实例，指示 value 的类型。

在 TransfomedEnv 中使用时，如果父环境是批处理锁定的 (env.batch_locked=True)，规范形状必须与环境的形状匹配。如果环境不是批处理锁定的（例如基于模型的环境），则假定批处理由输入 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=UnboundedContinuousTensorSpec([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 模块依赖于环境 TensorDict 中存在特定键，例如 LSTM 或 GRU。为了简化此过程，方法 get_primers_from_module() 会自动检查模块及其子模块中是否需要引导程序转换，并生成它们。

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，但数据类型保持不变。当 non_blocking 设置为真时，它尝试异步地转换/移动，如果可能的话，例如，将具有固定内存的 CPU 张量移动到 CUDA 设备。

请参阅下面的示例。

注意

此方法对模块进行就地修改。

参数:

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

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

• tensor (torch.Tensor) – 数据类型和设备是此模块中所有参数和缓冲区的目标数据类型和设备的张量

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

返回值:

self

返回类型:

模块

示例

>>> # 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: CompositeSpec) → CompositeSpec

转换观测规范，使结果规范与转换映射匹配。

参数:

observation_spec (TensorSpec) – 转换之前的规范

返回值:

转换后的预期规范