TransformedEnv

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

一个 transformed_in 环境。

参数:

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

• transform (Transform 或 callable, optional) –

  应用于从 env.step(td) 获取的 tensordict 的转换。如果未提供，则使用 eval 模式下的空 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, optional) – 如果 True，则规格将在第一次调用后永久缓存（即，规格仅 transformed_in 一次）。如果转换在训练期间发生变化，则原始规格转换可能不再有效，在这种情况下，此值应设置为 False。默认为 True。

示例

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

add_truncated_keys() → TransformedEnv

向环境添加截断键。

append_transform(transform: Union[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) – 包含参数和持久缓冲区的 dict。

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

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

返回:

• missing_keys 是一个字符串列表，其中包含此模块预期但在提供的 state_dict 中缺失的任何键。

  by this module but missing from the provided state_dict.

• unexpected_keys 是一个字符串列表，其中包含此模块不预期但在提供的 state_dict 中存在的键。

  expected by this module but present in the provided 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) – 如果提供，模块的状态将更新到 dict 中，并返回同一对象。否则，将创建并返回 OrderedDict。默认值：None。

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

• keep_vars (bool, optional) – 默认情况下，state dict 中返回的 Tensor 与 autograd 分离。如果设置为 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（如果给定），但 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 (bool) – 是否设置训练模式 (True) 或评估模式 (False)。默认值：True。

返回:

self

返回类型:

Module