TransformedEnv

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

一个变换后的环境。

参数：

• env (EnvBase) – 要进行变换的原始环境。

• transform (Transform 或 可调用对象, 可选) –

  应用于 env.step(td) 产生的 tensordict 的变换。如果未提供，则使用处于 eval 模式的空 Compose 占位符。

  注意

  如果 transform 是一个可调用对象，它必须接收一个 tensordict 作为输入并输出一个 tensordict。该可调用对象将在 step 和 reset 时刻被调用：如果它作用于奖励（在 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 (布尔值, 可选) – 如果为 True，则 spec 将在第一次调用后被一次性缓存（即 spec 只会被变换一次）。如果在训练期间变换发生变化，原始 spec 变换可能不再有效，在这种情况下，此值应设置为 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

变换后环境的观测 spec。

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 (字典) – 一个包含参数和持久缓冲区的字典。

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

• assign (布尔值, 可选) – 当设置为 False 时，保留当前模块中张量的属性，而设置为 True 时则保留 state dict 中张量的属性。唯一的例外是 Default: ``False` 的 requires_grad 字段

返回值：

• missing_keys 是一个字符串列表，包含此模块期望但

  在提供的 state_dict 中缺失的任何键。

• unexpected_keys 是一个字符串列表，包含此模块不期望但

  在提供的 state_dict 中存在的键。

返回类型：

包含 missing_keys 和 unexpected_keys 字段的 NamedTuple

注意

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

property output_spec: TensorSpec

变换后环境的观测 spec。

rand_action(tensordict: Optional[TensorDictBase] = None) → TensorDict

根据 action_spec 属性执行一个随机动作。

参数：

tensordict (TensorDictBase, 可选) – 应写入结果动作的 tensordict。

返回值：

一个 tensordict 对象，其“action”条目已使用 action-spec 中的随机样本进行更新。

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 (字典, 可选) – 如果提供，模块的状态将更新到此字典中并返回同一对象。否则，将创建一个 OrderedDict 并返回。默认值：None。

• prefix (字符串, 可选) – 添加到参数和缓冲区名称的前缀，用于构成 state_dict 中的键。默认值：''。

• keep_vars (布尔值, 可选) – 默认情况下，state dict 中返回的 Tensor 会与 autograd 分离。如果设置为 True，则不会进行分离。默认值：False。

返回值：

一个包含模块整个状态的字典

返回类型：

字典

示例

>>> # 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，则会被移动到该设备，但其 dtype 不会改变。当设置 non_blocking 时，如果可能，它会尝试相对于主机进行异步转换/移动，例如将具有固定内存的 CPU 张量移动到 CUDA 设备。

示例见下文。

注意

此方法会就地修改模块。

参数：

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

• dtype (torch.dtype) – 此模块中参数和缓冲区期望的浮点型或复数型 dtype

• tensor (torch.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)

train(mode: bool =True) → TransformedEnv

将模块设置为训练模式。

这仅对某些模块有效。有关特定模块在训练/评估模式下的行为详情，即它们是否受到影响（例如 Dropout、BatchNorm 等），请参阅其文档。

参数：

mode (布尔值) – 是设置为训练模式 (True) 还是评估模式 (False)。默认值：True。

返回值：

self

返回类型：

Module