TransformedEnv¶

class torchrl.envs.transforms.TransformedEnv(*args, **kwargs)[源代码]¶

一个转换后的环境。

参数:

base_env (EnvBase) – 要转换的原始环境。
transform (Transform 或 callable, 可选) –
应用于 base_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。

关键字参数:

auto_unwrap (bool, 可选) –

如果为 True，则将一个转换后的环境包装到另一个转换后的环境时，会将在内部 TransformedEnv 的转换解包到外部的（新实例）。默认为 True。

注意

此行为将在 v0.9 中切换为 False。

另请参阅

set_auto_unwrap_transformed_env

示例

>>> env = GymEnv("Pendulum-v0")
>>> transform = RewardScaling(0.0, 1.0)
>>> transformed_env = TransformedEnv(env, transform)
>>> # check auto-unwrap
>>> transformed_env = TransformedEnv(transformed_env, StepCounter())
>>> # The inner env has been unwrapped
>>> assert isinstance(transformed_env.base_env, GymEnv)

注意

第一个参数已从 env 重命名为 base_env 以便更清晰。为了向后兼容，仍然支持旧的 env 参数，但将在 v0.12 中删除。使用旧参数名称时会显示弃用警告。

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
返回类型:: 模块

property input_spec: TensorSpec¶: 转换环境的观测规格。

insert_transform(index: int, transform: Transform) → TransformedEnv[源代码]¶

将转换插入到指定索引的环境中。

接受 Transform 或可调用对象。

load_state_dict(state_dict: OrderedDict, **kwargs) → None[源代码]¶

将状态字典中的参数和缓冲区复制到此模块及其子模块中。

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

警告

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

参数:

state_dict (dict) – 包含参数和持久 buffer 的字典。
strict (bool, 可选) – 是否严格执行 state_dict 中的键是否与此模块的 state_dict() 函数返回的键匹配。默认值：True
assign (bool, optional) – 当设置为 False 时，将保留当前模块中张量的属性；当设置为 True 时，将保留 state_dict 中张量的属性。唯一的例外是 Parameter 的 requires_grad 字段，此时将保留模块的值。默认值：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¶: 转换环境的观测规格。

rand_action(tensordict: TensorDictBase | None = None) → TensorDict[源代码]¶

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

参数:: tensordict (TensorDictBase, optional) – 要将生成的动作写入的 tensordict。
返回:: 一个 tensordict 对象，其“action”条目已用从 action-spec 中随机抽取的样本更新。

set_missing_tolerance(mode=False)[源代码]¶: 指示当输入 tensordict 中缺少 in_key 时是否应引发 KeyError。

set_seed(seed: int | None = None, static_seed: bool = False) → int | None[源代码]¶: 设置环境的种子。

state_dict(*args, **kwargs) → OrderedDict[源代码]¶

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

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

注意

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

警告

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

警告

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

参数:

destination (dict, optional) – 如果提供，模块的状态将更新到 dict 中，并返回相同的对象。否则，将创建一个 OrderedDict 并返回。默认为 None。
prefix (str, optional) – a prefix added to parameter and buffer names to compose the keys in state_dict. Default: ''。
keep_vars (bool, optional) – 默认情况下，state dict 中返回的 Tensors 会从 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 Tensor 移动到 CUDA 设备。

有关示例，请参阅下文。

注意

此方法就地修改模块。

参数:

device (torch.device) – the desired device of the parameters and buffers in this module – 此模块中参数和缓冲区的目标设备。
dtype (torch.dtype) – the desired floating point or complex dtype of the parameters and buffers in this module – 此模块中参数和缓冲区的目标浮点数或复数 dtype。
tensor (torch.Tensor) – Tensor whose dtype and device are the desired dtype and device for all parameters and buffers in this module – 其 dtype 和 device 是此模块中所有参数和缓冲区的目标 dtype 和 device 的 Tensor。
memory_format (torch.memory_format) – the desired memory format for 4D parameters and buffers in this module (keyword only argument) – 此模块中 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)

train(mode: bool = True) → TransformedEnv[源代码]¶

将模块设置为训练模式。

This has an effect only on certain modules. See the documentation of particular modules for details of their behaviors in training/evaluation mode, i.e., whether they are affected, e.g. Dropout, BatchNorm, etc. – 这只对某些模块有影响。有关其在训练/评估模式下的行为的详细信息，例如它们是否受影响，请参阅特定模块的文档，例如 Dropout、BatchNorm 等。

参数:: mode (bool) – whether to set training mode (True) or evaluation mode (False). Default: True. – 设置训练模式（True）或评估模式（False）。默认值：True。
返回:: self
返回类型:: 模块

TransformedEnv¶

文档

教程

资源