EnvBase¶

class torchrl.envs.EnvBase(*args, **kwargs)[source]¶

抽象环境父类。

关键字参数:

device (torch.device) – 环境的设备。允许使用无设备的环境（device=None）。如果不是 None，所有规范将被转换到该设备上，并且所有输入和输出预期都位于该设备上。默认为 None。
batch_size (torch.Size 或 等效类型, 可选的) – 环境的批量大小。对应于环境读写的输入和输出 tensordict 的首个维度。默认为空的批量大小。
run_type_checks (bool, 可选的) – 如果 True，则在每次重置和每次步进时都会进行类型检查。默认为 False。
allow_done_after_reset (bool, 可选的) – 如果 True，环境可以在调用 reset() 后立即完成 (done)。默认为 False。
spec_locked (bool, 可选的) –
如果 True，则规范被锁定，只有在调用 set_spec_lock_() 后才能修改。

注意

锁定是通过 EnvBase 元类实现的。它没有出现在 __init__ 方法中，而是严格出于类型提示目的包含在关键字参数中。

另请参阅

锁定环境规范.

默认为 True。
auto_reset (bool, 可选的) –
如果 True，则假定环境在完成后会自动重置。默认为 False。

注意

自动重置是通过 EnvBase 元类实现的。它没有出现在 __init__ 方法中，而是严格出于类型提示目的包含在关键字参数中。

另请参阅

API 文档中关于自动重置环境 API 的部分。

变量:

done_spec (Composite) – 等同于 full_done_spec，因为所有 done_specs 都至少包含 `"done"` 和 `"terminated"` 条目
action_spec (TensorSpec) – 动作的规范。如果预期只有一个动作张量，则链接到叶子动作的规范。否则链接到 full_action_spec。
observation_spec (Composite) – 等同于 full_observation_spec。
reward_spec (TensorSpec) – 奖励的规范。如果预期只有一个奖励张量，则链接到叶子奖励的规范。否则链接到 full_reward_spec。
state_spec (Composite) – 等同于 full_state_spec。
full_done_spec (Composite) – 一个复合规范，使得 full_done_spec.zero() 返回一个 tensordict，仅包含编码环境完成状态的叶子。
full_action_spec (Composite) – 一个复合规范，使得 full_action_spec.zero() 返回一个 tensordict，仅包含编码环境动作的叶子。
full_observation_spec (Composite) – 一个复合规范，使得 full_observation_spec.zero() 返回一个 tensordict，仅包含编码环境观测的叶子。
full_reward_spec (Composite) – 一个复合规范，使得 full_reward_spec.zero() 返回一个 tensordict，仅包含编码环境奖励的叶子。
full_state_spec (Composite) – 一个复合规范，使得 full_state_spec.zero() 返回一个 tensordict，仅包含编码环境输入（不包括动作）的叶子。
batch_size (torch.Size) – 环境的批量大小。
device (torch.device) – 环境输入/输出预期所在的设备。可以是 None。
is_spec_locked (bool) – 如果规范被锁定，则返回 True。参见上文的 spec_locked 参数。

step(TensorDictBase -> TensorDictBase)[source]¶: 在环境中步进

reset(TensorDictBase, 可选的 -> TensorDictBase)[source]¶: 重置环境

set_seed(int -> int)[source]¶: 设置环境的随机种子

rand_step(TensorDictBase, 可选的 -> TensorDictBase)[source]¶: 根据动作规范进行随机步进

rollout(Callable, ... -> TensorDictBase)[source]¶: 在环境中使用给定的策略执行轨迹收集（如果未提供策略则执行随机步进）

示例

>>> from torchrl.envs import EnvBase
>>> class CounterEnv(EnvBase):
...     def __init__(self, batch_size=(), device=None, **kwargs):
...         self.observation_spec = Composite(
...             count=Unbounded(batch_size, device=device, dtype=torch.int64))
...         self.action_spec = Unbounded(batch_size, device=device, dtype=torch.int8)
...         # done spec and reward spec are set automatically
...     def _step(self, tensordict):
...
>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.batch_size  # how many envs are run at once
torch.Size([])
>>> env.input_spec
Composite(
    full_state_spec: None,
    full_action_spec: Composite(
        action: BoundedContinuous(
            shape=torch.Size([1]),
            space=ContinuousBox(
                low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True),
                high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)),
            device=cpu,
            dtype=torch.float32,
            domain=continuous), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
>>> env.action_spec
BoundedContinuous(
    shape=torch.Size([1]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)
>>> env.observation_spec
Composite(
    observation: BoundedContinuous(
        shape=torch.Size([3]),
        space=ContinuousBox(
            low=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True),
            high=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True)),
        device=cpu,
        dtype=torch.float32,
        domain=continuous), device=cpu, shape=torch.Size([]))
>>> env.reward_spec
UnboundedContinuous(
    shape=torch.Size([1]),
    space=None,
    device=cpu,
    dtype=torch.float32,
    domain=continuous)
>>> env.done_spec
Categorical(
    shape=torch.Size([1]),
    space=DiscreteBox(n=2),
    device=cpu,
    dtype=torch.bool,
    domain=discrete)
>>> # the output_spec contains all the expected outputs
>>> env.output_spec
Composite(
    full_reward_spec: Composite(
        reward: UnboundedContinuous(
            shape=torch.Size([1]),
            space=None,
            device=cpu,
            dtype=torch.float32,
            domain=continuous), device=cpu, shape=torch.Size([])),
    full_observation_spec: Composite(
        observation: BoundedContinuous(
            shape=torch.Size([3]),
            space=ContinuousBox(
                low=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True),
                high=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True)),
            device=cpu,
            dtype=torch.float32,
            domain=continuous), device=cpu, shape=torch.Size([])),
    full_done_spec: Composite(
        done: Categorical(
            shape=torch.Size([1]),
            space=DiscreteBox(n=2),
            device=cpu,
            dtype=torch.bool,
            domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

注意

在这里了解更多关于动态规范和环境的信息：dynamic-envs。

property action_key: NestedKey¶

环境的动作键。

默认情况下，这将是“action”。

如果环境中有一个以上的动作键，此函数将抛出异常。

property action_keys: list[tensordict._nestedkey.NestedKey]¶

环境的动作键。

默认情况下，只会有一个名为“action”的键。

键按数据树中的深度排序。

property action_spec: TensorSpec¶

`action` 规范。

`action_spec` 始终作为复合规范存储。

如果动作规范作为简单规范提供，将返回此简单规范。

>>> env.action_spec = Unbounded(1)
>>> env.action_spec
UnboundedContinuous(
    shape=torch.Size([1]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

如果动作规范作为复合规范提供且仅包含一个叶子，此函数将只返回该叶子。

>>> env.action_spec = Composite({"nested": {"action": Unbounded(1)}})
>>> env.action_spec
UnboundedContinuous(
    shape=torch.Size([1]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

如果动作规范作为复合规范提供且有多个叶子，此函数将返回整个规范。

>>> env.action_spec = Composite({"nested": {"action": Unbounded(1), "another_action": Categorical(1)}})
>>> env.action_spec
Composite(
    nested: Composite(
        action: UnboundedContinuous(
            shape=torch.Size([1]),
            space=ContinuousBox(
                low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
                high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
            device=cpu,
            dtype=torch.float32,
            domain=continuous),
        another_action: Categorical(
            shape=torch.Size([]),
            space=DiscreteBox(n=1),
            device=cpu,
            dtype=torch.int64,
            domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

要检索传递的完整规范，请使用

>>> env.input_spec["full_action_spec"]

此属性是可变的。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.action_spec
BoundedContinuous(
    shape=torch.Size([1]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

property action_spec_unbatched: TensorSpec¶: 返回环境的动作规范，就像它没有批维度一样。

add_module(name: str, module: Optional[Module]) → None¶

向当前模块添加一个子模块。

可以使用给定的名称作为属性访问该模块。

参数:

name (str) – 子模块的名称。可以使用给定的名称从该模块访问子模块
module (Module) – 要添加到模块的子模块。

add_truncated_keys() → EnvBase[source]¶: 向环境添加截断键。

all_actions(tensordict: TensorDictBase | None = None) → TensorDictBase[source]¶

根据动作规范生成所有可能的动作。

这仅适用于具有完全离散动作的环境。

参数:: tensordict (TensorDictBase, 可选的) – 如果给定，则会使用此 tensordict 调用 reset()。
返回值:: 一个 tensordict 对象，其中“action”条目已更新为一批所有可能的动作。动作在首个维度中堆叠在一起。

append_transform(transform: Transform | Callable[[TensorDictBase], TensorDictBase]) → EnvBase[source]¶

返回一个变换后的环境，其中应用的传递的 callable/变换。

参数:: transform (Transform 或 Callable[[TensorDictBase], TensorDictBase]) – 要应用于环境的变换。

示例

>>> from torchrl.envs import GymEnv
>>> import torch
>>> env = GymEnv("CartPole-v1")
>>> loc = 0.5
>>> scale = 1.0
>>> transform = lambda data: data.set("observation", (data.get("observation") - loc)/scale)
>>> env = env.append_transform(transform=transform)
>>> print(env)
TransformedEnv(
    env=GymEnv(env=CartPole-v1, batch_size=torch.Size([]), device=cpu),
    transform=_CallableTransform(keys=[]))

apply(fn: Callable[[Module], None]) → T¶

将 fn 递归地应用于每个子模块（由 .children() 返回）以及自身。

典型用途包括初始化模型的参数（另请参阅 torch.nn.init）。

参数:: fn (Module -> None) – 要应用于每个子模块的函数
返回值:: 自身
返回类型:: Module

示例

>>> @torch.no_grad()
>>> def init_weights(m):
>>>     print(m)
>>>     if type(m) == nn.Linear:
>>>         m.weight.fill_(1.0)
>>>         print(m.weight)
>>> net = nn.Sequential(nn.Linear(2, 2), nn.Linear(2, 2))
>>> net.apply(init_weights)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
)

auto_specs_(policy: Callable[[TensorDictBase], TensorDictBase], *, tensordict: TensorDictBase | None = None, action_key: NestedKey | list[NestedKey] = 'action', done_key: NestedKey | list[NestedKey] | None = None, observation_key: NestedKey | list[NestedKey] = 'observation', reward_key: NestedKey | list[NestedKey] = 'reward')[source]¶

根据使用给定策略的随机轨迹收集，自动设置环境的规范 (specs)。

此方法使用提供的策略执行轨迹收集，以推断环境的输入和输出规范。它根据在轨迹收集期间收集的数据，更新环境的动作、观测、奖励和完成信号的规范。

参数:

policy (Callable[[TensorDictBase], TensorDictBase]) – 一个可调用的策略，它将 TensorDictBase 作为输入，并返回 TensorDictBase 作为输出。此策略用于执行轨迹收集并确定规范。

关键字参数:

tensordict (TensorDictBase, 可选的) – 一个可选的 TensorDictBase 实例，用作轨迹收集的初始状态。如果未提供，将调用环境的 reset 方法获取初始状态。
action_key (NestedKey 或 List[NestedKey], 可选的) – 用于在 TensorDictBase 中标识动作的键。默认为“action”。
done_key (NestedKey 或 List[NestedKey], 可选的) – 用于在 TensorDictBase 中标识完成信号的键。默认为 None，这将尝试使用 [“done”, “terminated”, “truncated”] 作为潜在键。
observation_key (NestedKey 或 List[NestedKey], 可选的) – 用于在 TensorDictBase 中标识观测的键。默认为“observation”。
reward_key (NestedKey 或 List[NestedKey], 可选的) – 用于在 TensorDictBase 中标识奖励的键。默认为“reward”。

返回值:

规范已更新的环境实例。

返回类型:

EnvBase

抛出:

RuntimeError – 如果输出规范中有键未在提供的键中考虑到。

property batch_dims: int¶: 环境的批维度数量。

property batch_locked: bool¶

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

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

property batch_size: Size¶

此环境实例中批量处理的环境数量，组织在一个 torch.Size() 对象中。

环境可能相似也可能不同，但假定它们之间几乎没有或完全没有交互（例如，多任务或并行批量执行）。

bfloat16() → T¶

将所有浮点参数和缓冲区转换为 bfloat16 数据类型。

注意

此方法会原地修改模块。

返回值:: 自身
返回类型:: Module

buffers(recurse: bool = True) → Iterator[Tensor]¶

返回模块缓冲区的迭代器。

参数:: recurse (bool) – 如果为 True，则生成此模块及所有子模块的缓冲区。否则，仅生成此模块的直接成员缓冲区。
生成值:: torch.Tensor – 模块缓冲区

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

cardinality(tensordict: TensorDictBase | None = None) → int[source]¶

动作空间的基数。

默认情况下，这只是 env.action_space.cardinality 的包装器。

当动作规范可变时，此方法很有用

动作数量可以是未定义的，例如，Categorical(n=-1)；
动作基数可能取决于动作掩码；
形状可以是动态的，如在 Unbound(shape=(-1)) 中。

在这些情况下，应该覆盖 cardinality() 方法，

参数:: tensordict (TensorDictBase, 可选的) – 包含计算基数所需数据的 tensordict。

check_env_specs(return_contiguous: bool | None = None, check_dtype=True, seed: int | None = None, tensordict: TensorDictBase | None = None)¶

根据短期轨迹收集的结果测试环境规范。

此测试函数应作为对包装有 torchrl 的 EnvBase 子类的环境进行健全性检查：预期数据与收集到的数据之间的任何差异都应抛出断言错误。

损坏的环境规范可能导致无法使用并行环境。

参数:

env (EnvBase) – 需要对照数据检查规范的环境。
return_contiguous (bool, 可选的) – 如果 True，则会调用随机轨迹收集，并设置 return_contiguous=True。这在某些情况下会失败（例如，输入/输出的形状异构）。默认为 None（由动态规范的存在决定）。
check_dtype (bool, 可选的) – 如果为 False，则跳过 dtype 检查。默认为 True。
seed (int, optional) – 为了可复现性，可以设置一个种子。此种子将临时设置在 PyTorch 中，然后将随机数生成器（RNG）状态恢复到之前的状态。对于环境，我们设置了种子，但由于大多数环境不具备恢复 RNG 状态的功能，因此这部分由用户自行完成。默认为 None。
tensordict (TensorDict, optional) – 用于重置的可选 TensorDict 实例。

注意：此函数会重置环境种子。它应该在“离线”模式下使用，以检查环境是否妥善构建，但它可能会影响实验的种子设置，因此不应放在训练脚本中。

children() → Iterator[Module]¶

返回一个遍历直接子模块的迭代器。

生成值:: Module – 一个子模块

compile(*args, **kwargs)¶

使用 torch.compile() 编译此模块的 forward 方法。

此模块的 __call__ 方法被编译，所有参数按原样传递给 torch.compile()。

有关此函数参数的详情，请参见 torch.compile()。

cpu() → T¶

将所有模型参数和缓冲区移至 CPU。

注意

此方法会原地修改模块。

返回值:: 自身
返回类型:: Module

cuda(device: Optional[Union[int, device]] = None) → T¶

将所有模型参数和缓冲区移至 GPU。

这也会使相关的参数和缓冲区成为不同的对象。因此，如果模块在优化时位于 GPU 上，应在构建优化器之前调用此方法。

注意

此方法会原地修改模块。

参数:: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回值:: 自身
返回类型:: Module

property done_key¶

环境的完成键。

默认情况下，这将是 “done”。

如果环境中有多个完成键，此函数将引发异常。

property done_keys: list[tensordict._nestedkey.NestedKey]¶

环境的完成键列表。

默认情况下，只有一个名为 “done” 的键。

键按数据树中的深度排序。

property done_keys_groups¶

完成键的列表，按重置键分组。

这是一个列表的列表。外层列表的长度与重置键的数量一致，内层列表包含完成键（例如 done 和 truncated），当重置键不存在时，可以通过这些键来确定是否需要重置。

property done_spec: TensorSpec¶

done 规范。

done_spec 始终存储为复合规范。

如果完成规范以简单规范形式提供，则返回该规范。

>>> env.done_spec = Categorical(2, dtype=torch.bool)
>>> env.done_spec
Categorical(
    shape=torch.Size([]),
    space=DiscreteBox(n=2),
    device=cpu,
    dtype=torch.bool,
    domain=discrete)

如果完成规范以复合规范形式提供并仅包含一个叶子节点，则此函数将仅返回该叶子节点。

>>> env.done_spec = Composite({"nested": {"done": Categorical(2, dtype=torch.bool)}})
>>> env.done_spec
Categorical(
    shape=torch.Size([]),
    space=DiscreteBox(n=2),
    device=cpu,
    dtype=torch.bool,
    domain=discrete)

如果完成规范以复合规范形式提供并包含多个叶子节点，则此函数将返回整个规范。

>>> env.done_spec = Composite({"nested": {"done": Categorical(2, dtype=torch.bool), "another_done": Categorical(2, dtype=torch.bool)}})
>>> env.done_spec
Composite(
    nested: Composite(
        done: Categorical(
            shape=torch.Size([]),
            space=DiscreteBox(n=2),
            device=cpu,
            dtype=torch.bool,
            domain=discrete),
        another_done: Categorical(
            shape=torch.Size([]),
            space=DiscreteBox(n=2),
            device=cpu,
            dtype=torch.bool,
            domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

若要始终检索传递的完整规范，请使用

>>> env.output_spec["full_done_spec"]

此属性是可变的。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.done_spec
Categorical(
    shape=torch.Size([1]),
    space=DiscreteBox(n=2),
    device=cpu,
    dtype=torch.bool,
    domain=discrete)

property done_spec_unbatched: TensorSpec¶: 返回环境的完成规范，如同它没有批量维度一样。

double() → T¶

将所有浮点参数和缓冲区转换为 double 数据类型。

注意

此方法会原地修改模块。

返回值:: 自身
返回类型:: Module

empty_cache()[源码]¶

清除所有缓存的值。

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

eval() → T¶

将模块设置为评估模式。

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

这等同于 self.train(False)。

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

返回值:: 自身
返回类型:: Module

extra_repr() → str¶

返回模块的额外表示。

要打印自定义的额外信息，应在您自己的模块中重新实现此方法。单行和多行字符串均可接受。

fake_tensordict() → TensorDictBase[源码]¶: 返回一个伪造的 tensordict，其键值对的形状、设备和数据类型与环境 rollout 期间的预期一致。

float() → T¶

将所有浮点参数和缓冲区转换为 float 数据类型。

注意

此方法会原地修改模块。

返回值:: 自身
返回类型:: Module

forward(*args, **kwargs)[源码]¶

定义每次调用时执行的计算。

应被所有子类重写。

注意

尽管 forward pass 的实现需要在函数内定义，但之后应调用 Module 实例而不是直接调用此函数，因为前者会负责运行已注册的 hook，而后者会静默忽略它们。

property full_action_spec: Composite¶

完整动作规范。

full_action_spec 是一个 Composite` 实例，包含所有动作条目。

示例

>>> from torchrl.envs import BraxEnv
>>> for envname in BraxEnv.available_envs:
...     break
>>> env = BraxEnv(envname)
>>> env.full_action_spec
Composite(
    action: BoundedContinuous(
        shape=torch.Size([8]),
        space=ContinuousBox(
            low=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True),
            high=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True)),
        device=cpu,
        dtype=torch.float32,
        domain=continuous), device=cpu, shape=torch.Size([]))

property full_action_spec_unbatched: Composite¶: 返回环境的动作规范，就像它没有批维度一样。

property full_done_spec: Composite¶

完整完成规范。

full_done_spec 是一个 Composite` 实例，包含所有完成条目。可用于生成伪造数据，其结构模拟了运行时获得的数据结构。

示例

>>> import gymnasium
>>> from torchrl.envs import GymWrapper
>>> env = GymWrapper(gymnasium.make("Pendulum-v1"))
>>> env.full_done_spec
Composite(
    done: Categorical(
        shape=torch.Size([1]),
        space=DiscreteBox(n=2),
        device=cpu,
        dtype=torch.bool,
        domain=discrete),
    truncated: Categorical(
        shape=torch.Size([1]),
        space=DiscreteBox(n=2),
        device=cpu,
        dtype=torch.bool,
        domain=discrete), device=cpu, shape=torch.Size([]))

property full_done_spec_unbatched: Composite¶: 返回环境的完成规范，如同它没有批量维度一样。

property full_observation_spec_unbatched: Composite¶: 返回环境的观察规范，如同它没有批量维度一样。

property full_reward_spec: Composite¶

完整奖励规范。

full_reward_spec 是一个 Composite` 实例，包含所有奖励条目。

示例

>>> import gymnasium
>>> from torchrl.envs import GymWrapper, TransformedEnv, RenameTransform
>>> base_env = GymWrapper(gymnasium.make("Pendulum-v1"))
>>> env = TransformedEnv(base_env, RenameTransform("reward", ("nested", "reward")))
>>> env.full_reward_spec
Composite(
    nested: Composite(
        reward: UnboundedContinuous(
            shape=torch.Size([1]),
            space=ContinuousBox(
                low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
                high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
            device=cpu,
            dtype=torch.float32,
            domain=continuous), device=None, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

property full_reward_spec_unbatched: Composite¶: 返回环境的奖励规范，如同它没有批量维度一样。

property full_state_spec: Composite¶

完整状态规范。

full_state_spec 是一个 Composite` 实例，包含所有状态条目（即非动作的输入数据）。

示例

>>> from torchrl.envs import BraxEnv
>>> for envname in BraxEnv.available_envs:
...     break
>>> env = BraxEnv(envname)
>>> env.full_state_spec
Composite(
    state: Composite(
        pipeline_state: Composite(
            q: UnboundedContinuous(
                shape=torch.Size([15]),
                space=None,
                device=cpu,
                dtype=torch.float32,
                domain=continuous),
    [...], device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

property full_state_spec_unbatched: Composite¶: 返回环境的状态规范，如同它没有批量维度一样。

get_buffer(target: str) → Tensor¶

如果存在由 target 指定的缓冲区，则返回它，否则抛出错误。

有关此方法功能的更详细解释以及如何正确指定 target，请参阅 get_submodule 的文档字符串。

参数:: target – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参见 get_submodule。）
返回值:: target 引用的缓冲区
返回类型:: torch.Tensor
抛出:: AttributeError – 如果 target 字符串引用了无效路径或解析到的不是缓冲区

get_extra_state() → Any¶

返回要包含在模块 state_dict 中的任何额外状态。

如果需要存储额外状态，请实现此方法以及相应的 set_extra_state()。构建模块的 state_dict() 时会调用此函数。

请注意，额外状态应是可 pickle 的，以确保 state_dict 的序列化正常工作。我们仅为 Tensor 的序列化提供向后兼容性保证；其他对象如果其序列化 pickle 形式发生变化，可能会破坏向后兼容性。

返回值:: 要存储在模块 state_dict 中的任何额外状态
返回类型:: object

get_parameter(target: str) → Parameter¶

如果存在由 target 指定的参数，则返回它，否则抛出错误。

有关此方法功能的更详细解释以及如何正确指定 target，请参阅 get_submodule 的文档字符串。

参数:: target – 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参见 get_submodule。）
返回值:: target 引用的 Parameter
返回类型:: torch.nn.Parameter
抛出:: AttributeError – 如果 target 字符串引用了无效路径或解析到的不是 nn.Parameter

get_submodule(target: str) → Module¶

如果存在由 target 指定的子模块，则返回它，否则抛出错误。

例如，假设您有一个 nn.Module A，其结构如下

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
        )
        (linear): Linear(in_features=100, out_features=200, bias=True)
    )
)

(图示显示一个 nn.Module A。 A 包含嵌套子模块 net_b，net_b 本身包含两个子模块 net_c 和 linear。net_c 接着包含子模块 conv。)

要检查是否存在 linear 子模块，我们会调用 get_submodule("net_b.linear")。要检查是否存在 conv 子模块，我们会调用 get_submodule("net_b.net_c.conv")。

get_submodule 的运行时开销受 target 中模块嵌套深度的限制。对 named_modules 的查询可以达到相同的结果，但其复杂度相对于传递子模块的数量是 O(N)。因此，对于简单的检查某个子模块是否存在的情况，应始终使用 get_submodule。

参数:: target – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参见上面的示例。）
返回值:: target 引用的子模块
返回类型:: torch.nn.Module
抛出:: AttributeError – 如果 target 字符串引用了无效路径或解析到的不是 nn.Module

half() → T¶

将所有浮点参数和缓冲区转换为 half 数据类型。

注意

此方法会原地修改模块。

返回值:: 自身
返回类型:: Module

property input_spec: TensorSpec¶

输入规范。

包含环境所有输入数据规范的复合规范。

它包含

“full_action_spec”：输入动作的规范
“full_state_spec”：所有其他环境输入的规范

此属性被锁定且应为只读。若要设置其中包含的规范，应使用相应的属性。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.input_spec
Composite(
    full_state_spec: None,
    full_action_spec: Composite(
        action: BoundedContinuous(
            shape=torch.Size([1]),
            space=ContinuousBox(
                low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True),
                high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)),
            device=cpu,
            dtype=torch.float32,
            domain=continuous), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

property input_spec_unbatched: Composite¶: 返回环境的输入规范，如同它没有批量维度一样。

ipu(device: Optional[Union[int, device]] = None) → T¶

将所有模型参数和缓冲区移至 IPU。

这也会使相关的参数和缓冲区成为不同的对象。因此，如果模块在优化时位于 IPU 上，应在构建优化器之前调用此方法。

注意

此方法会原地修改模块。

参数:: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回值:: 自身
返回类型:: Module

property is_spec_locked¶

获取环境规范是否被锁定。

此属性可以直接修改。

返回值:: 如果规范已锁定则为 True，否则为 False。
返回类型:: bool

另请参阅

锁定环境规范.

load_state_dict(state_dict: Mapping[str, Any], strict: bool = True, assign: bool = False)¶

将 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 时，保留 state dict 中张量的属性。唯一的例外是 Parameters 的 requires_grad 字段。默认值: ``False`

返回值:

missing_keys 是一个字符串列表，包含此模块期望但提供的 state_dict 中缺失的所有键。
unexpected_keys 是一个字符串列表，包含此模块不期望但提供的 state_dict 中存在的键。

返回类型:

NamedTuple，包含 missing_keys 和 unexpected_keys 字段

注意

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

maybe_reset(tensordict: TensorDictBase) → TensorDictBase[源码]¶

检查输入 tensordict 的完成键，并在需要时重置已完成的环境。

参数:: tensordict (TensorDictBase) – 一个来自 step_mdp() 输出的 tensordict。
返回值:: 一个 tensordict，在环境未重置的地方与输入相同，在环境已重置的地方包含新的重置数据。

modules() → Iterator[Module]¶

返回一个遍历网络中所有模块的迭代器。

生成值:: Module – 网络中的一个模块

注意

重复模块仅返回一次。在以下示例中，l 只返回一次。

示例

>>> l = nn.Linear(2, 2)
>>> net = nn.Sequential(l, l)
>>> for idx, m in enumerate(net.modules()):
...     print(idx, '->', m)

0 -> Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
)
1 -> Linear(in_features=2, out_features=2, bias=True)

mtia(device: Optional[Union[int, device]] = None) → T¶

将所有模型参数和缓冲区移至 MTIA。

这也会使相关的参数和缓冲区成为不同的对象。因此，如果模块在优化时位于 MTIA 上，应在构建优化器之前调用此方法。

注意

此方法会原地修改模块。

参数:: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回值:: 自身
返回类型:: Module

named_buffers(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) → Iterator[Tuple[str, Tensor]]¶

返回一个模块缓冲区上的迭代器，每次产出缓冲区的名称及其自身。

参数:

prefix (str) – 要添加到所有缓冲区名称前的字符串。
recurse (bool, optional) – 如果为 True，则产出当前模块及其所有子模块的缓冲区。否则，只产出当前模块的直接成员缓冲区。默认为 True。
remove_duplicate (bool, optional) – 是否移除结果中的重复缓冲区。默认为 True。

生成值:

(str, torch.Tensor) – 包含名称和缓冲区的元组。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())

named_children() → Iterator[Tuple[str, Module]]¶

返回一个直接子模块上的迭代器，每次产出模块的名称及其自身。

生成值:: (str, Module) – 包含名称和子模块的元组。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, module in model.named_children():
>>>     if name in ['conv4', 'conv5']:
>>>         print(module)

named_modules(memo: Optional[Set[Module]] = None, prefix: str = '', remove_duplicate: bool = True)¶

返回网络中所有模块上的迭代器，每次产出模块的名称及其自身。

参数:

memo – 一个备忘录，用于存储已添加到结果中的模块集合。
prefix – 将添加到模块名称前的字符串。
remove_duplicate – 是否移除结果中的重复模块实例。

生成值:

(str, Module) – 包含名称和模块的元组。

注意

重复模块仅返回一次。在以下示例中，l 只返回一次。

示例

>>> l = nn.Linear(2, 2)
>>> net = nn.Sequential(l, l)
>>> for idx, m in enumerate(net.named_modules()):
...     print(idx, '->', m)

0 -> ('', Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
))
1 -> ('0', Linear(in_features=2, out_features=2, bias=True))

named_parameters(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) → Iterator[Tuple[str, Parameter]]¶

返回一个模块参数上的迭代器，每次产出参数的名称及其自身。

参数:

prefix (str) – 要添加到所有参数名称前的字符串。
recurse (bool) – 如果为 True，则产出当前模块及其所有子模块的参数。否则，只产出当前模块的直接成员参数。
remove_duplicate (bool, optional) – 是否移除结果中的重复参数。默认为 True。

生成值:

(str, Parameter) – 包含名称和参数的元组。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())

property observation_keys: list[tensordict._nestedkey.NestedKey]¶

环境的观测键。

默认情况下，只有一个名为“observation”的键。

键按数据树中的深度排序。

property observation_spec: Composite¶

观测规范。

必须是 torchrl.data.Composite 实例。规范中列出的键在 reset 和 step 后可直接访问。

在 TorchRL 中，即使它们严格来说不是“观测”，环境输出的所有 info、state、transform 结果等都存储在 observation_spec 中。

因此，"observation_spec" 应被视为环境输出的通用数据容器，不包括 done 或 reward 数据。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.observation_spec
Composite(
    observation: BoundedContinuous(
        shape=torch.Size([3]),
        space=ContinuousBox(
            low=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True),
            high=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True)),
        device=cpu,
        dtype=torch.float32,
        domain=continuous), device=cpu, shape=torch.Size([]))

property observation_spec_unbatched: Composite¶: 返回环境的观察规范，如同它没有批量维度一样。

property output_spec: TensorSpec¶

输出规范。

包含环境输出的所有数据规范的组合规范。

它包含

“full_reward_spec”: 奖励的规范
“full_done_spec”: 终止状态 (done) 的规范
“full_observation_spec”: 所有其他环境输出的规范

此属性被锁定且应为只读。若要设置其中包含的规范，应使用相应的属性。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.output_spec
Composite(
    full_reward_spec: Composite(
        reward: UnboundedContinuous(
            shape=torch.Size([1]),
            space=None,
            device=cpu,
            dtype=torch.float32,
            domain=continuous), device=cpu, shape=torch.Size([])),
    full_observation_spec: Composite(
        observation: BoundedContinuous(
            shape=torch.Size([3]),
            space=ContinuousBox(
                low=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True),
                high=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True)),
            device=cpu,
            dtype=torch.float32,
            domain=continuous), device=cpu, shape=torch.Size([])),
    full_done_spec: Composite(
        done: Categorical(
            shape=torch.Size([1]),
            space=DiscreteBox(n=2),
            device=cpu,
            dtype=torch.bool,
            domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

property output_spec_unbatched: Composite¶: 返回环境的输出规范，就像它没有批次维度一样。

parameters(recurse: bool = True) → Iterator[Parameter]¶

返回一个模块参数上的迭代器。

这通常传递给优化器。

参数:: recurse (bool) – 如果为 True，则产出当前模块及其所有子模块的参数。否则，只产出当前模块的直接成员参数。
生成值:: Parameter – 模块参数。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for param in model.parameters():
>>>     print(type(param), param.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

rand_action(tensordict: TensorDictBase | None = None)[source]¶

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

参数:: tensordict (TensorDictBase, optional) – 结果动作应写入的 tensordict。
返回值:: 一个 tensordict 对象，其“action”条目已使用 action-spec 的随机采样进行更新。

rand_step(tensordict: TensorDictBase | None = None) → TensorDictBase[source]¶

根据 action_spec 属性在环境中执行随机步进。

参数:: tensordict (TensorDictBase, optional) – 结果信息应写入的 tensordict。
返回值:: 一个 tensordict 对象，其中包含在环境中随机步进后的新观测。动作将存储在“action”键下。

register_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor], Union[None, Tuple[Tensor, ...], Tensor]]) → RemovableHandle¶

在模块上注册一个反向钩子。

此函数已弃用，推荐使用 register_full_backward_hook()。此函数的行为将在未来版本中更改。

返回值:: 一个可用于通过调用 handle.remove() 移除所添加钩子的句柄。
返回类型:: torch.utils.hooks.RemovableHandle

register_buffer(name: str, tensor: Optional[Tensor], persistent: bool = True) → None¶

向模块添加一个缓冲区。

这通常用于注册不应被视为模型参数的缓冲区。例如，BatchNorm 的 running_mean 不是参数，但它是模块状态的一部分。缓冲区默认是持久的，并将与参数一起保存。通过将 persistent 设置为 False 可以改变此行为。持久缓冲区和非持久缓冲区之间的唯一区别在于，后者不会是当前模块的 state_dict 的一部分。

缓冲区可以使用给定的名称作为属性进行访问。

参数:

name (str) – 缓冲区的名称。可以使用给定的名称从该模块访问缓冲区。
tensor (Tensor 或 None) – 要注册的缓冲区。如果为 None，则对缓冲区执行的操作（如 cuda）将被忽略。如果为 None，则缓冲区将**不**包含在模块的 state_dict 中。
persistent (bool) – 缓冲区是否是当前模块的 state_dict 的一部分。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> self.register_buffer('running_mean', torch.zeros(num_features))

register_forward_hook(hook: Union[Callable[[T, Tuple[Any, ...], Any], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any], Any], Optional[Any]]], *, prepend: bool = False, with_kwargs: bool = False, always_call: bool = False) → RemovableHandle¶

在模块上注册一个前向钩子。

在 forward() 计算出输出后，每次都会调用该钩子。

如果 with_kwargs 为 False 或未指定，输入只包含传递给模块的位置参数。关键字参数不会传递给钩子，只会传递给 forward。钩子可以修改输出。它可以就地修改输入，但由于此钩子是在 forward() 调用后调用的，因此对 forward 没有影响。钩子应具有以下签名：

hook(module, args, output) -> None or modified output

如果 with_kwargs 为 True，前向钩子将接收传递给 forward 函数的 kwargs，并应返回可能修改后的输出。钩子应具有以下签名：

hook(module, args, kwargs, output) -> None or modified output

参数:

hook (Callable) – 要注册的用户定义钩子。
prepend (bool) – 如果为 True，则提供的 hook 将在此 torch.nn.modules.Module 上所有现有 forward 钩子之前被触发。否则，提供的 hook 将在所有现有 forward 钩子之后被触发。注意，通过 register_module_forward_hook() 注册的全局 forward 钩子将在通过此方法注册的所有钩子之前被触发。默认值：False
with_kwargs (bool) – 如果为 True，钩子将接收传递给 forward 函数的 kwargs。默认值：False
always_call (bool) – 如果为 True，无论调用模块时是否引发异常，都会运行钩子。默认值：False

返回值:

一个可用于通过调用 handle.remove() 移除所添加钩子的句柄。

返回类型:

torch.utils.hooks.RemovableHandle

register_forward_pre_hook(hook: Union[Callable[[T, Tuple[Any, ...]], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any]], Optional[Tuple[Any, Dict[str, Any]]]]], *, prepend: bool = False, with_kwargs: bool = False) → RemovableHandle¶

在模块上注册一个前向预钩子。

在 forward() 调用前，每次都会调用该钩子。

如果 with_kwargs 为 false 或未指定，输入只包含传递给模块的位置参数。关键字参数不会传递给钩子，只会传递给 forward。钩子可以修改输入。用户可以在钩子中返回一个元组或一个修改后的单一值。如果返回单一值（除非该值本身就是一个元组），我们会将其包装成一个元组。钩子应具有以下签名：

hook(module, args) -> None or modified input

如果 with_kwargs 为 true，前向预钩子将接收传递给 forward 函数的 kwargs。如果钩子修改了输入，则应同时返回 args 和 kwargs。钩子应具有以下签名：

hook(module, args, kwargs) -> None or a tuple of modified input and kwargs

参数:

hook (Callable) – 要注册的用户定义钩子。
prepend (布尔值) – 如果为 True，提供的 hook 将在该 torch.nn.modules.Module 上所有现有的 forward_pre hook 之前触发。否则，提供的 hook 将在该 torch.nn.modules.Module 上所有现有的 forward_pre hook 之后触发。注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (布尔值) – 如果为 True，提供的 hook 将会收到传递给 forward 函数的关键字参数 (kwargs)。默认值: False

返回值:

一个可用于通过调用 handle.remove() 移除所添加钩子的句柄。

返回类型:

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) → RemovableHandle¶

在模块上注册一个反向钩子。

每当计算模块的梯度时，就会调用该 hook，也就是说，仅当计算模块输出的梯度时，该 hook 才会执行。hook 应具有以下签名

hook(module, grad_input, grad_output) -> tuple(Tensor) or None

grad_input 和 grad_output 是元组，分别包含相对于输入和输出的梯度。hook 不应修改其参数，但它可以选择性地返回一个相对于输入的新梯度，该梯度将在后续计算中用来替代 grad_input。grad_input 将仅对应于作为位置参数给定的输入，所有关键字参数 (kwarg arguments) 都将被忽略。grad_input 和 grad_output 中的非 Tensor 参数条目将为 None。

出于技术原因，当此 hook 应用于模块时，其 forward 函数将接收传递给该模块的每个 Tensor 的视图 (view)。同样，调用方将接收该模块 forward 函数返回的每个 Tensor 的视图 (view)。

警告

使用 backward hook 时不允许原地修改输入或输出，否则会引发错误。

参数:

hook (可调用对象) – 要注册的用户定义 hook。
prepend (布尔值) – 如果为 True，提供的 hook 将在该 torch.nn.modules.Module 上所有现有的 backward hook 之前触发。否则，提供的 hook 将在该 torch.nn.modules.Module 上所有现有的 backward hook 之后触发。注意，使用 register_module_full_backward_hook() 注册的全局 backward hook 将在此方法注册的所有 hook 之前触发。

返回值:

一个可用于通过调用 handle.remove() 移除所添加钩子的句柄。

返回类型:

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) → RemovableHandle¶

在模块上注册一个 backward pre-hook。

每当计算模块的梯度时，就会调用该 hook。hook 应具有以下签名

hook(module, grad_output) -> tuple[Tensor] or None

grad_output 是一个元组。hook 不应修改其参数，但它可以选择性地返回一个相对于输出的新梯度，该梯度将在后续计算中用来替代 grad_output。grad_output 中的非 Tensor 参数条目将为 None。

出于技术原因，当此 hook 应用于模块时，其 forward 函数将接收传递给该模块的每个 Tensor 的视图 (view)。同样，调用方将接收该模块 forward 函数返回的每个 Tensor 的视图 (view)。

警告

使用 backward hook 时不允许原地修改输入，否则会引发错误。

参数:

hook (可调用对象) – 要注册的用户定义 hook。
prepend (布尔值) – 如果为 True，提供的 hook 将在该 torch.nn.modules.Module 上所有现有的 backward_pre hook 之前触发。否则，提供的 hook 将在该 torch.nn.modules.Module 上所有现有的 backward_pre hook 之后触发。注意，使用 register_module_full_backward_pre_hook() 注册的全局 backward_pre hook 将在此方法注册的所有 hook 之前触发。

返回值:

一个可用于通过调用 handle.remove() 移除所添加钩子的句柄。

返回类型:

torch.utils.hooks.RemovableHandle

classmethod register_gym(id: str, *, entry_point: Callable | None = None, transform: Transform | None = None, info_keys: list[NestedKey] | None = None, backend: str = None, to_numpy: bool = False, reward_threshold: float | None = None, nondeterministic: bool = False, max_episode_steps: int | None = None, order_enforce: bool = True, autoreset: bool = False, disable_env_checker: bool = False, apply_api_compatibility: bool = False, **kwargs)[源代码]¶

在 gym(nasium) 中注册一个环境。

此方法的设计考虑了以下目的：

将一个 TorchRL 优先的环境集成到使用 Gym 的框架中；
将其他环境（例如 DeepMind Control, Brax, Jumanji 等）集成到使用 Gym 的框架中。

参数:

id (字符串) – 环境的名称。应遵循 gym 命名规范。

关键字参数:

entry_point (可调用对象, 可选) –

用于构建环境的入口点。如果未传递，则使用父类作为入口点。通常用于注册一个不一定继承自当前所用基类的环境

>>> from torchrl.envs import DMControlEnv
>>> DMControlEnv.register_gym("DMC-cheetah-v0", env_name="cheetah", task="run")
>>> # equivalently
>>> EnvBase.register_gym("DMC-cheetah-v0", entry_point=DMControlEnv, env_name="cheetah", task="run")

transform (torchrl.envs.Transform) – 与环境一起使用的变换（或 torchrl.envs.Compose 实例中的变换列表）。此参数可在调用 make() 时传递（参见下方示例）。
info_keys (NestedKey 列表, 可选) –
如果提供，这些键将用于构建 info 字典，并将从观察键 (observation keys) 中排除。此参数可在调用 make() 时传递（参见下方示例）。

警告

使用 info_keys 可能会导致规范 (spec) 变为空，因为内容已移至 info 字典。Gym 不喜欢规范中的空 Dict，因此应使用 RemoveEmptySpecs 移除此空内容。
backend (字符串, 可选) – 后端。可以是 “gym” 或 “gymnasium”，或任何其他与 set_gym_backend 兼容的后端。
to_numpy (布尔值, 可选) – 如果为 True，调用 step 和 reset 的结果将映射到 numpy 数组。默认值: False (结果是 Tensor)。此参数可在调用 make() 时传递（参见下方示例）。
reward_threshold (浮点数, optional) – [Gym 关键字参数] 被认为是学到某个环境的奖励阈值。
nondeterministic (布尔值, 可选) – [Gym 关键字参数] 如果环境是非确定性的（即使已知初始种子和所有动作）。默认值: False。
max_episode_steps (整数, 可选) – [Gym 关键字参数] 截断前的最大回合步数。由 Time Limit 包装器使用。
order_enforce (布尔值, 可选) – [Gym >= 0.14] 是否应应用 order enforcer 包装器以确保用户按正确顺序运行函数。默认值: True。
autoreset (布尔值, 可选) – [Gym >= 0.14] 是否应添加 autoreset 包装器，以便无需调用 reset。默认值: False。
disable_env_checker – [Gym >= 0.14] 是否应为环境禁用环境检查器。默认值: False。
apply_api_compatibility – [Gym >= 0.26] 是否应用 StepAPICompatibility 包装器。默认值: False。
**kwargs – 传递给环境构造函数的任意关键字参数。

注意

TorchRL 的环境没有“info”字典的概念，因为 TensorDict 在大多数训练设置中提供了所有必要的存储需求。但是，您可以使用 info_keys 参数来精细控制哪些内容应被视为观察 (observation)，哪些内容应被视为信息 (info)。

示例

>>> # Register the "cheetah" env from DMControl with the "run" task
>>> from torchrl.envs import DMControlEnv
>>> import torch
>>> DMControlEnv.register_gym("DMC-cheetah-v0", to_numpy=False, backend="gym", env_name="cheetah", task_name="run")
>>> import gym
>>> envgym = gym.make("DMC-cheetah-v0")
>>> envgym.seed(0)
>>> torch.manual_seed(0)
>>> envgym.reset()
({'position': tensor([-0.0855,  0.0215, -0.0881, -0.0412, -0.1101,  0.0080,  0.0254,  0.0424],
       dtype=torch.float64), 'velocity': tensor([ 1.9609e-02, -1.9776e-04, -1.6347e-03,  3.3842e-02,  2.5338e-02,
         3.3064e-02,  1.0381e-04,  7.6656e-05,  1.0204e-02],
       dtype=torch.float64)}, {})
>>> envgym.step(envgym.action_space.sample())
({'position': tensor([-0.0833,  0.0275, -0.0612, -0.0770, -0.1256,  0.0082,  0.0186,  0.0476],
       dtype=torch.float64), 'velocity': tensor([ 0.2221,  0.2256,  0.5930,  2.6937, -3.5865, -1.5479,  0.0187, -0.6825,
         0.5224], dtype=torch.float64)}, tensor([0.0018], dtype=torch.float64), tensor([False]), tensor([False]), {})
>>> # same environment with observation stacked
>>> from torchrl.envs import CatTensors
>>> envgym = gym.make("DMC-cheetah-v0", transform=CatTensors(in_keys=["position", "velocity"], out_key="observation"))
>>> envgym.reset()
({'observation': tensor([-0.1005,  0.0335, -0.0268,  0.0133, -0.0627,  0.0074, -0.0488, -0.0353,
        -0.0075, -0.0069,  0.0098, -0.0058,  0.0033, -0.0157, -0.0004, -0.0381,
        -0.0452], dtype=torch.float64)}, {})
>>> # same environment with numpy observations
>>> envgym = gym.make("DMC-cheetah-v0", transform=CatTensors(in_keys=["position", "velocity"], out_key="observation"), to_numpy=True)
>>> envgym.reset()
({'observation': array([-0.11355747,  0.04257728,  0.00408397,  0.04155852, -0.0389733 ,
       -0.01409826, -0.0978704 , -0.08808327,  0.03970837,  0.00535434,
       -0.02353762,  0.05116226,  0.02788907,  0.06848346,  0.05154399,
        0.0371798 ,  0.05128025])}, {})
>>> # If gymnasium is installed, we can register the environment there too.
>>> DMControlEnv.register_gym("DMC-cheetah-v0", to_numpy=False, backend="gymnasium", env_name="cheetah", task_name="run")
>>> import gymnasium
>>> envgym = gymnasium.make("DMC-cheetah-v0")
>>> envgym.seed(0)
>>> torch.manual_seed(0)
>>> envgym.reset()
({'position': tensor([-0.0855,  0.0215, -0.0881, -0.0412, -0.1101,  0.0080,  0.0254,  0.0424],
       dtype=torch.float64), 'velocity': tensor([ 1.9609e-02, -1.9776e-04, -1.6347e-03,  3.3842e-02,  2.5338e-02,
         3.3064e-02,  1.0381e-04,  7.6656e-05,  1.0204e-02],
       dtype=torch.float64)}, {})

注意

此功能也适用于无状态环境（例如，BraxEnv）。

>>> import gymnasium
>>> import torch
>>> from tensordict import TensorDict
>>> from torchrl.envs import BraxEnv, SelectTransform
>>>
>>> # get action for dydactic purposes
>>> env = BraxEnv("ant", batch_size=[2])
>>> env.set_seed(0)
>>> torch.manual_seed(0)
>>> td = env.rollout(10)
>>>
>>> actions = td.get("action")
>>>
>>> # register env
>>> env.register_gym("Brax-Ant-v0", env_name="ant", batch_size=[2], info_keys=["state"])
>>> gym_env = gymnasium.make("Brax-Ant-v0")
>>> gym_env.seed(0)
>>> torch.manual_seed(0)
>>>
>>> gym_env.reset()
>>> obs = []
>>> for i in range(10):
...     obs, reward, terminated, truncated, info = gym_env.step(td[..., i].get("action"))

register_load_state_dict_post_hook(hook)¶

注册一个 post-hook，在调用模块的 load_state_dict() 后运行。

它应具有以下签名：: hook(module, incompatible_keys) -> None

module 参数是注册此 hook 的当前模块，而 incompatible_keys 参数是一个 NamedTuple，包含 missing_keys 和 unexpected_keys 属性。missing_keys 是一个包含缺失键的 list（字符串列表），而 unexpected_keys 是一个包含意外键的 list（字符串列表）。

如果需要，可以原地修改给定的 incompatible_keys。

注意，在调用 load_state_dict() 时设置 strict=True 所执行的检查会受到 hook 对 missing_keys 或 unexpected_keys 所做修改的影响，这符合预期。向任何一组键中添加内容都将在 strict=True 时引发错误，清除所有缺失和意外键将避免错误。

返回值:: 一个可用于通过调用 handle.remove() 移除所添加钩子的句柄。
返回类型:: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)¶

注册一个 pre-hook，在调用模块的 load_state_dict() 之前运行。

它应具有以下签名：: hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950

参数:: hook (可调用对象) – 在加载状态字典之前将被调用的可调用 hook。

register_module(name: str, module: Optional[Module]) → None¶: 是 add_module() 的别名。

register_parameter(name: str, param: Optional[Parameter]) → None¶

向模块添加一个参数。

可以使用给定名称作为属性来访问该参数。

参数:

name (字符串) – 参数的名称。可以使用给定名称从该模块访问该参数
param (Parameter 或 None) – 要添加到模块的参数。如果为 None，则对参数执行的操作（例如 cuda）将被忽略。如果为 None，该参数将不包含在模块的 state_dict 中。

register_state_dict_post_hook(hook)¶

为 state_dict() 方法注册一个 post-hook。

它应具有以下签名：: hook(module, state_dict, prefix, local_metadata) -> None

注册的 hook 可以原地修改 state_dict。

register_state_dict_pre_hook(hook)¶

为 state_dict() 方法注册一个 pre-hook。

它应具有以下签名：: hook(module, prefix, keep_vars) -> None

注册的 hook 可用于在调用 state_dict 之前执行预处理。

requires_grad_(requires_grad: bool = True) → T¶

更改 Autograd 是否应对该模块中的参数记录操作。

此方法原地设置参数的 requires_grad 属性。

此方法有助于冻结模块的一部分进行微调，或单独训练模型的各个部分（例如，GAN 训练）。

参见局部禁用梯度计算以比较 .requires_grad_() 与几种可能与之混淆的类似机制。

参数:: requires_grad (布尔值) – Autograd 是否应对该模块中的参数记录操作。默认值: True。
返回值:: 自身
返回类型:: Module

reset(tensordict: TensorDictBase | None = None, **kwargs) → TensorDictBase[源代码]¶

重置环境。

与 step 和 _step 类似，只有私有方法 _reset 应由 EnvBase 子类覆盖。

参数:

tensordict (TensorDictBase, 可选) – 用于包含重置后新观察结果的 tensordict。在某些情况下，此输入也可用于向 reset 函数传递参数。
kwargs (可选) – 传递给原生 reset 函数的其他参数。

返回值:

一个 tensordict（如果提供了输入 tensordict，则为该 tensordict），在原地用重置后的观察结果进行修改。

注意

reset 不应被 EnvBase 子类覆盖。应修改的方法是 _reset()。

property reset_keys: list[tensordict._nestedkey.NestedKey]¶

返回 reset 键的列表。

Reset 键是表示部分重置的键，在批处理、多任务或多智能体设置中。它们的结构是 (*prefix, "_reset")，其中 prefix 是一个（可能为空的）字符串元组，指向 tensordict 中可以找到 done 状态的位置。

键按数据树中的深度排序。

property reward_key¶

环境的奖励键。

默认情况下，这将是 “reward”。

如果环境中存在多个奖励键，此函数将引发异常。

property reward_keys: list[tensordict._nestedkey.NestedKey]¶

环境的奖励键列表。

默认情况下，只有一个名为 “reward” 的键。

键按数据树中的深度排序。

property reward_spec: TensorSpec¶

reward 规范。

reward_spec 总是存储为一个复合规范 (composite spec)。

如果奖励规范以简单规范 (simple spec) 的形式提供，则返回此规范。

>>> env.reward_spec = Unbounded(1)
>>> env.reward_spec
UnboundedContinuous(
    shape=torch.Size([1]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

如果奖励规范以复合规范 (composite spec) 的形式提供且只包含一个叶子 (leaf)，此函数将只返回该叶子。

>>> env.reward_spec = Composite({"nested": {"reward": Unbounded(1)}})
>>> env.reward_spec
UnboundedContinuous(
    shape=torch.Size([1]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

如果奖励规范以复合规范 (composite spec) 的形式提供且包含多个叶子 (leaf)，此函数将返回整个规范。

>>> env.reward_spec = Composite({"nested": {"reward": Unbounded(1), "another_reward": Categorical(1)}})
>>> env.reward_spec
Composite(
    nested: Composite(
        reward: UnboundedContinuous(
            shape=torch.Size([1]),
            space=ContinuousBox(
                low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
                high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
            device=cpu,
            dtype=torch.float32,
            domain=continuous),
        another_reward: Categorical(
            shape=torch.Size([]),
            space=DiscreteBox(n=1),
            device=cpu,
            dtype=torch.int64,
            domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

要检索传递的完整规范，请使用

>>> env.output_spec["full_reward_spec"]

此属性是可变的。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.reward_spec
UnboundedContinuous(
    shape=torch.Size([1]),
    space=None,
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

property reward_spec_unbatched: TensorSpec¶: 返回环境的奖励规范，如同它没有批量维度一样。

rollout(max_steps: int, policy: Callable[[TensorDictBase], TensorDictBase] | None = None, callback: Callable[[TensorDictBase, ...], Any] | None = None, *, auto_reset: bool = True, auto_cast_to_device: bool = False, break_when_any_done: bool | None = None, break_when_all_done: bool | None = None, return_contiguous: bool | None = False, tensordict: TensorDictBase | None = None, set_truncated: bool = False, out=None, trust_policy: bool = False) → TensorDictBase[source]¶

在环境中执行一次 Rollout。

一旦任何包含的环境达到任何终止状态，该函数将立即返回。

参数:

max_steps (int) – 要执行的最大步数。如果在达到 max_steps 之前环境达到终止状态，则实际步数可能更少。
policy (callable, optional) – 用于计算所需动作的可调用对象。如果未提供策略，则使用 env.rand_step() 调用动作。策略可以是任何读取 tensordict 或整个观测条目序列的可调用对象，这些条目按__ env.observation_spec.keys() 排序。默认为 None。
callback (Callable[[TensorDict], Any], optional) – 在每次迭代中与给定 TensorDict 一起调用的函数。默认为 None。callback 的输出将不会被收集，用户有责任在 callback 调用中保存任何结果，如果数据需要在 rollout 调用之后继续使用的话。

关键字参数:

auto_reset (bool, optional) – 如果为 True，则在开始 Rollout 之前将重置包含的环境。如果为 False，则 Rollout 将从之前的状态继续，这需要传递带有之前 Rollout 结果的 tensordict 参数。默认值为 True。
auto_cast_to_device (bool, optional) – 如果为 True，则在使用策略之前，tensordict 的设备会自动转换为策略设备。默认值为 False。
break_when_any_done (bool) – 如果为 True，则当任何包含的环境达到任何终止状态时中断。如果为 False，则终止的环境会自动重置。默认值为 True。
break_when_all_done (bool, optional) – 如果为 True，则当所有包含的环境都达到任何终止状态时中断。如果为 False，则当至少一个环境达到任何终止状态时中断。默认值为 False。
return_contiguous (bool) – 如果为 False，则返回一个 LazyStackedTensorDict。如果环境没有动态规范，则默认值为 True，否则为 False。
tensordict (TensorDict, optional) – 如果 auto_reset 为 False，必须提供一个初始 tensordict。Rollout 将检查此 tensordict 是否包含终止标志，并在这些维度（如果需要）重置环境。如果 tensordict 是重置的输出，这通常不会发生，但如果 tensordict 是先前 Rollout 的最后一步，则可能发生。如果需要向 reset 方法传递元数据（例如无状态环境的批次大小或设备），则在 auto_reset=True 时也可以提供一个 tensordict。
set_truncated (bool, optional) – 如果为 True，Rollout 完成后，"truncated" 和 "done" 键将设置为 True。如果在 done_spec 中找不到 "truncated"，则会引发异常。可以通过 env.add_truncated_keys 设置截断键。默认值为 False。
trust_policy (bool, optional) – 如果为 True，则信任非 TensorDictModule 策略与收集器兼容。CudaGraphModules 默认为 True，否则默认为 False。

返回值:

包含结果轨迹的 TensorDict 对象。

返回的数据将在 tensordict 的最后一个维度（在 env.ndim 索引处）标记一个 “time” 维度名称。

rollout 对于显示环境的数据结构是什么样子非常方便。

示例

>>> # Using rollout without a policy
>>> from torchrl.envs.libs.gym import GymEnv
>>> from torchrl.envs.transforms import TransformedEnv, StepCounter
>>> env = TransformedEnv(GymEnv("Pendulum-v1"), StepCounter(max_steps=20))
>>> rollout = env.rollout(max_steps=1000)
>>> print(rollout)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.float32, is_shared=False),
        done: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([20, 3]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                step_count: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.int64, is_shared=False),
                truncated: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([20]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([20, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        step_count: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.int64, is_shared=False),
        truncated: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([20]),
    device=cpu,
    is_shared=False)
>>> print(rollout.names)
['time']
>>> # with envs that contain more dimensions
>>> from torchrl.envs import SerialEnv
>>> env = SerialEnv(3, lambda: TransformedEnv(GymEnv("Pendulum-v1"), StepCounter(max_steps=20)))
>>> rollout = env.rollout(max_steps=1000)
>>> print(rollout)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.float32, is_shared=False),
        done: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([3, 20, 3]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                step_count: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.int64, is_shared=False),
                truncated: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([3, 20]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([3, 20, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        step_count: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.int64, is_shared=False),
        truncated: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([3, 20]),
    device=cpu,
    is_shared=False)
>>> print(rollout.names)
[None, 'time']

使用策略（可以是常规的 Module 或 TensorDictModule）也很容易

示例

>>> from torch import nn
>>> env = GymEnv("CartPole-v1", categorical_action_encoding=True)
>>> class ArgMaxModule(nn.Module):
...     def forward(self, values):
...         return values.argmax(-1)
>>> n_obs = env.observation_spec["observation"].shape[-1]
>>> n_act = env.action_spec.n
>>> # A deterministic policy
>>> policy = nn.Sequential(
...     nn.Linear(n_obs, n_act),
...     ArgMaxModule())
>>> env.rollout(max_steps=10, policy=policy)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.int64, is_shared=False),
        done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([10]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([10]),
    device=cpu,
    is_shared=False)
>>> # Under the hood, rollout will wrap the policy in a TensorDictModule
>>> # To speed things up we can do that ourselves
>>> from tensordict.nn import TensorDictModule
>>> policy = TensorDictModule(policy, in_keys=list(env.observation_spec.keys()), out_keys=["action"])
>>> env.rollout(max_steps=10, policy=policy)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.int64, is_shared=False),
        done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([10]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([10]),
    device=cpu,
    is_shared=False)

在某些情况下，无法获得连续的 tensordict，因为它们无法堆叠。当每一步返回的数据形状可能不同，或者同时执行不同的环境时，可能会发生这种情况。在这种情况下，return_contiguous=False 将导致返回的 tensordict 是一个 tensordict 的惰性堆叠 (lazy stack)。

非连续 Rollout 的示例

>>> rollout = env.rollout(4, return_contiguous=False)
>>> print(rollout)
LazyStackedTensorDict(
    fields={
        action: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.float32, is_shared=False),
        done: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: LazyStackedTensorDict(
            fields={
                done: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([3, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                step_count: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.int64, is_shared=False),
                truncated: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([3, 4]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([3, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        step_count: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.int64, is_shared=False),
        truncated: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([3, 4]),
    device=cpu,
    is_shared=False)
    >>> print(rollout.names)
    [None, 'time']

Rollout 可以在循环中使用，以模拟数据收集。为此，您需要将上一次 Rollout 调用 step_mdp() 后得到的最后一个 tensordict 作为输入传递。

数据收集 Rollout 的示例

>>> from torchrl.envs import GymEnv, step_mdp
>>> env = GymEnv("CartPole-v1")
>>> epochs = 10
>>> input_td = env.reset()
>>> for i in range(epochs):
...     rollout_td = env.rollout(
...         max_steps=100,
...         break_when_any_done=False,
...         auto_reset=False,
...         tensordict=input_td,
...     )
...     input_td = step_mdp(
...         rollout_td[..., -1],
...     )

set_extra_state(state: Any) → None¶

设置加载的 state_dict 中包含的额外状态。

此函数从 load_state_dict() 调用，以处理 state_dict 中找到的任何额外状态。如果您需要将额外状态存储在其 state_dict 中，请为您的模块实现此函数和相应的 get_extra_state()。

参数:: state (dict) – 来自 state_dict 的额外状态

set_seed(seed: int | None = None, static_seed: bool =False) → int | None[source]¶

设置环境的种子，并返回下一个要使用的种子（如果只存在一个环境，则为输入的种子）。

参数:

seed (int) – 要设置的种子。种子只在环境本地设置。要处理全局种子，请参见 manual_seed()。
static_seed (bool, optional) – 如果为 True，则种子不会递增。默认为 False

返回值:

即，如果同时创建另一个环境，应该使用该种子。

返回类型:

表示“下一个种子”的整数

set_spec_lock_(mode: bool = True) → EnvBase[source]¶

锁定或解锁环境的规范。

参数:: mode (bool) – 是否锁定 (True) 或解锁 (False) 规范。默认为 True。
返回值:: 环境实例本身。
返回类型:: EnvBase

另请参阅

锁定环境规范.

set_submodule(target: str, module: Module) → None¶

设置由 target 指定的子模块（如果存在），否则抛出错误。

例如，假设您有一个 nn.Module A，其结构如下

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
        )
        (linear): Linear(in_features=100, out_features=200, bias=True)
    )
)

(图中显示了一个 nn.Module A。A 有一个嵌套子模块 net_b，其本身又有两个子模块 net_c 和 linear。net_c 然后有一个子模块 conv。)

要用一个新的子模块 Linear 替换 Conv2d，您可以调用 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

参数:

target – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参见上面的示例。）
module – 要设置子模块的模块。

抛出:

ValueError – 如果 target 字符串为空
AttributeError – 如果 target 字符串引用了无效路径或解析到的不是 nn.Module

property shape¶: 等价于 batch_size。

share_memory() → T¶: 参见 torch.Tensor.share_memory_()。

property specs: Composite¶

返回一个包含所有环境的 Composite 容器。

此功能允许创建环境，在一个数据容器中检索所有规范，然后从工作空间中擦除环境。

state_dict(*args, destination=None, prefix='', keep_vars=False)¶

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

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

注意

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

警告

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

警告

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

参数:

destination (dict, optional) – 如果提供，模块的状态将更新到此字典中并返回同一对象。否则，将创建一个 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']

property state_keys: list[tensordict._nestedkey.NestedKey]¶

环境的状态键列表。

默认情况下，只有一个名为 “state” 的键。

键按数据树中的深度排序。

property state_spec: Composite¶

状态规范。

必须是 torchrl.data.Composite 实例。此处列出的键应与动作一起作为输入提供给环境。

在 TorchRL 中，即使它们并非严格意义上的“状态”，所有不属于动作的环境输入都存储在 state_spec 中。

因此，"state_spec" 应被视为一个通用的数据容器，用于存储不属于动作数据的环境输入。

示例

>>> from torchrl.envs import BraxEnv
>>> for envname in BraxEnv.available_envs:
...     break
>>> env = BraxEnv(envname)
>>> env.state_spec
Composite(
    state: Composite(
        pipeline_state: Composite(
            q: UnboundedContinuous(
                shape=torch.Size([15]),
                space=None,
                device=cpu,
                dtype=torch.float32,
                domain=continuous),
    [...], device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

property state_spec_unbatched: TensorSpec¶: 返回环境的状态规范，如同它没有批量维度一样。

step(tensordict: TensorDictBase) → TensorDictBase[source]¶

在环境中执行一步。

Step 方法接受一个参数 tensordict，它通常包含一个 ‘action’ 键，指示要执行的动作。Step 将调用一个非原地 (out-place) 私有方法 _step，这是 EnvBase 子类需要重写的方法。

参数:: tensordict (TensorDictBase) – 包含要执行的动作的 Tensordict。如果输入的 tensordict 包含一个 "next" 条目，则其中包含的值将优先于新计算的值。这提供了一种覆盖底层计算的机制。
返回值:: 输入的 tensordict，原地修改以包含结果观测、终止状态和奖励（+如果需要则包含其他信息）。

step_and_maybe_reset(tensordict: TensorDictBase) → tuple[tensordict.base.TensorDictBase, tensordict.base.TensorDictBase][source]¶

在环境中执行一步，并（部分）重置环境（如果需要）。

参数:: tensordict (TensorDictBase) – step() 方法的输入数据结构。

此方法允许轻松编写非停止的 Rollout 函数。

示例

>>> from torchrl.envs import ParallelEnv, GymEnv
>>> def rollout(env, n):
...     data_ = env.reset()
...     result = []
...     for i in range(n):
...         data, data_ = env.step_and_maybe_reset(data_)
...         result.append(data)
...     return torch.stack(result)
>>> env = ParallelEnv(2, lambda: GymEnv("CartPole-v1"))
>>> print(rollout(env, 2))
TensorDict(
    fields={
        done: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([2, 2, 4]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                terminated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                truncated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([2, 2]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([2, 2, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        terminated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        truncated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([2, 2]),
    device=cpu,
    is_shared=False)

step_mdp(next_tensordict: TensorDictBase) → TensorDictBase[source]¶

使用提供的 next_tensordict 将环境状态向前推进一步。

此方法通过从当前状态转换为下一个状态来更新环境的状态，如 next_tensordict 所定义。结果 tensordict 包含更新后的观测以及任何其他相关状态信息，键根据环境规范进行管理。

在内部，此方法利用预计算的 _StepMDP 实例来高效处理状态、观测、动作、奖励和终止键的转换。_StepMDP 类通过预计算要包含和排除的键来优化过程，减少重复调用期间的运行时开销。_StepMDP 实例使用 `exclude_action=False` 创建，这意味着动作键保留在根 tensordict 中。

参数:: next_tensordict (TensorDictBase) – 包含环境在下一个时间步的状态的 tensordict。此 tensordict 应包含观测、动作、奖励和终止标志的键，如环境规范所定义。
返回值:: 表示环境状态向前推进一步后的新 tensordict。
返回类型:: TensorDictBase

注意

此方法确保环境的键规范对照提供的 next_tensordict 进行验证，如果发现差异则发出警告。

注意

此方法旨在与具有一致键规范的环境高效协作，利用 _StepMDP 类最小化开销。

示例

>>> from torchrl.envs import GymEnv
>>> env = GymEnv("Pendulum-1")
>>> data = env.reset()
>>> for i in range(10):
...     # compute action
...     env.rand_action(data)
...     # Perform action
...     next_data = env.step(reset_data)
...     data = env.step_mdp(next_data)

to(device: Union[device, str, int]) → EnvBase[source]¶

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

可以按如下方式调用：

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 时，如果可能，它会尝试相对于主机（host）进行异步转换/移动，例如，将带有锁页内存（pinned memory）的 CPU 张量移动到 CUDA 设备。

参见下方示例。

注意

此方法会原地修改模块。

参数:

device (torch.device) – 此模块中参数和缓冲区的目标设备
dtype (torch.dtype) – 此模块中参数和缓冲区的目标浮点型或复数型数据类型
tensor (torch.Tensor) – 其数据类型和设备是此模块中所有参数和缓冲区目标数据类型和设备的张量
memory_format (torch.memory_format) – 此模块中 4D 参数和缓冲区的目标内存格式 (仅关键字参数)

返回值:

自身

返回类型:

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)

to_empty(*, device: Optional[Union[int, str, device]], recurse: bool = True) → T¶

将参数和缓冲区移动到指定的设备，而不复制存储。

参数:

device (torch.device) – 此模块中参数和缓冲区的目标设备。
recurse (bool) – 子模块的参数和缓冲区是否应递归移动到指定的设备。

返回值:

自身

返回类型:

Module

train(mode: bool = True) → T¶

将模块设置为训练模式。

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

参数:: mode (bool) – 是否设置为训练模式 (True) 或评估模式 (False)。默认值: True。
返回值:: 自身
返回类型:: Module

type(dst_type: Union[dtype, str]) → T¶

将所有参数和缓冲区转换为 dst_type。

注意

此方法会原地修改模块。

参数:: dst_type (type or string) – 目标类型
返回值:: 自身
返回类型:: Module

xpu(device: Optional[Union[int, device]] = None) → T¶

将所有模型参数和缓冲区移动到 XPU。

这也会使相关的参数和缓冲区成为不同的对象。因此，如果模块在优化时将驻留在 XPU 上，应在构建优化器之前调用此方法。

注意

此方法会原地修改模块。

参数:: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回值:: 自身
返回类型:: Module

zero_grad(set_to_none: bool = True) → None¶

重置所有模型参数的梯度。

有关更多背景信息，请参阅 torch.optim.Optimizer 下的类似函数。

参数:: set_to_none (bool) – 不是设置为零，而是将梯度设置为 `None`。详情请参阅 torch.optim.Optimizer.zero_grad()。

EnvBase¶

文档

教程

资源