SerialEnv¶

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

在同一进程中创建一系列环境。批处理环境允许用户查询远程运行环境的任意方法/属性。

这些查询将返回一个列表，其长度等于 worker 数量，列表中包含查询结果的值。

>>> env = ParallelEnv(3, my_env_fun)
>>> custom_attribute_list = env.custom_attribute
>>> custom_method_list = env.custom_method(*args)

参数:

num_workers – 同时部署的 worker (即环境实例) 数量；
create_env_fn (callable 或 callable 列表) – 用于创建环境的函数 (或函数列表)。如果使用单个任务，应使用单个 callable 而不是相同的 callable 列表：如果提供了 callable 列表，环境将按需多个不同任务的方式执行，这会带来轻微的计算开销；

关键字参数:

create_env_kwargs (dict 或 dict 列表，可选) – 用于创建环境的 kwargs；
share_individual_td (bool，可选) – 如果为 True，则为每个进程/worker 创建一个不同的 tensordict，并返回一个 lazy stack。默认值为 None (如果为单个任务则为 False)；
shared_memory (bool) – 返回的 tensordict 是否会放置在共享内存中；
memmap (bool) – 返回的 tensordict 是否会放置在内存映射中。
policy_proof (callable，可选) – 如果提供，将用于获取通过 step() 和 reset() 方法返回的张量列表，例如 "hidden" 等。
device (str, int, torch.device) – 可以传递批处理环境的设备。如果未传递，则从环境推断。在这种情况下，假定所有环境的设备匹配。如果提供了设备，它可以与子环境设备不同。在这种情况下，数据在收集期间将自动转换为适当的设备。当转换为设备引入开销时 (例如，基于 numpy 的环境等)，这可用于加速收集：通过为批处理环境使用 "cuda" 设备，但为嵌套环境使用 "cpu" 设备，可以将开销降至最低。
num_threads (int，可选) – 此进程的线程数量。应等于每个子进程中启动的进程数量加一 (如果启动单个进程则为一)。默认值为 worker 数量加 1。此参数对 SerialEnv 类没有影响。
num_sub_threads (int，可选) – 子进程的线程数量。出于安全考虑，默认值为 1：如果未指定，启动多个 worker 可能会使 CPU 负载过高并损害性能。此参数对 SerialEnv 类没有影响。
serial_for_single (bool，可选) – 如果为 True，使用单个 worker 创建并行环境将转而返回 SerialEnv。此选项对 SerialEnv 没有影响。默认值为 False。
non_blocking (bool，可选) – 如果为 True，设备移动将使用 non_blocking=True 选项完成。默认值为 True。
mp_start_method (str，可选) – 多进程启动方法。如果未指定，则使用默认启动方法 (在 TorchRL 中，如果首次导入前未另外初始化，则默认为 ‘spawn’)。仅与 ParallelEnv 子类一起使用。
use_buffers (bool，可选) –
worker 之间是否应通过循环预分配内存缓冲区进行通信。除非其中一个环境具有动态 specs，否则默认值为 True。

注意

在此处了解更多关于动态 specs 和环境的信息。

注意

可以使用以下技术将关键字参数传递给每个子环境：reset() 中的每个关键字参数都将传递给每个环境，但 list_of_kwargs 参数除外；如果存在，该参数应包含一个与 worker 数量相同长度的列表，其中包含存储在字典中的 worker 特定关键字参数。如果查询部分重置，则将忽略 list_of_kwargs 中与未重置的子环境对应的元素。

示例

>>> from torchrl.envs import GymEnv, ParallelEnv, SerialEnv, EnvCreator
>>> make_env = EnvCreator(lambda: GymEnv("Pendulum-v1")) # EnvCreator ensures that the env is sharable. Optional in most cases.
>>> env = SerialEnv(2, make_env)  # Makes 2 identical copies of the Pendulum env, runs them on the same process serially
>>> env = ParallelEnv(2, make_env)  # Makes 2 identical copies of the Pendulum env, runs them on dedicated processes
>>> from torchrl.envs import DMControlEnv
>>> env = ParallelEnv(2, [
...     lambda: DMControlEnv("humanoid", "stand"),
...     lambda: DMControlEnv("humanoid", "walk")])  # Creates two independent copies of Humanoid, one that walks one that stands
>>> rollout = env.rollout(10)  # executes 10 random steps in the environment
>>> rollout[0]  # data for Humanoid stand
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False),
        com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
        done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False),
        head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False),
        joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False),
        next: TensorDict(
            fields={
                com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
                done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False),
                head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False),
                joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False),
                reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False),
                terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
                truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)},
            batch_size=torch.Size([10]),
            device=cpu,
            is_shared=False),
        terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
        truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)},
    batch_size=torch.Size([10]),
    device=cpu,
    is_shared=False)
>>> rollout[1]  # data for Humanoid walk
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False),
        com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
        done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False),
        head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False),
        joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False),
        next: TensorDict(
            fields={
                com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
                done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False),
                head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False),
                joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False),
                reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False),
                terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
                truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)},
            batch_size=torch.Size([10]),
            device=cpu,
            is_shared=False),
        terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
        truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)},
    batch_size=torch.Size([10]),
    device=cpu,
    is_shared=False)
>>> # serial_for_single to avoid creating parallel envs if not necessary
>>> env = ParallelEnv(1, make_env, serial_for_single=True)
>>> assert isinstance(env, SerialEnv)  # serial_for_single allows you to avoid creating parallel envs when not necessary

property action_key: NestedKey¶

环境的动作键。

默认情况下，此值为 “action”。

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

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

环境的动作键列表。

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

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

property action_spec: TensorSpec¶

action specs。

action_spec 始终存储为复合 specs。

如果 action specs 作为简单 specs 提供，将返回此值。

>>> 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)

如果 action specs 作为复合 specs 提供且仅包含一个 leaf，此函数将仅返回该 leaf。

>>> 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)

如果 action specs 作为复合 specs 提供且包含多个 leaf，此函数将返回整个 specs。

>>> 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([]))

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

>>> 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¶: 返回环境的 action specs，就像它没有批处理维度一样。

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

将子模块添加到当前模块。

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

参数:

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

add_truncated_keys()¶: 向环境添加截断键。

all_actions(tensordict: TensorDictBase | None = None) → TensorDictBase¶

根据 action specs 生成所有可能的动作。

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

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

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

返回一个转换后的环境，其中应用了传入的 callable/transform。

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

示例

>>> 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) – 将应用于每个子模块的函数
返回:: self
返回类型:: 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')¶

基于使用给定策略的随机 rollout，自动设置环境的 specs (规范)。

此方法使用提供的策略执行 rollout，以推断环境的输入和输出 specs。它根据 rollout 期间收集的数据更新环境的 action、observation、reward 和 done 信号的 specs。

参数:

policy (Callable[[TensorDictBase], TensorDictBase]) – 一个 callable 策略，接受 TensorDictBase 作为输入并返回 TensorDictBase 作为输出。此策略用于执行 rollout 并确定 specs。

关键字参数:

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

返回:

具有更新 specs 的环境实例。

返回类型:

EnvBase

引发:

RuntimeError – 如果输出 specs 中存在未包含在提供的键中的键。

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

property batch_locked: bool¶

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

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

property batch_size: Size¶

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

环境可能相似或不同，但假定它们之间很少 (如果不是没有) 交互 (例如，多任务或并行批处理执行)。

bfloat16() → T¶

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

注意

此方法会就地修改模块。

返回:: self
返回类型:: 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¶

动作空间的基数。

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

当 action specs 可变时，此类很有用

动作数量可能未定义，例如 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)¶

根据短时 rollout 的结果测试环境 specs。

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

损坏的环境 specs 可能使得使用并行环境变得不可能。

参数:

env (EnvBase) – 需要根据数据检查 specs 的环境。
return_contiguous (bool，可选) – 如果为 True，将使用 return_contiguous=True 调用随机 rollout。这在某些情况下会失败 (例如，输入/输出形状异构)。默认值为 None (由是否存在动态 specs 决定)。
check_dtype (bool，可选) – 如果为 False，将跳过 dtype 检查。默认值为 True。
seed (int，可选) – 为了重现性，可以设置一个 seed。seed 将在 pytorch 中临时设置，然后 RNG 状态将恢复到之前的值。对于环境，我们设置 seed，但由于将 rng 状态恢复到之前的值不是大多数环境的特性，我们将其留给用户完成。默认值为 None。
tensordict (TensorDict，可选) – 用于重置的可选 tensordict 实例。

注意：此函数会重置环境 seed。应将其“离线”使用，以检查环境是否已正确构建，但它可能会影响实验的 seed 设置，因此应避免在训练脚本中使用。

children() → Iterator[Module]¶

返回直接子模块的迭代器。

生成:: Module – 子模块

compile(*args, **kwargs)¶

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

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

有关此函数参数的详细信息，请参阅 torch.compile()。

cpu() → T¶

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

注意

此方法会就地修改模块。

返回:: self
返回类型:: Module

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

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

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

注意

此方法会就地修改模块。

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

property done_key¶

环境的完成键（done key）。

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

如果环境中存在多个完成键（done key），此函数将引发异常。

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

环境的完成键（done keys）。

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

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

property done_keys_groups¶

完成键（done keys）的列表，按重置键（reset keys）分组。

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

property done_spec: TensorSpec¶

The done 规范。

The done_spec 总是作为组合规范存储。

如果完成规范（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)

如果完成规范（done spec）作为组合规范提供且仅包含一个叶子节点，此函数将仅返回该叶子节点。

>>> 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)

如果完成规范（done spec）作为组合规范提供且包含多个叶子节点，此函数将返回整个规范。

>>> 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¶: 返回环境的完成规范（done spec），就像它没有批量维度一样。

double() → T¶

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

注意

此方法会就地修改模块。

返回:: self
返回类型:: Module

empty_cache()¶

擦除所有缓存的值。

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

eval() → T¶

将模块设置为评估模式。

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

这等效于 self.train(False)。

请参阅局部禁用梯度计算，以比较 .eval() 与可能与其混淆的几种类似机制。

返回:: self
返回类型:: Module

extra_repr() → str¶

返回模块的额外表示。

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

fake_tensordict() → TensorDictBase¶: 返回一个假的 tensordict，其键值对的 shape、device 和 dtype 与环境 rollout 期间预期的相匹配。

float() → T¶

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

注意

此方法会就地修改模块。

返回:: self
返回类型:: Module

forward(*args, **kwargs)¶

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

应由所有子类覆盖。

注意

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

property full_action_spec: Composite¶

完整的动作规范（action spec）。

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¶: 返回环境的 action specs，就像它没有批处理维度一样。

property full_done_spec: Composite¶

完整的完成规范（done spec）。

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¶: 返回环境的完成规范（done spec），就像它没有批量维度一样。

property full_observation_spec_unbatched: Composite¶: 返回环境的观察规范（observation spec），就像它没有批量维度一样。

property full_reward_spec: Composite¶

完整的奖励规范（reward spec）。

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¶: 返回环境的奖励规范（reward spec），就像它没有批量维度一样。

property full_state_spec: Composite¶

完整的状态规范（state spec）。

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¶: 返回环境的状态规范（state spec），就像它没有批量维度一样。

get_buffer(target: str) → Tensor¶

如果存在由 target 指定的缓冲区，则返回该缓冲区，否则引发错误。

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

参数:: target —— 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回:: 由 target 引用的缓冲区
返回类型:: torch.Tensor
引发:: AttributeError —— 如果目标字符串引用了无效路径或解析为非缓冲区的内容

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 指定的参数，则返回该参数，否则引发错误。

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

参数:: target —— 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回:: 由 target 引用的 Parameter
返回类型:: torch.nn.Parameter
引发:: AttributeError —— 如果目标字符串引用了无效路径或解析为非 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)（N 为传递模块的数量）。因此，对于检查某个子模块是否存在这种简单情况，应始终使用 get_submodule。

参数:
target —— 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参见上述示例。）

返回:
由 target 引用的子模块

返回类型:
torch.nn.Module

引发:
AttributeError —— 如果目标字符串引用了无效路径或解析为非 nn.Module 的内容





half() → T¶
将所有浮点参数和缓冲区转换为 half 数据类型。

注意
此方法会就地修改模块。


返回:
self

返回类型:
Module






property input_spec: TensorSpec¶
输入规范（Input spec）。
包含环境数据输入所有规范的组合规范。
它包含

“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¶
返回环境的输入规范（input spec），就像它没有批量维度一样。




ipu(device: Optional[Union[int, device]] = None) → T¶
将所有模型参数和缓冲区移到 IPU。
这也会使关联的参数和缓冲区成为不同的对象。因此，如果模块将在 IPU 上进行优化，则应在构建优化器之前调用此方法。

注意
此方法会就地修改模块。


参数:
device (int, optional) —— 如果指定，所有参数将复制到该设备

返回:
self

返回类型:
Module






property is_spec_locked¶
获取环境规范是否被锁定。
此属性可以直接修改。

返回:
如果规范被锁定，则为 True；否则为 False。

返回类型:
bool



另请参见
锁定环境规范.





load_state_dict(*args, **kwargs)[source]¶
将参数和缓冲区从 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 时，保留当前模块中 tensor 的属性，而设置为 True 时，保留 state dict 中 Tensor 的属性。唯一的例外是 requires_grad 字段。默认值：False


返回:


missing_keys 是一个 str 列表，包含预期的所有键
由此模块期望但提供的 state_dict 中缺失的键。




unexpected_keys 是一个 str 列表，包含非
由此模块期望但提供的 state_dict 中存在的键。






返回类型:
包含 missing_keys 和 unexpected_keys 字段的 NamedTuple



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





maybe_reset(tensordict: TensorDictBase) → TensorDictBase¶
检查输入 tensordict 的完成键（done key），如果需要，在环境完成时进行重置。

参数:
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) —— 如果指定，所有参数将复制到该设备

返回:
self

返回类型:
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 实例。规范中列出的键在重置和步进后可以直接访问。
在 TorchRL 中，即使它们并非严格意义上的“观测”，所有来自环境的 info、states、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¶
返回环境的观察规范（observation spec），就像它没有批量维度一样。




property output_spec: TensorSpec¶
输出规范。
包含环境所有数据输出规范的复合规范。
它包含

“full_reward_spec”：reward 的规范
“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)¶
根据 action_spec 属性执行一个随机动作。

参数:
tensordict (TensorDictBase, optional) – 结果动作应该写入的 tensordict。

返回:
一个 tensordict 对象，其“action”条目已使用来自 action-spec 的随机样本更新。






rand_step(tensordict: TensorDictBase | None = None) → TensorDictBase¶
根据 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¶
在模块上注册一个 backward hook。
此函数已被弃用，请优先使用 register_full_backward_hook()。此函数的行为将在未来版本中发生变化。

返回:
一个句柄，通过调用 handle.remove() 可以用来移除已添加的 hook。

返回类型:
torch.utils.hooks.RemovableHandle






register_buffer(name: str, tensor: Optional[Tensor], persistent: bool = True) → None¶
向模块添加一个 buffer。
这通常用于注册不应被视为模型参数的 buffer。例如，BatchNorm 的 running_mean 不是参数，但它是模块状态的一部分。默认情况下，buffer 是持久的，并将与参数一起保存。通过将 persistent 设置为 False 可以更改此行为。持久 buffer 和非持久 buffer 之间的唯一区别在于，后者不属于此模块的 state_dict。
buffer 可以使用给定的名称作为属性进行访问。

参数:

name (str) – buffer 的名称。可以使用给定的名称从此模块访问该 buffer
tensor (Tensor or None) – 要注册的 buffer。如果为 None，则对 buffer 进行的操作（例如 cuda）将被忽略。如果为 None，则此 buffer **不**包含在模块的 state_dict 中。
persistent (bool) – buffer 是否是此模块的 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 hook。
每次 forward() 计算出输出后，都会调用该 hook。
如果 with_kwargs 为 False 或未指定，则输入仅包含传递给模块的位置参数。关键字参数不会传递给 hook，仅传递给 forward。hook 可以修改输出。它可以原地修改输入，但由于是在调用 forward() 之后调用此 hook，因此对 forward 没有影响。hook 应具有以下签名：
hook(module, args, output) -> None or modified output


如果 with_kwargs 为 True，forward hook 将会接收传递给 forward 函数的 kwargs，并应返回可能已修改的输出。hook 应具有以下签名：
hook(module, args, kwargs, output) -> None or modified output



参数:

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


返回:
一个句柄，通过调用 handle.remove() 可以用来移除已添加的 hook。

返回类型:
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 pre-hook。
每次调用 forward() 之前，都会调用该 hook。
如果 with_kwargs 为 false 或未指定，则输入仅包含传递给模块的位置参数。关键字参数不会传递给 hook，仅传递给 forward。hook 可以修改输入。用户可以在 hook 中返回一个元组或一个修改后的单个值。如果返回单个值（除非该值本身就是一个元组），我们将把该值包装成一个元组。hook 应具有以下签名：
hook(module, args) -> None or modified input


如果 with_kwargs 为 true，forward pre-hook 将会接收传递给 forward 函数的 kwargs。如果 hook 修改了输入，则应同时返回 args 和 kwargs。hook 应具有以下签名：
hook(module, args, kwargs) -> None or a tuple of modified input and kwargs



参数:

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 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 (bool) – 如果为 true，则 hook 将会接收传递给 forward 函数的 kwargs。默认值：False


返回:
一个句柄，通过调用 handle.remove() 可以用来移除已添加的 hook。

返回类型:
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¶
在模块上注册一个 backward hook。
每当计算模块的梯度时都会调用该 hook，即只有在计算模块输出的梯度时，该 hook 才会执行。该 hook 应具有以下签名：
hook(module, grad_input, grad_output) -> tuple(Tensor) or None


`grad_input` 和 `grad_output` 是包含分别对应输入和输出梯度的元组。hook 不应修改其参数，但可以选择返回一个对应输入的新梯度，该梯度将在后续计算中替换 `grad_input`。`grad_input` 仅对应作为位置参数给出的输入，所有 kwarg 参数都会被忽略。对于所有非 Tensor 参数，`grad_input` 和 `grad_output` 中的条目将为 `None`。
出于技术原因，当此 hook 应用于模块时，其 forward 函数将接收传递给模块的每个 Tensor 的视图。类似地，调用者也将接收模块 forward 函数返回的每个 Tensor 的视图。

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


参数:

hook (Callable) – 要注册的用户定义 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() 可以用来移除已添加的 hook。

返回类型:
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 应具有以下签名：
hook(module, grad_output) -> tuple[Tensor] or None


参数 grad_output 是一个元组。hook 不应修改其参数，但可以选择返回一个相对于输出的新梯度，该梯度将代替 grad_output 用于后续计算。grad_output 中的所有非 Tensor 参数的条目将是 None。
出于技术原因，当此 hook 应用于模块时，其 forward 函数将接收传递给模块的每个 Tensor 的视图。类似地，调用者也将接收模块 forward 函数返回的每个 Tensor 的视图。

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


参数:

hook (Callable) – 要注册的用户定义 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() 可以用来移除已添加的 hook。

返回类型:
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) 中注册一个环境。
此方法的设计考虑了以下范围：

在使用 Gym 的框架中集成一个以 TorchRL 为优先的环境；
在使用 Gym 的框架中集成另一个环境（例如，DeepMind Control、Brax、Jumanji 等）。


参数:
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 (List[NestedKey], 可选) –
如果提供，这些键将用于构建 info 字典，并从 observation 键中排除。此参数可在调用 make() 时传入（参见下面的示例）。

警告
使用 info_keys 可能会导致 spec 为空，因为内容已移至 info 字典。Gym 不喜欢 spec 中的空 Dict，因此应使用 RemoveEmptySpecs 删除此空内容。


backend (字符串, 可选) – 后端。可以是 “gym” 或 “gymnasium”，或任何其他与 set_gym_backend 兼容的后端。
to_numpy (布尔型, 可选) – 如果为 True，则对 step 和 reset 的调用结果将映射到 numpy 数组。默认为 False（结果为 tensors）。此参数可在调用 make() 时传入（参见下面的示例）。
reward_threshold (float, 可选) – [Gym kwarg] 认为已学会环境的奖励阈值。
nondeterministic (布尔型, 可选) – [Gym kwarg] 环境是否是非确定性的（即使知道初始种子和所有动作）。默认为 False。
max_episode_steps (整型, 可选) – [Gym kwarg] 截断前最大回合步数。由 Time Limit wrapper 使用。
order_enforce (布尔型, 可选) – [Gym >= 0.14] 是否应用 order enforcer wrapper 以确保用户按正确顺序运行函数。默认为 True。
autoreset (布尔型, 可选) – [Gym >= 0.14] 是否添加 autoreset wrapper 以便无需调用 reset。默认为 False。
disable_env_checker – [Gym >= 0.14] 是否对环境禁用环境检查器。默认为 False。
apply_api_compatibility – [Gym >= 0.26] 是否应用 StepAPICompatibility wrapper。默认为 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（后置 hook），在调用模块的 load_state_dict() 后运行。

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


参数 module 是注册此 hook 的当前模块，参数 incompatible_keys 是一个由属性 missing_keys 和 unexpected_keys 组成的 NamedTuple。missing_keys 是一个包含缺失键的 str list，unexpected_keys 是一个包含意外键的 str list。
如有需要，可以就地修改给定的 incompatible_keys。
请注意，正如预期，当调用 load_state_dict() 并设置 strict=True 时执行的检查会受到 hook 对 missing_keys 或 unexpected_keys 所做修改的影响。向任一键集中添加内容都会在 strict=True 时引发错误，而清除所有缺失和意外键则可以避免错误。

返回:
一个句柄，通过调用 handle.remove() 可以用来移除已添加的 hook。

返回类型:
torch.utils.hooks.RemovableHandle






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

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



参数:
hook (可调用对象) – 在加载 state dict 之前将被调用的可调用 hook。






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




register_parameter(name: str, param: Optional[Parameter]) → None¶
向模块添加一个 parameter。
可以使用给定名称作为属性访问该 parameter。

参数:

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







register_state_dict_post_hook(hook)¶
为 state_dict() 方法注册一个 post-hook（后置 hook）。

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


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




register_state_dict_pre_hook(hook)¶
为 state_dict() 方法注册一个 pre-hook（前置 hook）。

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


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




requires_grad_(requires_grad: bool = True) → T¶
更改 autograd 是否应在此模块中记录对 parameter 的操作。
此方法就地设置 parameter 的 requires_grad 属性。
此方法有助于冻结模块的部分内容进行微调，或单独训练模型的部分内容（例如，GAN 训练）。
请参阅 局部禁用梯度计算，了解 .requires_grad_() 与其他可能混淆的类似机制之间的比较。

参数:
requires_grad (布尔型) – autograd 是否应在此模块中记录对 parameter 的操作。默认值：True。

返回:
self

返回类型:
Module






reset(tensordict: TensorDictBase | None = None, **kwargs) → TensorDictBase¶
重置环境。
与 step 和 _step 类似，只有私有方法 _reset 应该被 EnvBase 子类覆盖。

参数:

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


返回:
一个 tensordict（如果提供了输入 tensordict，则为该输入 tensordict），其中就地修改了产生的 observation。



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





property reset_keys: list[tensordict._nestedkey.NestedKey]¶
返回 reset 键列表。
Reset 键是表示部分重置的键，用于批量、多任务或多智能体设置中。它们的结构是 (*prefix, "_reset")，其中 prefix 是一个（可能为空的）字符串元组，指向 tensordict 中可以找到完成状态的位置。
键按数据树中的深度排序。




property reward_key¶
环境的 reward 键。
默认情况下，这将是 “reward”。
如果环境中存在多个 reward 键，此函数将引发异常。




property reward_keys: list[tensordict._nestedkey.NestedKey]¶
环境的 reward 键。
默认情况下，只有一个名为 “reward” 的键。
键按数据树中的深度排序。




property reward_spec: TensorSpec¶
reward 规范（spec）。
reward_spec 总是存储为复合规范。
如果 reward 规范提供为简单规范，将返回此规范。
>>> 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)


如果 reward 规范提供为复合规范且只包含一个叶子，此函数将只返回该叶子。
>>> 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)


如果 reward 规范提供为复合规范且包含多个叶子，此函数将返回整个规范。
>>> 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([]))


要检索传递的完整 specs，请使用
>>> 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¶
返回环境的奖励规范（reward spec），就像它没有批量维度一样。




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¶
在环境中执行一次 rollout。
一旦任何包含的环境达到任何完成状态，函数就会立即返回。

参数:

max_steps (整型) – 最大执行步数。如果环境在达到 max_steps 之前达到完成状态，实际步数可能会更少。
policy (可调用对象, 可选) – 用于计算所需 action 的可调用对象。如果未提供 policy，将使用 env.rand_step() 调用 actions。policy 可以是任何可调用对象，它读取 tensordict 或按 env.observation_spec.keys() 排序的完整 observation 条目序列。默认为 None。
callback (Callable[[TensorDict], Any], 可选) – 在每次迭代时使用给定的 TensorDict 调用的函数。默认为 None。callback 的输出不会被收集，如果需要在调用 rollout 之外保留数据，用户有责任在 callback 调用内部保存任何结果。


关键字参数:

auto_reset (布尔型, 可选) – 如果为 True，包含的环境将在开始 rollout 之前重置。如果为 False，rollout 将从先前的状态继续，这需要传入包含先前 rollout 状态的 tensordict 参数。默认值为 True。
auto_cast_to_device (布尔型, 可选) – 如果为 True，在policy使用之前，tensordict 的设备将自动转换为 policy 的设备。默认值为 False。
break_when_any_done (bool) – 如果 True，则在任何一个包含的环境达到任何完成状态时中断。如果 False，则完成的环境会自动重置。默认值为 True。
break_when_all_done (bool, optional) – 如果 True，则在所有包含的环境达到任何完成状态时中断。如果 False，则在至少一个环境达到任何完成状态时中断。默认值为 False。
return_contiguous (bool) – 如果为 False，将返回一个 LazyStackedTensorDict。如果环境没有动态规范（dynamic specs），默认值为 True，否则为 False。
tensordict (TensorDict, optional) – 如果 auto_reset 为 False，则必须提供初始的 tensordict。Rollout 会检查此 tensordict 是否有完成标志，并在这些维度上重置环境（如果需要）。如果 tensordict 是重置（reset）的输出，通常不应发生这种情况，但如果 tensordict 是先前推演（rollout）的最后一步，则可能发生。即使 auto_reset=True，也可以提供 tensordict，以便将元数据（metadata）传递给 reset 方法，例如批量大小（batch-size）或无状态环境（stateless environments）的设备（device）。
set_truncated (bool, optional) – 如果 True，在推演（rollout）完成后，"truncated" 和 "done" 键将被设置为 True。如果在 done_spec 中没有找到 "truncated"，则会引发异常。截断键（Truncated keys）可以通过 env.add_truncated_keys 设置。默认为 False。
trust_policy (bool, optional) – 如果 True，则非 TensorDictModule 策略将被视为与 collector 兼容并被信任。对于 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 成为 tensordicts 的惰性堆叠（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）返回的最后一个 tensordict 调用 step_mdp() 后的结果作为输入。

数据收集推演（rollouts）示例
>>> 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(*args, **kwargs)[source]¶
设置环境的种子并返回要使用的下一个种子（如果存在单个环境，则为输入的种子）。

参数:

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


返回:
即，如果与此环境同时创建另一个环境，则应使用的种子。

返回类型:
表示“下一个种子”的整数






set_spec_lock_(mode: bool = True) → EnvBase¶
锁定或解锁环境的规范（specs）。

参数:
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 —— 如果目标字符串引用了无效路径或解析为非 nn.Module 的内容







property shape¶
等价于 batch_size。




share_memory() → T¶
请参阅 torch.Tensor.share_memory_()。




property specs: Composite¶
返回一个包含所有环境的 Composite 容器。
此功能允许创建一个环境，在一个数据容器中检索所有规范（specs），然后从工作区中擦除环境。




state_dict(*args, **kwargs)[source]¶
返回一个字典，其中包含对模块整个状态的引用。
参数和持久缓冲区（例如运行平均值）都包括在内。键是相应的参数和缓冲区名称。设置为 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 keys）。
默认情况下，只会有一个名为“state”的键。
键按数据树中的深度排序。




property state_spec: Composite¶
状态规范（State spec）。
必须是 torchrl.data.Composite 实例。此处列出的键应作为输入与动作（actions）一起提供给环境。
在 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¶
返回环境的状态规范（state spec），就像它没有批量维度一样。




step(tensordict: TensorDictBase) → TensorDictBase¶
在环境中执行一步（step）。
Step 接受一个参数 tensordict，该参数通常带有一个“action”键，指示要采取的动作。Step 将调用一个非就地的私有方法 _step，这是 EnvBase 子类需要重写的方法。

参数:
tensordict (TensorDictBase) – 包含要采取的动作的 Tensordict。如果输入的 tensordict 包含“next”条目，则其中包含的值将优先于新计算的值。这提供了一种覆盖底层计算的机制。

返回:
输入的 tensordict，就地修改，包含结果观测（observations）、完成状态（done state）和奖励（reward）（如果需要，还包含其他）。






step_and_maybe_reset(tensordict: TensorDictBase) → tuple[tensordict.base.TensorDictBase, tensordict.base.TensorDictBase]¶
在环境中执行一步（step），并在需要时（部分）重置它。

参数:
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¶
使用提供的 next_tensordict 将环境状态向前推进一步。
此方法通过从当前状态转换到由 next_tensordict 定义的下一个状态来更新环境状态。结果 tensordict 包含更新的观测（observations）和任何其他相关状态信息，键根据环境规范（specifications）进行管理。
在内部，此方法利用预计算的 _StepMDP 实例来高效处理状态、观测、动作、奖励和完成键的转换。_StepMDP 类通过预计算要包含和排除的键来优化过程，减少重复调用期间的运行时开销。_StepMDP 实例使用 exclude_action=False 创建，这意味着动作键保留在根 tensordict 中。

参数:
next_tensordict (TensorDictBase) – 一个 tensordict，包含环境在下一个时间步的状态。此 tensordict 应包含观测（observations）、动作（actions）、奖励（rewards）和完成标志（done flags）的键，具体取决于环境规范（specifications）。

返回:
表示环境向前推进一步后的新 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])[source]¶
移动和/或转换参数和缓冲区的类型。
可以按如下方式调用：


to(device=None, dtype=None, non_blocking=False)[source]




to(dtype, non_blocking=False)[source]




to(tensor, non_blocking=False)[source]




to(memory_format=torch.channels_last)[source]


其签名类似于 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)






to_empty(*, device: Optional[Union[int, str, device]], recurse: bool = True) → T¶
将参数和缓冲区移动到指定设备，但不复制存储。

参数:

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


返回:
self

返回类型:
Module






train(mode: bool = True) → T¶
将模块设置为训练模式。
这只对某些模块有影响。有关特定模块在训练/评估模式下行为的详细信息（即它们是否受影响），请参阅其文档，例如 Dropout、BatchNorm 等。

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

返回:
self

返回类型:
Module






type(dst_type: Union[dtype, str]) → T¶
将所有参数和缓冲区类型转换为 dst_type。

注意
此方法会就地修改模块。


参数:
dst_type (type or string) – 期望的类型

返回:
self

返回类型:
Module






update_kwargs(kwargs: Union[dict, List[dict]]) → None¶
给定一个字典或字典列表，更新每个环境的 kwargs。

参数:
kwargs (dict or list of dict) – 用于环境的新 kwargs






xpu(device: Optional[Union[int, device]] = None) → T¶
将所有模型参数和缓冲区移动到 XPU。
这也会使关联的参数和缓冲区成为不同的对象。因此，如果在优化时模块将驻留在 XPU 上，则应在构建优化器之前调用此方法。

注意
此方法会就地修改模块。


参数:
device (int, optional) —— 如果指定，所有参数将复制到该设备

返回:
self

返回类型:
Module






zero_grad(set_to_none: bool = True) → None¶
重置所有模型参数的梯度。
有关更多上下文，请参阅 torch.optim.Optimizer 下的类似函数。

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

SerialEnv¶

文档

教程

资源