PendulumEnv¶

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

一个无状态的 Pendulum 环境。

有关更多详细信息，请参阅 Pendulum 教程：教程。

规格

>>> env = PendulumEnv()
>>> env.specs
Composite(
    output_spec: Composite(
        full_observation_spec: Composite(
            th: BoundedContinuous(
                shape=torch.Size([]),
                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),
            thdot: BoundedContinuous(
                shape=torch.Size([]),
                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),
            params: Composite(
                max_speed: UnboundedDiscrete(
                    shape=torch.Size([]),
                    space=ContinuousBox(
                        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, contiguous=True),
                        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, contiguous=True)),
                    device=cpu,
                    dtype=torch.int64,
                    domain=discrete),
                max_torque: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                dt: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                g: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                m: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                l: UnboundedContinuous(
                    shape=torch.Size([]),
                    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=None,
            shape=torch.Size([])),
        full_reward_spec: Composite(
            reward: UnboundedContinuous(
                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=None,
            shape=torch.Size([])),
        full_done_spec: Composite(
            done: Categorical(
                shape=torch.Size([1]),
                space=CategoricalBox(n=2),
                device=cpu,
                dtype=torch.bool,
                domain=discrete),
            terminated: Categorical(
                shape=torch.Size([1]),
                space=CategoricalBox(n=2),
                device=cpu,
                dtype=torch.bool,
                domain=discrete),
            device=None,
            shape=torch.Size([])),
        device=None,
        shape=torch.Size([])),
    input_spec: Composite(
        full_state_spec: Composite(
            th: BoundedContinuous(
                shape=torch.Size([]),
                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),
            thdot: BoundedContinuous(
                shape=torch.Size([]),
                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),
            params: Composite(
                max_speed: UnboundedDiscrete(
                    shape=torch.Size([]),
                    space=ContinuousBox(
                        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, contiguous=True),
                        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, contiguous=True)),
                    device=cpu,
                    dtype=torch.int64,
                    domain=discrete),
                max_torque: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                dt: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                g: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                m: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                l: UnboundedContinuous(
                    shape=torch.Size([]),
                    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=None,
            shape=torch.Size([])),
        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=None,
            shape=torch.Size([])),
        device=None,
        shape=torch.Size([])),
    device=None,
    shape=torch.Size([]))

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¶: 向环境添加截断键。

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

从动作规格中生成所有可能的动作。

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

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

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

返回一个经过变换的环境，其中应用了传递的可调用对象/变换。

参数：: 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) – 将应用于每个子模块的函数
返回：: 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，以推断环境的输入和输出规格。它根据在 rollout 期间收集的数据更新环境关于动作、观测、奖励和终止信号的规格。

参数：

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

关键字参数：

tensordict (TensorDictBase, 可选) – 一个可选的 TensorDictBase 实例，用作 rollout 的初始状态。如果未提供，将调用环境的 reset 方法以获取初始状态。
action_key (NestedKey 或 List[NestedKey], 可选) – 用于在 TensorDictBase 中识别动作的键。默认为“action”。
done_key (NestedKey 或 List[NestedKey] 或 None, 可选) – 用于在 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_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 的一个简单封装。

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

动作数量可能未定义，例如 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 的结果测试环境规格。

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

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

参数：

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

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

children() → Iterator[Module]¶

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

返回：: Module – 一个子模块

compile(*args, **kwargs)¶

使用 torch.compile() 编译此模块的前向传播。

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

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

cpu() → T¶

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

注意

此方法会就地修改模块。

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

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

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

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

注意

此方法会就地修改模块。

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

property done_key¶

环境的终止键。

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

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

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

环境的终止键列表。

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

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

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

property done_keys_groups¶

终止键的列表，按 reset 键分组。

这是一个列表的列表。外层列表的长度与 reset 键的数量相同，内层列表包含可以读取的终止键（例如，done 和 truncated），用于在 reset 键不存在时确定是否需要 reset。

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¶

注意

此方法会就地修改模块。

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

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

empty_cache()¶

清除所有缓存值。

eval() → T¶

将模块设置为评估模式。

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

这等效于 self.train(False)。

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

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

extra_repr() → str¶

返回模块的额外表示。

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

fake_tensordict() → TensorDictBase¶: 返回一个伪造的 tensordict，其键值对的形状、设备和 dtype 与环境 rollout 期间预期的相匹配。

float() → T¶

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

注意

此方法会就地修改模块。

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

forward(*args, **kwargs)¶

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

应该被所有子类覆盖。

注意

尽管正向传播的“配方”需要在此函数中定义，但应该在调用此函数后调用 Module 实例，而不是直接调用此函数，因为前者负责运行注册的钩子，而后者会静默地忽略它们。

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 done_spec_unbatched: TensorSpec¶

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

static gen_params(g=10.0, batch_size=None, device=None) → TensorDictBase[source]¶: 返回一个 tensordict，包含物理参数，例如引力、扭矩或速度限制。

get_buffer(target: str) → Tensor¶

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

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

参数：: 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 指定参数（如果存在），否则抛出错误。

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

参数：: 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_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 – 如果目标字符串引用了无效路径或解析到的不是 nn.Module

half() → T¶

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

注意

此方法会就地修改模块。

返回：: self
返回类型：: 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, 可选) – 如果指定，所有参数将被复制到该设备
返回：: self
返回类型：: 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 中张量的属性。唯一的例外是 requires_grad 字段。 Default: ``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, 可选) – 如果指定，所有参数将被复制到该设备
返回：: 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 – 用于存储已添加到结果中的模块集合的 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）、变换结果（results of transforms）等环境输出都存储在 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”：完成规范
“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]], prepend: bool = False) → 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 将在此 torch.nn.modules.Module 上的所有现有 forward 钩子之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward 钩子将在此方法注册的所有钩子之前触发。默认值：False
with_kwargs (bool) – 如果为 True，hook 将被传递给 forward 函数的关键字参数。默认值：False
always_call (bool) – 如果为 True，无论调用 Module 时是否引发异常，都将运行 hook。默认值：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 函数的关键字参数。如果钩子修改了输入，则应同时返回 args 和 kwargs。钩子应具有以下签名：

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

参数：

hook (Callable) – 要注册的用户定义的钩子。
prepend (bool) – 如果为 true，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre 钩子之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre 钩子之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre 钩子将在此方法注册的所有钩子之前触发。默认值：False
with_kwargs (bool) – 如果为 true，hook 将被传递给 forward 函数的关键字参数。默认值：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(module, grad_input, grad_output) -> tuple(Tensor) or None

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

出于技术原因，当此钩子应用于 Module 时，其前向函数将接收传递给 Module 的每个 Tensor 的视图。类似地，调用方将接收 Module 前向函数返回的每个 Tensor 的视图。

警告

使用反向钩子时，不允许就地修改输入或输出，否则将抛出错误。

参数：

hook (Callable) – 要注册的用户定义的钩子。
prepend (bool) – 如果为 True，提供的 hook 将在此 torch.nn.modules.Module 上所有现有 backward 钩子之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上所有现有 backward 钩子之后触发。注意，使用 register_module_full_backward_hook() 注册的全局 backward 钩子将在通过此方法注册的所有钩子之前触发。

返回：

一个句柄，可以通过调用 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¶

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

每次计算模块的梯度时都会调用此钩子。钩子应具有以下签名

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

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

出于技术原因，当此钩子应用于 Module 时，其前向函数将接收传递给 Module 的每个 Tensor 的视图。类似地，调用方将接收 Module 前向函数返回的每个 Tensor 的视图。

警告

使用反向钩子时，不允许就地修改输入，否则将抛出错误。

参数：

hook (Callable) – 要注册的用户定义的钩子。
prepend (bool) – 如果为 True，提供的 hook 将在此 torch.nn.modules.Module 上所有现有 backward_pre 钩子之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上所有现有 backward_pre 钩子之后触发。注意，使用 register_module_full_backward_pre_hook() 注册的全局 backward_pre 钩子将在通过此方法注册的所有钩子之前触发。

返回：

一个句柄，可以通过调用 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-first 环境集成到使用 Gym 的框架中；
将其他环境（例如 DeepMind Control、Brax、Jumanji 等）集成到使用 Gym 的框架中。

参数：

id (str) – 环境的名称。应遵循 gym 命名约定。

关键字参数：

entry_point (callable, 可选) –

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

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

警告

使用 info_keys 可能会导致规范变空，因为内容已移至信息字典。Gym 不喜欢规范中的空 Dict，因此应使用 RemoveEmptySpecs 移除此空内容。
backend (str, 可选) – 后端。可以是 "gym" 或 "gymnasium"，或与 set_gym_backend 兼容的任何其他后端。
to_numpy (bool, 可选) – 如果为 True，对 step 和 reset 的调用结果将被映射到 numpy 数组。默认为 False（结果是张量）。此参数可以在调用 make() 时传递（参见下面的示例）。
reward_threshold ([float](#torchrl.envs.PendulumEnv.float), 可选) – [Gym kwarg] 认为已学会环境的奖励阈值。
nondeterministic (bool, 可选) – [Gym kwarg 如果环境是非确定性的（即使知道初始种子和所有动作）。默认为 False。
max_episode_steps (int, 可选) – [Gym kwarg] 截断前最大回合步数。由 Time Limit wrapper 使用。
order_enforce (bool, 可选) – [Gym >= 0.14] 是否应应用顺序强制包装器以确保用户按正确顺序运行函数。默认为 True。
autoreset (bool, 可选) – [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 参数来精细控制哪些内容应被视为观测，哪些内容应被视为信息。

示例

>>> # 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`](torchrl.envs.BraxEnv.html#torchrl.envs.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)¶

注册一个后置钩子，在模块的 [`load_state_dict()`](https://pytorch.ac.cn/docs/stable/generated/torch.nn.Module.html#torch.nn.Module.load_state_dict) 被调用后运行。

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

module 参数是注册此钩子的当前模块，incompatible_keys 参数是一个 NamedTuple，包含 missing_keys 和 unexpected_keys 属性。missing_keys 是一个包含缺失键的 str list，unexpected_keys 是一个包含意外键的 str list。

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

请注意，使用 strict=True 调用 [`load_state_dict()`](#torchrl.envs.PendulumEnv.load_state_dict) 时执行的检查会受到钩子对 missing_keys 或 unexpected_keys 的修改的影响，这是符合预期的。向任一键集合添加内容都会在 strict=True 时导致抛出错误，而清除缺失和意外键则可以避免错误。

返回：: 一个句柄，可以通过调用 handle.remove() 来移除添加的钩子
返回类型：: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)¶

注册一个前置钩子，在模块的 [`load_state_dict()`](https://pytorch.ac.cn/docs/stable/generated/torch.nn.Module.html#torch.nn.Module.load_state_dict) 被调用前运行。

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

参数：: hook (Callable) – 在加载状态字典之前将被调用的可调用钩子。

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

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

向模块添加一个参数。

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

参数：

name (str) – 参数的名称。可以使用给定名称从此模块访问此参数
param (Parameter 或 None) – 要添加到模块的参数。如果为 None，则对参数运行的操作（例如 [`cuda`](#torchrl.envs.PendulumEnv.cuda)）将被忽略。如果为 None，则参数不包含在模块的 [`state_dict`](#torchrl.envs.PendulumEnv.state_dict) 中。

register_state_dict_post_hook(hook)¶

为 [`state_dict()`](https://pytorch.ac.cn/docs/stable/generated/torch.nn.Module.html#torch.nn.Module.state_dict) 方法注册一个后置钩子。

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

注册的钩子可以就地修改 state_dict。

register_state_dict_pre_hook(hook)¶

为 [`state_dict()`](https://pytorch.ac.cn/docs/stable/generated/torch.nn.Module.html#torch.nn.Module.state_dict) 方法注册一个前置钩子。

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

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

requires_grad_(requires_grad: bool = True) → T¶

更改 autograd 是否应记录此模块中参数上的操作。

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

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

请参阅[局部禁用梯度计算](https://pytorch.ac.cn/docs/stable/notes/autograd.html#locally-disable-grad-doc)，了解 .requires_grad_() 与可能与之混淆的几种类似机制之间的比较。

参数：: requires_grad (bool) – autograd 是否应记录此模块中参数上的操作。默认值：True。
返回：: self
返回类型：: Module

reset(tensordict: TensorDictBase | None = None, **kwargs) → TensorDictBase¶

重置环境。

与 step 和 _step 类似，[`EnvBase`](torchrl.envs.EnvBase.html#torchrl.envs.EnvBase) 子类只应覆盖私有方法 _reset。

参数：

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

返回：

一个 tensordict（或输入的 tensordict，如果提供了），通过产生的观测就地修改。

注意

[EnvBase`](torchrl.envs.EnvBase.html#torchrl.envs.EnvBase) 子类不应覆盖 reset。要修改的方法是 _reset()。





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




property reward_key¶
环境的奖励键。
默认情况下，这将是 "reward"。
如果环境中存在多个奖励键，此函数将抛出异常。




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




property reward_spec: TensorSpec¶
reward 规范。
reward_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)


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


如果奖励规范作为复合规范提供且有多个叶子，此函数将返回整个规范。
>>> 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¶
在环境中执行一次 rollout。
一旦任何包含的环境到达任何完成状态，函数将立即返回。

参数：

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


关键字参数：

auto_reset (bool, 可选) – 如果为 True，将在开始 rollout 前重置包含的环境。如果为 False，则 rollout 将从先前状态继续，这需要通过 tensordict 参数传递先前的 rollout 数据。默认值为 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。如果环境没有动态 specs，默认为 True，否则为 False。
tensordict (TensorDict, optional) – 如果 auto_reset 为 False，必须提供一个初始的 tensordict。Rollout 会检查这个 tensordict 是否有 done 标志，并（如有需要）在这些维度上重置环境。如果 tensordict 是 reset 的输出，通常不应该发生这种情况，但如果 tensordict 是上一个 rollout 的最后一步，则可能发生。当 auto_reset=True 时，如果需要将元数据传递给 reset 方法（例如无状态环境的批大小或设备），也可以提供一个 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 成为一个 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() 之后。

数据收集 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¶
设置环境的种子，并返回下一个要使用的种子（如果存在单个环境，则为输入的种子）。

参数：

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


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

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






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

参数：
mode (bool) – 是锁定（True）还是解锁（False） specs。默认为 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_b 本身有两个子模块 net_c 和 linear。然后 net_c 有一个子模块 conv。）
要用一个新的子模块 Linear 覆盖 Conv2d，你可以调用 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

参数：

target – 要查找的子模块的完全限定字符串名称。（请参阅上面示例了解如何指定完全限定字符串）。
module – 用于设置子模块的模块。


引发：

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







property shape¶
等同于 batch_size。




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




property specs: Composite¶
返回一个包含所有环境的 Composite 容器。
此特性允许创建环境，在一个单独的数据容器中检索所有 specs，然后从工作空间中擦除环境。




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。


返回：
包含模块整个状态的字典

返回类型：
字典


示例
>>> # xdoctest: +SKIP("undefined vars")
>>> module.state_dict().keys()
['bias', 'weight']






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




property state_spec: Composite¶
状态 spec。
必须是一个 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¶
在环境中执行一步。
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]¶
在环境中运行一步，并（部分地）根据需要重置。

参数：
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 包含更新的观测和其他任何相关的状态信息，其键根据环境的规格进行管理。
在内部，此方法利用预计算的 _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¶
移动和/或转换（cast）参数和缓冲区。
可以这样调用：


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，整型参数和缓冲区将被移动到该 device，但 dtype 保持不变。当设置 non_blocking 时，如果可能，它会尝试相对于主机异步转换/移动，例如，将具有 pinned memory 的 CPU Tensor 移动到 CUDA 设备。
示例如下。

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


参数：

device (torch.device) – 此模块中参数和缓冲区的目标设备。
dtype (torch.dtype) – 此模块中参数和缓冲区的目标浮点型或复数型 dtype。
tensor (torch.Tensor) – 一个 Tensor，其 dtype 和 device 是此模块中所有参数和缓冲区的目标 dtype 和 device。
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






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

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


参数：
device (int, 可选) – 如果指定，所有参数将被复制到该设备

返回：
self

返回类型：
Module






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

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

PendulumEnv¶

文档

教程

资源