GymLikeEnv

class torchrl.envs.GymLikeEnv(*args, **kwargs)

一个类 gym 的环境就是一个环境。

它的行为与 gym 环境类似，对于通用方法（特别是 reset 和 step）的预期行为是一致的。

一个 GymLikeEnv 有一个 step() 方法，其签名如下

env.step(action: np.ndarray) -> Tuple[Union[np.ndarray, dict], double, bool, *info]

其中输出分别是 observation、reward 和 done 状态。在此实现中，info 输出被丢弃（但特定键可以通过更新 info_dict_reader 读取，参见 set_info_dict_reader() 方法）。

默认情况下，第一个输出会写入输出 tensordict 的 "observation" 键值对，除非第一个输出是字典。在这种情况下，对于字典中的每个 "{key}"，相应的 observation 输出会放在 "{key}" 位置。

同样期望的是，env.reset() 返回的 observation 与 step 完成后观察到的 observation 类似。

property action_key: NestedKey

环境的 action 键。

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

如果环境中有多个 action 键，此函数将抛出异常。

property action_keys: list[tensordict._nestedkey.NestedKey]

环境的 action 键。

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

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

property action_spec: TensorSpec

action spec。

action_spec 总是以复合 spec 存储。

如果 action spec 作为简单 spec 提供，则返回该简单 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)

如果 action spec 作为复合 spec 提供且只包含一个叶节点，此函数将仅返回该叶节点。

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

如果 action spec 作为复合 spec 提供且包含多个叶节点，此函数将返回整个 spec。

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

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

>>> env.input_spec["full_action_spec"]

此属性是可变的。

示例

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

property action_spec_unbatched: TensorSpec

返回环境的 action spec，就像它没有批量维度一样。

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

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

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

参数:

• name (str) – 子模块的名称。可以使用给定名称从此模块访问子模块

• module (Module) – 要添加到模块的子模块。

add_truncated_keys() → EnvBase

向环境添加截断键。

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

从 action spec 生成所有可能的 actions。

这只适用于具有完全离散 actions 的环境。

参数:

tensordict (TensorDictBase, 可选) – 如果给定，将使用此 tensordict 调用 reset()。

返回:

一个 tensordict 对象，其中 “action” 条目已更新为所有可能 actions 的批次。actions 在前导维度中堆叠在一起。

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

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

参数:

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

示例

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

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

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

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

参数:

fn (Module -> None) – 要应用于每个子模块的函数

返回:

自身

返回类型:

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_register_info_dict(ignore_private: bool | None = True, *, info_dict_reader: Optional[BaseInfoDictReader] = None) → EnvBase

自动注册 info 字典并在需要时添加 TensorDictPrimer 实例。

如果未提供 info_dict_reader，则假定 info 字典中包含的所有信息都可以注册为 tensordict 中的数值。

此方法返回一个（可能已转换的）环境，在该环境中我们确保 torchrl.envs.utils.check_env_specs() 能够成功运行，无论 info 是否在重置时填充。

注意

此方法需要在环境中运行几次迭代以手动检查行为是否符合预期。

参数:

ignore_private (bool, 可选) – 如果为 True，则会忽略私有信息（以下划线开头）。默认为 True。

关键字参数:

info_dict_reader (BaseInfoDictReader, 可选) – 如果 info_dict_reader 预先已知，则为该 reader。与 set_info_dict_reader() 不同，此方法将创建运行 check_env_specs() 所需的 primer。

示例

>>> from torchrl.envs import GymEnv
>>> env = GymEnv("HalfCheetah-v4")
>>> # registers the info dict reader
>>> env.auto_register_info_dict()
GymEnv(env=HalfCheetah-v4, batch_size=torch.Size([]), device=cpu)
>>> env.rollout(3)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([3, 6]), device=cpu, dtype=torch.float32, is_shared=False),
        done: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([3, 17]), device=cpu, dtype=torch.float64, is_shared=False),
                reward: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                reward_ctrl: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False),
                reward_run: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False),
                terminated: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                truncated: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                x_position: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False),
                x_velocity: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False)},
            batch_size=torch.Size([3]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([3, 17]), device=cpu, dtype=torch.float64, is_shared=False),
        reward_ctrl: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False),
        reward_run: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False),
        terminated: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        truncated: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        x_position: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False),
        x_velocity: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False)},
    batch_size=torch.Size([3]),
    device=cpu,
    is_shared=False)

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 自动设置环境的 specifications (specs)。

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

参数:

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

关键字参数:

• tensordict (TensorDictBase, 可选) – 一个可选的 TensorDictBase 实例，用作 rollout 的初始状态。如果未提供，将调用环境的 reset 方法以获取初始状态。

• action_key (NestedKey 或 List[NestedKey], 可选) – 用于在 TensorDictBase 中标识 actions 的键。默认为 “action”。

• done_key (NestedKey 或 List[NestedKey], 或 None, 可选) – 用于在 TensorDictBase 中标识 done 信号的键。默认为 None，此时将尝试使用 [“done”, “terminated”, “truncated”] 作为可能的键。

• observation_key (NestedKey 或 List[NestedKey], 可选) – 用于在 TensorDictBase 中标识 observations 的键。默认为 “observation”。

• reward_key (NestedKey 或 List[NestedKey], 可选) – 用于在 TensorDictBase 中标识 rewards 的键。默认为 “reward”。

返回:

已更新 specs 的环境实例。

返回类型:

EnvBase

抛出:

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

property batch_dims: int

环境的批量维度数量。

property batch_locked: bool

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

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

property batch_size: Size

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

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

bfloat16() → T

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

注意

此方法会就地修改模块。

返回:

自身

返回类型:

Module

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

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

参数:

recurse (bool) – 如果为 True，则生成此模块和所有子模块的缓冲区。否则，仅生成此模块的直接成员缓冲区。

生成:

torch.Tensor – 模块缓冲区

示例

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

cardinality(tensordict: TensorDictBase | None = None) → int

动作空间的基数。

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

当 action spec 是变量时，此类很有用

• 动作数量可以未定义，例如 Categorical(n=-1)；

• 动作基数可能取决于动作掩码；

• 形状可以是动态的，如 Unbound(shape=(-1))。

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

参数:

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

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

通过简短的 rollout 结果测试环境 specs。

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

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

参数:

• env (EnvBase) – 需要针对数据检查 specs 的环境。

• return_contiguous (bool, 可选) – 如果为 True，则会以 return_contiguous=True 调用随机 rollout。这在某些情况下（例如，输入/输出形状异构）会失败。默认为 None（由是否存在动态 specs 决定）。

• check_dtype (bool, 可选) – 如果为 False，将跳过 dtype 检查。默认为 True。

• seed (整型, 可选) – 为了可复现性，可以设置一个种子。该种子将在 pytorch 中临时设置，然后随机数生成器 (RNG) 状态将被恢复到之前的值。对于环境，我们设置了种子，但由于将 RNG 状态恢复到之前的值并非大多数环境的特性，我们将其留给用户自行完成。默认为 None。

• tensordict (TensorDict, 可选) – 用于重置的可选 tensordict 实例。

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

children() → Iterator[Module]

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

生成:

Module – 一个子模块

close() → None

如果可能，关闭包含的环境。

compile(*args, **kwargs)

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

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

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

cpu() → T

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

注意

此方法会就地修改模块。

返回:

自身

返回类型:

Module

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

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

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

注意

此方法会就地修改模块。

参数:

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

返回:

自身

返回类型:

Module

property done_key

环境的 done 键。

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

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

property done_keys: list[tensordict._nestedkey.NestedKey]

环境的 done 键列表。

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

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

property done_keys_groups

done 键的列表，按重置键分组。

这是一个列表的列表。外层列表的长度与重置键的数量相同，内层列表包含可用于在重置键不存在时确定重置的 done 键（例如，done 和 truncated）。

property done_spec: TensorSpec

done 规范。

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

如果 done 规范作为简单规范提供，则返回此简单规范。

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

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

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

如果 done 规范作为组合规范提供且包含多个叶子，此函数将返回整个规范。

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

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

>>> env.output_spec["full_done_spec"]

此属性是可变的。

示例

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

property done_spec_unbatched: TensorSpec

返回环境的 done 规范，就像它没有批处理维度一样。

double() → T

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

注意

此方法会就地修改模块。

返回:

自身

返回类型:

Module

empty_cache()

清除所有缓存值。

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

eval() → T

将模块设置为评估模式。

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

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

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

返回:

自身

返回类型:

Module

extra_repr() → str

返回模块的额外表示。

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

fake_tensordict() → TensorDictBase

返回一个 fake tensordict，其键值对的形状、设备和 dtype 与环境 rollout 期间可以预期的相匹配。

float() → T

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

注意

此方法会就地修改模块。

返回:

自身

返回类型:

Module

forward(*args, **kwargs)

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

应由所有子类覆盖。

注意

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

property full_action_spec: Composite

完整的 action 规范。

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

示例

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

property full_action_spec_unbatched: Composite

返回环境的 action spec，就像它没有批量维度一样。

property full_done_spec: Composite

完整的 done 规范。

full_done_spec 是一个 Composite` 实例，包含所有 done 条目。它可用于生成结构模仿运行时获得的结构的 fake 数据。

示例

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

property full_done_spec_unbatched: Composite

返回环境的 done 规范，就像它没有批处理维度一样。

property full_observation_spec_unbatched: Composite

返回环境的 observation 规范，就像它没有批处理维度一样。

property full_reward_spec: Composite

完整的 reward 规范。

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

示例

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

property full_reward_spec_unbatched: Composite

返回环境的 reward 规范，就像它没有批处理维度一样。

property full_state_spec: Composite

完整的 state 规范。

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

示例

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

property full_state_spec_unbatched: Composite

返回环境的 state 规范，就像它没有批处理维度一样。

get_buffer(target: str) → Tensor

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

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

参数:

target – 要查找的缓冲区的完全限定字符串名称。（关于如何指定完全限定字符串，请参阅 get_submodule。）

返回:

由 target 引用的缓冲区

返回类型:

torch.Tensor

抛出:

AttributeError – 如果 target 字符串引用了无效路径或解析结果不是缓冲区

get_extra_state() → Any

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

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

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

返回:

要存储在模块 state_dict 中的任何额外状态

返回类型:

object

get_parameter(target: str) → Parameter

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

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

参数:

target – 要查找的 Parameter 的完全限定字符串名称。（关于如何指定完全限定字符串，请参阅 get_submodule。）

返回:

由 target 引用的 Parameter

返回类型:

torch.nn.Parameter

抛出:

AttributeError – 如果 target 字符串引用了无效路径或解析结果不是 nn.Parameter

get_submodule(target: str) → Module

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

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

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

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

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

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

参数:

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

返回:

由 target 引用的子模块

返回类型:

torch.nn.Module

抛出:

AttributeError – 如果 target 字符串引用了无效路径或解析结果不是 nn.Module

half() → T

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

注意

此方法会就地修改模块。

返回:

自身

返回类型:

Module

property input_spec: TensorSpec

输入规范 (Input spec)。

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

它包含

• “full_action_spec”: 输入 action 的规范

• “full_state_spec”: 所有其他环境输入的规范

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

示例

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

property input_spec_unbatched: Composite

返回环境的 input 规范，就像它没有批处理维度一样。

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

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

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

注意

此方法会就地修改模块。

参数:

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

返回:

自身

返回类型:

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 (字典) – 一个包含参数和持久缓冲区的字典。

• strict (布尔型, 可选) – 是否严格要求 state_dict 中的键与此模块的 state_dict() 函数返回的键匹配。默认值: True

• assign (bool, optional) – 设置为 False 时，保留当前模块中张量的属性，而设置为 True 时，保留 state dict 中的张量属性。唯一的例外是 requires_grad 字段。(默认值: False)

返回:

• missing_keys 是一个 str 列表，包含此模块预期

  但提供的 state_dict 中缺失的所有键。

• unexpected_keys 是一个 str 列表，包含此模块不预期

  但提供的 state_dict 中存在的所有键。

返回类型:

NamedTuple，包含 missing_keys 和 unexpected_keys 字段

注意

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

maybe_reset(tensordict: TensorDictBase) → TensorDictBase

检查输入 tensordict 的 done 键，并在环境已结束（done）的情况下根据需要重置环境。

参数:

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 (整型, 可选) – 如果指定，所有参数将被复制到该设备

返回:

自身

返回类型:

Module

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

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

参数:

• prefix (str) – 要添加到所有缓冲区名称前的缀。

• recurse (bool, optional) – 如果为 True，则产生此模块和所有子模块的缓冲区。否则，只产生直接属于此模块的缓冲区。默认为 True。

• remove_duplicate (bool, optional) – 是否移除结果中的重复缓冲区。默认为 True。

生成:

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

示例

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

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

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

生成:

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

示例

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

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

返回一个迭代器，遍历网络中的所有模块，同时产生模块的名称和模块本身。

参数:

• memo – 用于存储已添加到结果中的模块集合的备忘录

• prefix – 将添加到模块名称前的缀

• remove_duplicate – 是否移除结果中重复的模块实例

生成:

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

注意

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

示例

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

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

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

返回一个迭代器，遍历模块参数，同时产生参数的名称和参数本身。

参数:

• prefix (str) – 要添加到所有参数名称前的缀。

• recurse (bool) – 如果为 True，则产生此模块和所有子模块的参数。否则，只产生直接属于此模块的参数。

• remove_duplicate (bool, optional) – 是否移除结果中的重复参数。默认为 True。

生成:

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

示例

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

property observation_keys: list[tensordict._nestedkey.NestedKey]

环境的观察键。

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

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

property observation_spec: Composite

观察规范（Observation spec）。

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

在 TorchRL 中，即使它们严格来说不是“观察”，来自环境的所有 info、state、转换结果等输出都存储在 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 规范，就像它没有批处理维度一样。

property output_spec: TensorSpec

输出规范（Output spec）。

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

它包含

• “full_reward_spec”: reward 的规范

• “full_done_spec”: done 的规范

• “full_observation_spec”: 所有其他环境输出的规范

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

示例

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

property output_spec_unbatched: Composite

返回 env 的输出规范，就像它没有 batch 维度一样。

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” 键下。

read_action(action)

读取从输入 TensorDict 获取的动作，并将其转换为内部环境期望的格式。

参数:

action (Tensor or TensorDict) – 要在环境中执行的动作。

Returns: 与内部环境兼容的动作格式。

read_done(terminated: bool | None = None, truncated: bool | None = None, done: bool | None = None) → Tuple[bool | np.ndarray, bool | np.ndarray, bool | np.ndarray, bool]

Done 状态读取器。

在 torchrl 中，“done” 信号意味着轨迹已到达终点，可能是因为中断或终止。Truncated 意味着回合提前被中断。Terminated 意味着任务完成，回合结束。

参数:

• terminated (np.ndarray, boolean or other format) – 从环境获取的完成状态。"terminated" 等同于 gymnasium 中的 "termination"：表示环境已到达回合终点，此后任何数据应视为无意义。默认为 None。

• truncated (bool or None) – 提前截断信号。默认为 None。

• done (bool or None) – 轨迹结束信号。对于未明确指定 "done" 条目是指 "terminated" 还是 "truncated" 的 envs，此值应作为备选值。默认为 None。

Returns: 包含 4 个布尔值/张量值的元组，

• 一个 terminated 状态，

• 一个 truncated 状态，

• 一个 done 状态，

• 一个布尔值，指示是否应中断 frame\_skip 循环。

read_obs(observations: Union[Dict[str, Any], Tensor, ndarray]]) → Dict[str, Any]

读取环境中的观察结果，并返回与输出 TensorDict 兼容的观察结果。

参数:

observations (observation under a format dictated by the inner env) – 要读取的观察结果。

read_reward(reward)

读取 reward 并将其映射到 reward 空间。

参数:

reward (torch.Tensor or TensorDict) – 要映射的 reward。

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

在模块上注册一个反向钩子（backward hook）。

此函数已被弃用，请优先使用 register_full_backward_hook()。此函数的行为将在未来版本中改变。

返回:

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

返回类型:

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 hook）。

每次 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 函数的 kwargs。默认值： 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 函数的 kwargs。如果钩子修改了输入，则应同时返回 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 函数的 kwargs。默认值： False

返回:

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

返回类型:

torch.utils.hooks.RemovableHandle

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

在模块上注册一个反向钩子（backward hook）。

每次计算相对于模块的梯度时，都会调用该钩子，也就是说，仅当计算相对于模块输出的梯度时，该钩子才会执行。钩子的签名应如下所示：

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

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

出于技术原因，将此钩子应用于 Module 时，传递给 Module 的每个 Tensor 的 forward 函数将接收一个视图。同样，调用方将接收 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。对于所有非 Tensor 参数， grad_output 中的条目将为 None。

出于技术原因，将此钩子应用于 Module 时，传递给 Module 的每个 Tensor 的 forward 函数将接收一个视图。同样，调用方将接收 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) 中注册环境。

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

• 在使用 Gym 的框架中集成 TorchRL-first 环境；

• 在使用 Gym 的框架中集成其他环境（例如，DeepMind Control、Brax、Jumanji 等）。

参数:

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

  如果提供，这些键将用于构建 info 字典，并从观察键中排除。此参数可在调用 make() 时传递（参见下面的示例）。

  警告

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

• backend (str, optional) – 后端。可以是 “gym” 或 “gymnasium”，或任何其他与 set_gym_backend 兼容的后端。

• to_numpy (bool, optional) – 如果为 True，则对 step 和 reset 的调用结果将被映射到 numpy 数组。默认为 False（结果为 tensors）。此参数可在调用 make() 时传递（参见下面的示例）。

• reward_threshold (float, optional) – [Gym kwarg] 达到已学习环境所需的奖励阈值。

• nondeterministic (bool, optional) – [Gym kwarg] 如果环境是非确定性的（即使知道初始种子和所有动作）。默认为 False。

• max_episode_steps (int, optional) – [Gym kwarg] 截断前最大的 episode 步数。由 Time Limit wrapper 使用。

• order_enforce (bool, optional) – [Gym >= 0.14] 是否应应用 order enforcer wrapper 以确保用户按正确顺序运行函数。默认为 True。

• autoreset (bool, optional) – [Gym >= 0.14] 是否应添加 autoreset wrapper，以便不需要调用 reset。默认为 False。

• disable_env_checker – [Gym >= 0.14] 是否应禁用环境检查器。默认为 False。

• apply_api_compatibility – [Gym >= 0.26] 是否应用 StepAPICompatibility wrapper。默认为 False。

• **kwargs – 传递给环境构造函数的任意关键字参数。

注意

TorchRL 的环境没有 "info" 字典的概念，因为 TensorDict 提供了大多数训练设置所需的所有存储要求。不过，您可以使用 info_keys 参数对哪些内容应被视为观察，哪些内容应被视为 info 进行精细控制。

示例

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

注意

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

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

register_load_state_dict_post_hook(hook)

注册一个在模块的 load_state_dict() 调用后运行的后钩子。

其签名应如下所示：

hook(module, incompatible_keys) -> None

module 参数是注册此钩子的当前模块， incompatible_keys 参数是一个 NamedTuple，包含 missing_keys 和 unexpected_keys 属性。 missing_keys 是一个包含缺失键的 list， unexpected_keys 是一个包含未预期键的 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。

返回:

自身

返回类型:

Module

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

重置环境。

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

参数:

• tensordict (TensorDictBase, optional) – 用于包含生成的新观察的 tensordict。在某些情况下，此输入也可用于向 reset 函数传递参数。

• kwargs (optional) – 要传递给原生 reset 函数的其他参数。

返回:

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

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

>>> 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 规范，就像它没有批处理维度一样。

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 (可调用对象, 可选) – 用于计算期望动作的可调用对象。如果未提供策略，将使用 env.rand_step() 计算动作。策略可以是任何可调用对象，它可以读取 tensordict 或按照 env.observation_spec.keys() **排序**的完整观测条目序列。 默认为 None。

• callback (Callable[[TensorDict], Any], 可选) – 在每次迭代时使用给定的 TensorDict 调用的函数。默认为 None。callback 的输出不会被收集，如果数据需要在 rollout 调用之外保留，用户有责任在 callback 调用内部保存任何结果。

关键字参数:

• auto_reset (bool, 可选) – 如果为 True，包含的环境将在开始 Rollout 前重置。如果为 False，则 Rollout 将从之前的状态继续，这需要将带有之前 Rollout 结果的 tensordict 参数传入。默认为 True。

• auto_cast_to_device (bool, 可选) – 如果为 True，在使用策略之前，tensordict 的设备将自动转换为策略的设备。默认为 False。

• break_when_any_done (bool) – 如果为 True，当任何包含的环境到达任一“完成”状态时中断。如果为 False，则已完成的环境将自动重置。默认为 True。

• break_when_all_done (bool, 可选) – 如果为 True，如果所有包含的环境都到达任一“完成”状态时中断。如果为 False，如果至少一个环境到达任一“完成”状态时中断。默认为 False。

• return_contiguous (bool) – 如果为 False，将返回一个 LazyStackedTensorDict。如果环境没有动态规范，默认为 True，否则为 False。

• tensordict (TensorDict, 可选) – 如果 auto_reset 为 False，必须提供一个初始 tensordict。Rollout 将检查此 tensordict 是否带有“完成”标志，并在需要时在相应维度上重置环境。如果 tensordict 是 reset 的输出，通常不会发生这种情况，但如果 tensordict 是之前 Rollout 的最后一步，则可能发生。即使 auto_reset=True，也可以提供 tensordict，如果需要将元数据传递给 reset 方法，例如无状态环境的批量大小或设备。

• set_truncated (bool, 可选) – 如果为 True，在 Rollout 完成后，"truncated" 和 "done" 键将被设置为 True。如果在 done_spec 中找不到 "truncated" 键，将引发异常。可以通过 env.add_truncated_keys 设置截断键。默认为 False。

• trust_policy (bool, 可选) – 如果为 True，非 TensorDictModule 策略将被信任并被视为与收集器兼容。对于 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)

在某些情况下，无法获得 contiguous tensordict，因为它们无法堆叠。这可能发生在每一步返回的数据具有不同形状时，或当不同的环境一起执行时。在这种情况下，设置 return_contiguous=False 将使返回的 tensordict 成为 tensordict 的一个懒加载堆叠（lazy stack）。

非 contiguous 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_info_dict_reader(info_dict_reader: BaseInfoDictReader | None = None, ignore_private: bool =True) → GymLikeEnv

设置一个 info_dict_reader 函数。

此函数应将一个 info_dict 字典以及 step 函数返回的 tensordict 作为输入，并以特定方式将值从一个写入另一个。

参数:

• info_dict_reader (Callable[[Dict], TensorDict], 可选) – 一个可调用对象，接收输入字典和输出 tensordict 作为参数。此函数应原地修改 tensordict。如果未提供，将使用 default_info_dict_reader。

• ignore_private (bool, 可选) – 如果为 True，则会忽略私有信息（以下划线开头）。默认为 True。

返回值：已注册 dict_reader 的同一个环境实例。

注意

自动注册 info_dict reader 应通过 auto_register_info_dict() 完成，这将确保环境规范（env specs）得到正确构建。

示例

>>> from torchrl.envs import default_info_dict_reader
>>> from torchrl.envs.libs.gym import GymWrapper
>>> reader = default_info_dict_reader(["my_info_key"])
>>> # assuming "some_env-v0" returns a dict with a key "my_info_key"
>>> env = GymWrapper(gym.make("some_env-v0")).set_info_dict_reader(info_dict_reader=reader)
>>> tensordict = env.reset()
>>> tensordict = env.rand_step(tensordict)
>>> assert "my_info_key" in tensordict.keys()

set_seed(seed: int | None = None, static_seed: bool =False) → int | None

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

参数:

• seed (int) – 要设置的随机种子。种子只在环境内部局部设置。要处理全局种子，请参阅 manual_seed()。

• static_seed (bool, 可选) – 如果为 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_c 和 linear。net_c 然后有一个子模块 conv。）

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

参数:

• target – 要查找的子模块的完全限定字符串名称。（关于如何指定完全限定字符串，请参见上例。）

• 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, 可选) – 如果提供，模块的状态将更新到该字典中并返回该字典对象。否则，将创建一个 OrderedDict 并返回。默认值：None。

• prefix (str, 可选) – 添加到参数名和缓冲区名的前缀，用于组成 state_dict 中的键。默认值：''。

• keep_vars (bool, 可选) – 默认情况下，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

状态规范（State 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

返回环境的 state 规范，就像它没有批处理维度一样。

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。此外，此方法只会将浮点或复数参数和缓冲区转换（cast）为 dtype（如果给定）。整数参数和缓冲区如果给定 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 参数和缓冲区的目标内存格式（仅限关键字参数）

返回:

自身

返回类型:

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

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

参数:

• device (torch.device) – 此模块中参数和缓冲区的目标设备。

• recurse (bool) – 是否应将子模块的参数和缓冲区递归地移动到指定设备。

返回:

自身

返回类型:

Module

train(mode: bool = True) → T

将模块设置为训练模式。

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

参数:

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

返回:

自身

返回类型:

Module

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

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

注意

此方法会就地修改模块。

参数:

dst_type (type 或 string) – 目标类型

返回:

自身

返回类型:

Module

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

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

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

注意

此方法会就地修改模块。

参数:

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

返回:

自身

返回类型:

Module

zero_grad(set_to_none: bool = True) → None

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

有关更多上下文，请参阅 torch.optim.Optimizer 下的类似函数。

参数:

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