TransformedEnv

class torchrl.envs.transforms.TransformedEnv(*args, **kwargs)

经过转换的环境。

参数：

• env (EnvBase) – 要转换的原始环境。

• transform (Transform 或 callable, 可选) –

  应用于 env.step(td) 所产生的 tensordict 的转换。如果没有提供转换，则使用处于评估模式的空 Compose 占位符。

  注意

  如果 transform 是一个可调用对象，则它必须接收一个 tensordict 作为输入，并输出一个 tensordict。该可调用对象将在 step 和 reset 时被调用：如果它对奖励（在重置时不存在）进行操作，则需要实现检查以确保转换能够顺利运行

  >>> def add_1(data):
  ...     if "reward" in data.keys():
  ...         return data.set("reward", data.get("reward") + 1)
  ...     return data
  >>> env = TransformedEnv(base_env, add_1)
  

• cache_specs (bool, 可选) – 如果为 True，则规格将在第一次调用后被缓存，并且不再进行缓存（即规格将只被转换一次）。如果转换在训练期间发生变化，则原始规格转换可能不再有效，在这种情况下，此值应设置为 False。默认值为 True。

示例

>>> env = GymEnv("Pendulum-v0")
>>> transform = RewardScaling(0.0, 1.0)
>>> transformed_env = TransformedEnv(env, transform)

add_truncated_keys() → TransformedEnv

将截断键添加到环境中。

append_transform(transform: Transform | Callable[[TensorDictBase], TensorDictBase]) → TransformedEnv

将转换附加到环境中。

接受 Transform 或可调用对象。

property batch_locked: bool

环境是否可以与与其初始化时不同的批次大小一起使用。

如果为 True，则需要使用批次大小与环境相同的 tensordict 来使用该环境。 batch_locked 是一个不可变属性。

property batch_size: Size

在此环境实例中以 torch.Size() 对象的形式组织的批次环境数量。

环境可能相似或不同，但假设它们之间几乎没有或根本没有交互（例如，多任务或并行批次执行）。

empty_cache()

清除所有缓存的值。

对于常规环境，键列表（奖励、完成等）将被缓存，但在某些情况下，它们可能会在代码执行期间发生变化（例如，在添加转换时）。

eval() → TransformedEnv

将模块设置为评估模式。

这仅对某些模块有影响。有关特定模块在训练/评估模式下的行为细节（如果受到影响），请参见其文档，例如 Dropout、BatchNorm 等。

这等效于 self.train(False)。

有关 .eval() 与可能与之混淆的几种类似机制之间的比较，请参见 在本地禁用梯度计算。

返回值：

self

返回类型：

Module

property input_spec: TensorSpec

转换后的环境的动作规范。

insert_transform(index: int, transform: Transform) → TransformedEnv

在所需索引处将转换插入到环境中。

接受 Transform 或可调用对象。

load_state_dict(state_dict: OrderedDict, **kwargs) → None

将参数和缓冲区从 state_dict 复制到此模块及其后代中。

如果 strict 为 True，则 state_dict 的键必须与此模块的 state_dict() 函数返回的键完全匹配。

警告

如果 assign 为 True，则必须在调用 load_state_dict 之后创建优化器，除非 get_swap_module_params_on_conversion() 为 True。

参数：

• state_dict (dict) – 包含参数和持久缓冲区的字典。

• strict (bool, optional) – 是否严格强制要求 state_dict 中的键与此模块的 state_dict() 函数返回的键匹配。默认值：True

• assign (bool, optional) – 当 False 时，当前模块中张量的属性将被保留，而当 True 时，状态字典中张量的属性将被保留。唯一的例外是 requires_grad 字段的 Default: ``False`

返回值：

• missing_keys 是一个包含所有预期键的字符串列表

  此模块，但缺少提供的 state_dict。

• unexpected_keys 是一个包含此模块未预期的键的字符串列表

  但存在于提供的 state_dict 中。

返回类型：

NamedTuple 带有 missing_keys 和 unexpected_keys 字段

注意

如果参数或缓冲区注册为 None 并且其对应键存在于 state_dict 中，load_state_dict() 将引发 RuntimeError。

property output_spec: TensorSpec

转换后的环境的观察规范。

set_missing_tolerance(mode=False)

指示是否应在输入 tensordict 中缺少 in_key 时引发 KeyError。

set_seed(seed: Optional[int] = None, static_seed: bool = False) → Optional[int]

设置环境的种子。

state_dict(*args, **kwargs) → OrderedDict

返回一个包含对模块整个状态的引用的字典。

参数和持久缓冲区（例如运行平均值）都包含在内。键是相应的参数和缓冲区名称。设置为 None 的参数和缓冲区不包含在内。

注意

返回的对象是浅拷贝。它包含对模块的参数和缓冲区的引用。

警告

目前 state_dict() 也接受位置参数以用于 destination、prefix 和 keep_vars。但是，这正在被弃用，并且将在未来的版本中强制使用关键字参数。

警告

请避免使用参数 destination，因为它不是为最终用户设计的。

参数：

• destination (dict, optional) – 如果提供，则模块的状态将更新到字典中，并且将返回相同对象。否则，将创建一个 OrderedDict 并返回。默认值：None。

• prefix (str, optional) – 添加到参数和缓冲区名称的前缀，以组成 state_dict 中的键。默认值：''。

• keep_vars (bool, optional) – 默认情况下，Tensor s 在状态字典中返回的是与自动梯度分离的。如果将其设置为 True，则不会执行分离。默认值：False。

返回值：

包含模块整个状态的字典

返回类型：

dict

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> module.state_dict().keys()
['bias', 'weight']

to(*args, **kwargs) → TransformedEnv

移动和/或转换参数和缓冲区。

这可以称为

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

返回类型：

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)

train(mode: bool = True) → TransformedEnv

将模块设置为训练模式。

这仅对某些模块有影响。有关特定模块在训练/评估模式下的行为细节（如果受到影响），请参见其文档，例如 Dropout、BatchNorm 等。

参数：

mode (bool) – 是否设置为训练模式 (True) 或评估模式 (False)。默认值：True。

返回值：

self

返回类型：

Module