TicTacToeEnv¶

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

井字棋实现。

关键字参数:

single_player (bool, optional) – 是否需要考虑一个或两个玩家。 single_player=True 表示 "player1" 随机行动。如果为 False (默认)，则每回合由两个玩家中的一个行动。
device (torch.device, optional) – 存放张量的设备。默认为 None (默认设备)。

环境是无状态的。要在多个批次上运行它，请调用

>>> env.reset(TensorDict(batch_size=desired_batch_size))

如果存在 "mask" 入口，rand_action 会考虑它来生成下一个动作。在此环境中执行的任何策略都应考虑此掩码以及玩家的回合 (存储在 "turn" 输出入口中)。

规范 (Specs)

>>> print(env.specs)
Composite(
    output_spec: Composite(
        full_observation_spec: Composite(
            board: Categorical(
                shape=torch.Size([3, 3]),
                space=DiscreteBox(n=2),
                dtype=torch.int32,
                domain=discrete),
            turn: Categorical(
                shape=torch.Size([1]),
                space=DiscreteBox(n=2),
                dtype=torch.int32,
                domain=discrete),
            mask: Categorical(
                shape=torch.Size([9]),
                space=DiscreteBox(n=2),
                dtype=torch.bool,
                domain=discrete),
            shape=torch.Size([])),
        full_reward_spec: Composite(
            player0: 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)),
                    dtype=torch.float32,
                    domain=continuous),
                shape=torch.Size([])),
            player1: 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)),
                    dtype=torch.float32,
                    domain=continuous),
                shape=torch.Size([])),
            shape=torch.Size([])),
        full_done_spec: Composite(
            done: Categorical(
                shape=torch.Size([1]),
                space=DiscreteBox(n=2),
                dtype=torch.bool,
                domain=discrete),
            terminated: Categorical(
                shape=torch.Size([1]),
                space=DiscreteBox(n=2),
                dtype=torch.bool,
                domain=discrete),
            truncated: Categorical(
                shape=torch.Size([1]),
                space=DiscreteBox(n=2),
                dtype=torch.bool,
                domain=discrete),
            shape=torch.Size([])),
        shape=torch.Size([])),
    input_spec: Composite(
        full_state_spec: Composite(
            board: Categorical(
                shape=torch.Size([3, 3]),
                space=DiscreteBox(n=2),
                dtype=torch.int32,
                domain=discrete),
            turn: Categorical(
                shape=torch.Size([1]),
                space=DiscreteBox(n=2),
                dtype=torch.int32,
                domain=discrete),
            mask: Categorical(
                shape=torch.Size([9]),
                space=DiscreteBox(n=2),
                dtype=torch.bool,
                domain=discrete), shape=torch.Size([])),
        full_action_spec: Composite(
            action: Categorical(
                shape=torch.Size([1]),
                space=DiscreteBox(n=9),
                dtype=torch.int64,
                domain=discrete),
            shape=torch.Size([])),
        shape=torch.Size([])),
    shape=torch.Size([]))

要运行一个虚拟 rollout，请执行以下命令

示例

>>> env = TicTacToeEnv()
>>> env.rollout(10)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.int64, is_shared=False),
        board: Tensor(shape=torch.Size([9, 3, 3]), device=cpu, dtype=torch.int32, is_shared=False),
        done: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        mask: Tensor(shape=torch.Size([9, 9]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                board: Tensor(shape=torch.Size([9, 3, 3]), device=cpu, dtype=torch.int32, is_shared=False),
                done: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                mask: Tensor(shape=torch.Size([9, 9]), device=cpu, dtype=torch.bool, is_shared=False),
                player0: TensorDict(
                    fields={
                        reward: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.float32, is_shared=False)},
                    batch_size=torch.Size([9]),
                    device=None,
                    is_shared=False),
                player1: TensorDict(
                    fields={
                        reward: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.float32, is_shared=False)},
                    batch_size=torch.Size([9]),
                    device=None,
                    is_shared=False),
                terminated: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                truncated: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                turn: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.int32, is_shared=False)},
            batch_size=torch.Size([9]),
            device=None,
            is_shared=False),
        terminated: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        truncated: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        turn: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.int32, is_shared=False)},
    batch_size=torch.Size([9]),
    device=None,
    is_shared=False)

property action_key: NestedKey¶

环境的动作键。

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

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

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

环境的动作键。

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

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

property action_spec: TensorSpec¶

action 规范。

action_spec 始终存储为复合规范 (composite 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¶: 向环境添加截断键 (truncated keys)。

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

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

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

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

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

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

参数:: transform (Transform or 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)
返回类型:: 模块

示例

>>> @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, optional) – 一个可选的 TensorDictBase 实例，用作 rollout 的初始状态。如果未提供，将调用环境的 reset 方法获取初始状态。
action_key (NestedKey or List[NestedKey], optional) – 用于在 TensorDictBase 中识别动作的键。默认为“action”。
done_key (NestedKey or List[NestedKey], optional) – 用于在 TensorDictBase 中识别完成信号的键。默认为 None，此时将尝试使用 [“done”, “terminated”, “truncated”] 作为潜在键。
observation_key (NestedKey or List[NestedKey], optional) – 用于在 TensorDictBase 中识别观测的键。默认为“observation”。
reward_key (NestedKey or List[NestedKey], optional) – 用于在 TensorDictBase 中识别奖励的键。默认为“reward”。

返回:

返回:

返回类型:

具有更新规范的环境实例。

引发:

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

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

property batch_size: Size¶

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

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

bfloat16() → T¶

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

注意

此方法会就地修改模块。

返回:: 自身 (self)
返回类型:: 模块

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

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

参数:: recurse (bool) – 如果为 True，则生成此模块和所有子模块的缓冲区。否则，仅生成作为此模块直接成员的缓冲区。
生成 (Yields):: 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¶

动作空间的基数 (cardinality)。

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

当动作规范是可变的时，此类非常有用：

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

在这些情况下，应该重写 cardinality()。

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

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

根据短 rollout 的结果测试环境规范。

此测试函数应用作 sanity check，用于检查用 torchrl 的 EnvBase 子类包装的环境：期望数据与收集到的数据之间的任何差异都应引发断言错误。

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

参数:

env (EnvBase) – 需要对照数据检查规范的环境。
return_contiguous (bool, optional) – 如果为 True，随机 rollout 将以 return_contiguous=True 调用。在某些情况下（例如，输入/输出形状异构）这将失败。默认为 None（由动态规范的存在确定）。
check_dtype (bool, optional) – 如果为 False，将跳过 dtype 检查。默认为 True。
seed (int, optional) – 为了重现性，可以设置种子。种子将暂时在 pytorch 中设置，然后 RNG 状态将恢复到之前状态。对于环境，我们设置种子，但由于大多数环境不具备将 rng 状态恢复到之前状态的功能，我们将其留给用户完成。默认为 None。
tensordict (TensorDict, optional) – 可选的 tensordict 实例，用于重置。

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

children() → Iterator[Module]¶

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

生成 (Yields):: Module – 子模块

compile(*args, **kwargs)¶

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

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

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

cpu() → T¶

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

注意

此方法会就地修改模块。

返回:: 自身 (self)
返回类型:: 模块

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

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

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

注意

此方法会就地修改模块。

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

property done_key¶

环境的完成键 (done key)。

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

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

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

环境的完成键 (done keys)。

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

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

property done_keys_groups¶

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

这是一个列表的列表。外层列表的长度与重置键的数量相同，内层列表包含可以读取以确定何时进行重置的完成键（例如，done 和 truncated），当它们不存在时。

property done_spec: TensorSpec¶

done 规范。

done_spec 始终存储为复合规范 (composite 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)

属性 done_spec_unbatched: TensorSpec¶: 返回环境的 done spec，如同它没有批量维度一样。

double() → T¶

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

注意

此方法会就地修改模块。

返回:: 自身 (self)
返回类型:: 模块

empty_cache()¶

清除所有缓存值。

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

eval() → T¶

将模块设置为评估模式。

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

这等同于调用 self.train(False)。

有关 .eval() 与可能与之混淆的几个类似机制之间的比较，请参阅 Locally disabling gradient computation。

返回:: 自身 (self)
返回类型:: 模块

extra_repr() → str¶

返回模块的额外表示。

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

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

float() → T¶

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

注意

此方法会就地修改模块。

返回:: 自身 (self)
返回类型:: 模块

forward(*args, **kwargs)¶

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

应由所有子类重写。

注意

虽然前向传播的逻辑需要在本函数中定义，但之后应调用 Module 实例，而不是直接调用此函数，因为前者会负责运行已注册的钩子（hooks），而后者会静默忽略它们。

属性 full_action_spec: Composite¶

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

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

示例

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

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

属性 full_done_spec: Composite¶

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

full_done_spec 是一个 Composite` 实例，包含所有完成状态条目（done entries）。它可用于生成结构与运行时获得的结构相似的伪造数据。

示例

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

属性 full_done_spec_unbatched: Composite¶: 返回环境的 done spec，如同它没有批量维度一样。

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

属性 full_reward_spec: Composite¶

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

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

示例

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

属性 full_reward_spec_unbatched: Composite¶: 返回环境的奖励规范（reward spec），如同它没有批量维度一样。

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

属性 full_state_spec_unbatched: Composite¶: 返回环境的状态规范（state spec），如同它没有批量维度一样。

get_buffer(target: str) → Tensor¶

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

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

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

get_extra_state() → Any¶

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

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

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

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

get_parameter(target: str) → Parameter¶

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

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

参数:: target (str) – 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回:: 由 target 引用的 Parameter
返回类型:: torch.nn.Parameter
引发:: AttributeError – 如果 target 字符串引用了无效路径或解析为非 nn.Parameter 的对象

get_submodule(target: str) → Module¶

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

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

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

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

要检查我们是否有 linear 子模块，可以调用 get_submodule("net_b.linear")。要检查我们是否有 conv 子模块，可以调用 get_submodule("net_b.net_c.conv")。

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

参数:: target (str) – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上述示例。）
返回:: 由 target 引用的子模块
返回类型:: torch.nn.Module
引发:: AttributeError – 如果 target 字符串引用了无效路径或解析为非 nn.Module 的对象

half() → T¶

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

注意

此方法会就地修改模块。

返回:: 自身 (self)
返回类型:: 模块

属性 input_spec: TensorSpec¶

输入规范（Input spec）。

包含所有环境输入数据规范的复合规范（composite 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([]))

属性 input_spec_unbatched: Composite¶: 返回环境的输入规范（input spec），如同它没有批量维度一样。

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

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

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

注意

此方法会就地修改模块。

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

属性 is_spec_locked¶

获取环境的规范（specs）是否已锁定。

此属性可以直接修改。

返回:: 如果规范已锁定，则为 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，则除非 get_swap_module_params_on_conversion() 为 True，否则必须在调用 load_state_dict 后创建优化器。

参数:

state_dict (dict) – 包含参数和持久缓冲区的字典。
strict (bool, 可选) – 是否严格要求 state_dict 中的键与当前模块 state_dict() 函数返回的键匹配。默认值：True
assign (bool, 可选) – 设置为 False 时，保留当前模块中张量的属性，而设置为 True 时，保留 state dict 中张量的属性。唯一的例外是 Parameter 的 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 keys），并在需要时，在环境已完成（done）的地方重置环境。

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

modules() → Iterator[Module]¶

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

生成 (Yields):: 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)
返回类型:: 模块

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

返回一个迭代器，遍历模块缓冲区，同时生成缓冲区的名称和缓冲区本身。

参数:

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

生成 (Yields):

(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]]¶

返回一个迭代器，遍历直接子模块，同时生成模块的名称和模块本身。

生成 (Yields):: (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 – 是否移除结果中的重复模块实例

生成 (Yields):

(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。

生成 (Yields):

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

示例

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

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

环境的观察键。

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

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

property observation_spec: Composite¶

观察规范。

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

在 TorchRL 中，即使它们严格来说不是“观察”，环境中输出的所有信息（info）、状态（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¶: 返回环境的观察规范（observation spec），如同它没有批量维度一样。

property output_spec: TensorSpec¶

输出规范。

包含环境中所有数据输出规范的 Composite 规范。

它包含：

“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，则生成此模块及其所有子模块的参数。否则，只生成直接属于此模块的参数。
生成 (Yields):: 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: Optional[TensorDictBase] = None)[source]¶

根据 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¶

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

此函数已被弃用，请改用 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 or 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，则钩子将接收传递给 forward 函数的关键字参数。默认值：False
always_call (bool) – 如果为 True，无论调用 Module 时是否引发异常，钩子都将运行。默认值：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，则钩子将接收传递给 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 只对应于作为位置参数给定的输入，所有关键字参数都被忽略。对于所有非 Tensor 参数，grad_input 和 grad_output 中的条目将为 None。

出于技术原因，当此钩子应用于 Module 时，其 forward 函数将接收传递给 Module 的每个 Tensor 的视图。类似地，调用者将接收 Module 的 forward 函数返回的每个 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 时，其 forward 函数将接收传递给 Module 的每个 Tensor 的视图。类似地，调用者将接收 Module 的 forward 函数返回的每个 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优先的环境整合到使用 Gym 的框架中；
将其他环境（例如，DeepMind Control、Brax、Jumanji 等）整合到使用 Gym 的框架中。

参数:

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

关键字参数:

entry_point (callable, optional) –

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

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

警告

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

示例

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

注册一个后置钩子，在调用模块的 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。

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

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

register_load_state_dict_pre_hook(hook)¶

注册一个预置钩子，在调用模块的 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() 的别名。

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

向模块添加一个参数。

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

参数:

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

register_state_dict_post_hook(hook)¶

为 state_dict() 方法注册一个后置钩子。

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

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

register_state_dict_pre_hook(hook)¶

为 state_dict() 方法注册一个预置钩子。

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

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

requires_grad_(requires_grad: bool = True) → T¶

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

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

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

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

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

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

重置环境。

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

参数:

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

返回:

一个 tensordict（如果存在输入 tensordict，则为输入 tensordict），它会被结果观察就地修改。

注意

reset 不应由 EnvBase 子类覆盖。要修改的方法是 _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¶: 返回环境的奖励规范（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¶

在环境中执行推演。

参数:

只要包含的任何环境达到任何完成状态，函数将立即返回。
max_steps (int) – 要执行的最大步数。如果环境在执行 max_steps 之前达到完成状态，则实际步数可能会更少。
policy (callable, optional) – 用于计算所需动作的可调用对象。如果未提供策略，将使用 env.rand_step() 调用动作。策略可以是任何可调用对象，它读取 tensordict 或按 env.observation_spec.keys() 排序的整个观察条目序列。默认为 None。

关键字参数:

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

返回:

包含结果轨迹的TensorDict对象。

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

rollout 对于显示环境的数据结构非常方便。

示例

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

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

示例

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

在某些情况下，无法获得连续的 tensordict，因为它们无法堆叠。这可能发生在每个步骤返回的数据具有不同形状时，或者当不同的环境一起执行时。在这种情况下，return_contiguous=False 将使得返回的 tensordict 成为一个 tensordict 的惰性堆叠。

非连续采样的示例

>>> 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']

采样序列可以在循环中使用以模拟数据收集。为此，你需要将前一个采样序列中经过 step_mdp() 处理后的最后一个 tensordict 作为输入传递。

数据收集采样的示例

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

返回:

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

返回类型:

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

property set_spec_lock_(mode: bool = True) → EnvBase¶

锁定或解锁环境的规格。

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

另请参阅

锁定环境规范.

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 (str) – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上述示例。）
module – 用于设置子模块的模块。

引发:

ValueError – 如果目标字符串为空
AttributeError – 如果 target 字符串引用了无效路径或解析为非 nn.Module 的对象

property shape¶: 等同于 batch_size。

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

property specs: Composite¶

返回一个 Composite 容器，其中包含所有的环境规格。

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

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

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

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

注意

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

警告

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

警告

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

参数:

destination (dict, optional) – 如果提供，模块的状态将更新到该字典中，并返回同一对象。否则，将创建一个 OrderedDict 并返回。默认为 None。
prefix (str, optional) – 添加到参数和缓冲区名称前面的前缀，用于构成 state_dict 中的键。默认为 ''。
keep_vars (bool, optional) – 默认情况下，state dict 中返回的 Tensor 会从 autograd 中分离。如果设置为 True，将不执行分离操作。默认为 False。

返回:

包含模块整体状态的字典

返回类型:

dict

示例

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

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

环境的状态键。

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

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

property state_spec: Composite¶

状态规格。

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

在 TorchRL 中，即使它们严格来说不是“状态”，所有不是动作的环境输入都存储在 state_spec 中。

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

示例

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

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

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() 方法的输入数据结构。

此方法可以轻松编写不停止的采样函数。

示例

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

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

可以这样调用：

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，但数据类型不变。当设置了 non_blocking 时，如果可能，它会尝试相对于主机异步地进行转换/移动，例如，将具有固定内存的 CPU 张量移动到 CUDA 设备。

参见下面的示例。

注意

此方法会就地修改模块。

参数:

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

返回:

自身 (self)

返回类型:

模块

示例

>>> # xdoctest: +IGNORE_WANT("non-deterministic")
>>> linear = nn.Linear(2, 2)
>>> linear.weight
Parameter containing:
tensor([[ 0.1913, -0.3420],
        [-0.5113, -0.2325]])
>>> linear.to(torch.double)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1913, -0.3420],
        [-0.5113, -0.2325]], dtype=torch.float64)
>>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1)
>>> gpu1 = torch.device("cuda:1")
>>> linear.to(gpu1, dtype=torch.half, non_blocking=True)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1914, -0.3420],
        [-0.5112, -0.2324]], dtype=torch.float16, device='cuda:1')
>>> cpu = torch.device("cpu")
>>> linear.to(cpu)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1914, -0.3420],
        [-0.5112, -0.2324]], dtype=torch.float16)

>>> linear = nn.Linear(2, 2, bias=None).to(torch.cdouble)
>>> linear.weight
Parameter containing:
tensor([[ 0.3741+0.j,  0.2382+0.j],
        [ 0.5593+0.j, -0.4443+0.j]], dtype=torch.complex128)
>>> linear(torch.ones(3, 2, dtype=torch.cdouble))
tensor([[0.6122+0.j, 0.1150+0.j],
        [0.6122+0.j, 0.1150+0.j],
        [0.6122+0.j, 0.1150+0.j]], dtype=torch.complex128)

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

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

参数:

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

返回:

自身 (self)

返回类型:

模块

train(mode: bool = True) → T¶

将模块设置为训练模式。

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

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

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

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

注意

此方法会就地修改模块。

参数:: dst_type (type or string) – 所需的目标类型
返回:: 自身 (self)
返回类型:: 模块

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

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

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

注意

此方法会就地修改模块。

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

zero_grad(set_to_none: bool = True) → None¶

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

参见 torch.optim.Optimizer 下的类似函数以获取更多上下文。

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

TicTacToeEnv¶

文档

教程

资源