快捷方式

DTypeCastTransform

class torchrl.envs.transforms.DTypeCastTransform(dtype_in: torch.dtype, dtype_out: torch.dtype, in_keys: Sequence[NestedKey] | None = None, out_keys: Sequence[NestedKey] | None = None, in_keys_inv: Sequence[NestedKey] | None = None, out_keys_inv: Sequence[NestedKey] | None = None)[source]

将选定键的数据类型从一种转换为另一种。

取决于在构造时是否提供了 in_keysin_keys_inv,类的行为会有所不同

  • 如果提供了键,则只有这些条目会从 dtype_in 转换为 dtype_out 条目;

  • 如果未提供键,并且对象位于 transforms 的环境注册表中,则将 dtype 设置为 dtype_in 的输入和输出 spec 将分别用作 in_keys_inv / in_keys。

  • 如果未提供键且对象在没有环境的情况下使用,则 forward / inverse 过程将扫描输入 tensordict 以查找所有 dtype_in 值,并将它们映射到 dtype_out tensor。对于大型数据结构,这可能会影响性能,因为扫描不是免费的。要转换的键不会被缓存。请注意,在这种情况下,不能传递 out_keys (或 out_keys_inv),因为无法精确预测键的处理顺序。

参数:
  • dtype_in (torch.dtype) – 输入 dtype (来自环境)。

  • dtype_out (torch.dtype) – 输出 dtype (用于模型训练)。

  • in_keys (Sequence of NestedKey, 可选) – 在暴露给外部对象和函数之前,要从 dtype_in 转换为 dtype_out 的键列表。

  • out_keys (Sequence of NestedKey, 可选) – 目标键列表。如果未提供,则默认为 in_keys

  • in_keys_inv (Sequence of NestedKey, 可选) – 在传递给包含的 base_env 或 storage 之前,要从 dtype_out 转换为 dtype_in 的键列表。

  • out_keys_inv (Sequence of NestedKey, 可选) – 逆向 transform 的目标键列表。如果未提供,则默认为 in_keys_inv

示例

>>> td = TensorDict(
...     {'obs': torch.ones(1, dtype=torch.double),
...     'not_transformed': torch.ones(1, dtype=torch.double),
... }, [])
>>> transform = DTypeCastTransform(torch.double, torch.float, in_keys=["obs"])
>>> _ = transform(td)
>>> print(td.get("obs").dtype)
torch.float32
>>> print(td.get("not_transformed").dtype)
torch.float64

在“自动”模式下,所有 float64 条目都会被转换

示例

>>> td = TensorDict(
...     {'obs': torch.ones(1, dtype=torch.double),
...     'not_transformed': torch.ones(1, dtype=torch.double),
... }, [])
>>> transform = DTypeCastTransform(torch.double, torch.float)
>>> _ = transform(td)
>>> print(td.get("obs").dtype)
torch.float32
>>> print(td.get("not_transformed").dtype)
torch.float32

在构造环境时未指定 transform 键的情况下,规则也是相同的行为

示例

>>> class MyEnv(EnvBase):
...     def __init__(self):
...         super().__init__()
...         self.observation_spec = Composite(obs=Unbounded((), dtype=torch.float64))
...         self.action_spec = Unbounded((), dtype=torch.float64)
...         self.reward_spec = Unbounded((1,), dtype=torch.float64)
...         self.done_spec = Unbounded((1,), dtype=torch.bool)
...     def _reset(self, data=None):
...         return TensorDict({"done": torch.zeros((1,), dtype=torch.bool), **self.observation_spec.rand()}, [])
...     def _step(self, data):
...         assert data["action"].dtype == torch.float64
...         reward = self.reward_spec.rand()
...         done = torch.zeros((1,), dtype=torch.bool)
...         obs = self.observation_spec.rand()
...         assert reward.dtype == torch.float64
...         assert obs["obs"].dtype == torch.float64
...         return obs.empty().set("next", obs.update({"reward": reward, "done": done}))
...     def _set_seed(self, seed):
...         pass
>>> env = TransformedEnv(MyEnv(), DTypeCastTransform(torch.double, torch.float))
>>> assert env.action_spec.dtype == torch.float32
>>> assert env.observation_spec["obs"].dtype == torch.float32
>>> assert env.reward_spec.dtype == torch.float32, env.reward_spec.dtype
>>> print(env.rollout(2))
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([2]), device=cpu, dtype=torch.float32, is_shared=False),
        done: Tensor(shape=torch.Size([2, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([2, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                obs: Tensor(shape=torch.Size([2]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([2, 1]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([2]),
            device=cpu,
            is_shared=False),
        obs: Tensor(shape=torch.Size([2]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([2]),
    device=cpu,
    is_shared=False)
>>> assert env.transform.in_keys == ["obs", "reward"]
>>> assert env.transform.in_keys_inv == ["action"]
forward(tensordict: TensorDictBase = None) TensorDictBase[source]

读取输入的 tensordict,并对选定的键应用 transform。

transform_input_spec(input_spec: TensorSpec) TensorSpec[source]

转换输入 spec,使结果 spec 与 transform 映射匹配。

参数:

input_spec (TensorSpec) – transform 前的 spec

返回:

transform 后的预期 spec

transform_observation_spec(observation_spec)[source]

转换观察 spec,使结果 spec 与 transform 映射匹配。

参数:

observation_spec (TensorSpec) – transform 前的 spec

返回:

transform 后的预期 spec

transform_output_spec(output_spec: Composite) Composite[source]

转换输出 spec,使结果 spec 与 transform 映射匹配。

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

返回:

transform 后的预期 spec

文档

访问 PyTorch 的全面开发者文档

查看文档

教程

获取面向初学者和高级开发者的深入教程

查看教程

资源

查找开发资源并获得问题解答

查看资源