GymLikeEnv

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

一个类似 gym 的环境。

它的行为类似于 gym 环境，因为期望常见方法（特别是重置和步骤）执行的操作。

一个 GymLikeEnv 具有以下签名的 step() 方法

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

其中输出分别是观察结果、奖励和完成状态。在此实现中，info 输出被丢弃（但可以通过更新 info_dict_reader 来读取特定键，请参阅 set_info_dict_reader() 方法）。

默认情况下，第一个输出写入输出 tensordict 中的“observation”键值对，除非第一个输出是字典。在这种情况下，每个观察结果输出都将放在每个 f"{key}" 的对应 f"{key}" 位置。

还期望 env.reset() 返回类似于完成步骤后观察到的观察结果。

property action_key: NestedKey

环境的动作键。

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

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

property action_keys: List[NestedKey]

环境的动作键。

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

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

property action_spec: TensorSpec

action 规范。

action_spec 始终存储为复合规范。

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

>>> env.action_spec = UnboundedContinuousTensorSpec(1)
>>> env.action_spec
UnboundedContinuousTensorSpec(
    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 = CompositeSpec({"nested": {"action": UnboundedContinuousTensorSpec(1)}})
>>> env.action_spec
UnboundedContinuousTensorSpec(
    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 = CompositeSpec({"nested": {"action": UnboundedContinuousTensorSpec(1), "another_action": DiscreteTensorSpec(1)}})
>>> env.action_spec
CompositeSpec(
    nested: CompositeSpec(
        action: UnboundedContinuousTensorSpec(
            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: DiscreteTensorSpec(
            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
BoundedTensorSpec(
    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)

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

向当前模块添加子模块。

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

参数:

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

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

add_truncated_keys() → EnvBase

向环境添加截断键。

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

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

参数:

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

示例

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

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

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

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

参数:

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

返回值:

自身

返回类型:

模块

示例

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

自动注册信息字典，并在需要时附加TensorDictPrimer实例。

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

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

注意

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

参数:

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

关键字参数:

info_dict_reader (BaseInfoDictReader, 可选) – info_dict_reader，如果事先已知。与set_info_dict_reader()不同，此方法将创建必要的引导程序以使check_env_specs()运行。

示例

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

property batch_locked: bool

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

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

property batch_size: Size

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

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

bfloat16() → T

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

注意

此方法就地修改模块。

返回值:

自身

返回类型:

模块

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)

children() → Iterator[Module]

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

产量:

Module – 子模块

close() → None

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

compile(*args, **kwargs)

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

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

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

cpu() → T

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

注意

此方法就地修改模块。

返回值:

自身

返回类型:

模块

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

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

这还会使关联的参数和缓冲区成为不同的对象。因此，如果模块在GPU上运行同时被优化，则应在构建优化器之前调用它。

注意

此方法就地修改模块。

参数:

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

返回值:

自身

返回类型:

模块

property done_key

环境的done键。

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

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

property done_keys: List[NestedKey]

环境的done键。

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

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

property done_keys_groups

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

这是一个列表的列表。外部列表的长度为重置键，内部列表包含done键（例如，done和truncated），当重置键不存在时，可以读取这些键来确定重置。

property done_spec: TensorSpec

的done规范。

的done_spec始终存储为复合规范。

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

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

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

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

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

>>> env.done_spec = CompositeSpec({"nested": {"done": DiscreteTensorSpec(2, dtype=torch.bool), "another_done": DiscreteTensorSpec(2, dtype=torch.bool)}})
>>> env.done_spec
CompositeSpec(
    nested: CompositeSpec(
        done: DiscreteTensorSpec(
            shape=torch.Size([]),
            space=DiscreteBox(n=2),
            device=cpu,
            dtype=torch.bool,
            domain=discrete),
        another_done: DiscreteTensorSpec(
            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
DiscreteTensorSpec(
    shape=torch.Size([1]),
    space=DiscreteBox(n=2),
    device=cpu,
    dtype=torch.bool,
    domain=discrete)

double() → T

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

注意

此方法就地修改模块。

返回值:

自身

返回类型:

模块

empty_cache()

擦除所有缓存的值。

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

eval() → T

将模块设置为评估模式。

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

这等效于 self.train(False)。

参见 局部禁用梯度计算，了解 .eval() 与一些可能与其混淆的类似机制之间的比较。

返回值:

自身

返回类型:

模块

extra_repr() → str

设置模块的额外表示。

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

fake_tensordict() → TensorDictBase

返回一个假的 tensordict，其键值对在形状、设备和数据类型方面与环境展开过程中可以预期到的匹配。

float() → T

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

注意

此方法就地修改模块。

返回值:

自身

返回类型:

模块

forward(tensordict: TensorDictBase) → TensorDictBase

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

应该由所有子类覆盖。

注意

尽管前向传递的步骤需要在此函数中定义，但应随后调用 Module 实例，而不是这个函数，因为前者负责运行注册的钩子，而后者则会静默地忽略它们。

property full_action_spec: CompositeSpec

完整的动作规格。

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

示例

>>> from torchrl.envs import BraxEnv
>>> for envname in BraxEnv.available_envs:
...     break
>>> env = BraxEnv(envname)
>>> env.full_action_spec

CompositeSpec(

action: BoundedTensorSpec(

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_done_spec: CompositeSpec

完整的完成规格。

full_done_spec 是一个 CompositeSpec` 实例，包含所有完成条目。它可以用来生成一个结构与运行时获得的结构相似的伪数据。

示例

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

property full_reward_spec: CompositeSpec

完整的奖励规格。

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

示例

>>> 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
CompositeSpec(
    nested: CompositeSpec(
        reward: UnboundedContinuousTensorSpec(
            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_state_spec: CompositeSpec

完整的状态规格。

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

示例

>>> from torchrl.envs import BraxEnv
>>> for envname in BraxEnv.available_envs:
...     break
>>> env = BraxEnv(envname)
>>> env.full_state_spec
CompositeSpec(
    state: CompositeSpec(
        pipeline_state: CompositeSpec(
            q: UnboundedContinuousTensorSpec(
                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([]))

get_buffer(target: str) → Tensor

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

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

参数:

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

返回值:

由 target 引用的缓冲区

返回类型:

torch.Tensor

引发:

AttributeError – 如果目标字符串引用无效路径或解析为非缓冲区的内容

get_extra_state() → Any

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

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

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

返回值:

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

返回类型:

object

get_parameter(target: str) → Parameter

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

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

参数:

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

返回值:

由 target 引用的参数

返回类型:

torch.nn.Parameter

引发:

AttributeError – 如果目标字符串引用无效路径或解析为非 nn.Parameter 的内容

get_submodule(target: str) → Module

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

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

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

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

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

get_submodule 的运行时间受 target 中模块嵌套的程度限制。针对 named_modules 的查询可以获得相同的结果，但它在传递模块的数量上是 O(N)。因此，对于一个简单的检查以查看某个子模块是否存在，应始终使用 get_submodule。

参数:

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

返回值:

由 target 引用的子模块

返回类型:

torch.nn.Module

引发:

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

half() → T

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

注意

此方法就地修改模块。

返回值:

自身

返回类型:

模块

property input_spec: TensorSpec

输入规范。

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

它包含

• “full_action_spec”：输入动作的规范

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

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

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.input_spec
CompositeSpec(
    full_state_spec: None,
    full_action_spec: CompositeSpec(
        action: BoundedTensorSpec(
            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([]))

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

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

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

注意

此方法就地修改模块。

参数:

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

返回值:

自身

返回类型:

模块

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

将参数和缓冲区从state_dict复制到此模块及其后代。

如果strict为True，则state_dict的键必须与该模块的state_dict()函数返回的键完全匹配。

警告

如果assign为True，则必须在调用load_state_dict后创建优化器，除非get_swap_module_params_on_conversion()为True。

参数:

• state_dict (dict) – 包含参数和持久缓冲区的字典。

• strict (bool, optional) – 是否严格强制要求state_dict中的键与该模块的state_dict()函数返回的键匹配。默认值：True

• assign (bool, optional) – 当False时，保留当前模块中张量的属性，而当True时，保留状态字典中张量的属性。唯一的例外是requires_grad字段 Default: ``False`

返回值:

• missing_keys 是一个包含任何预期键的字符串列表

  但此模块在提供的state_dict中缺少。

• unexpected_keys 是一个包含此模块未预期的键的字符串列表

  但存在于提供的state_dict中。

返回类型:

NamedTuple，包含missing_keys和unexpected_keys字段

注意

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

maybe_reset(tensordict: TensorDictBase) → TensorDictBase

检查输入tensordict的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 (int, 可选) – 如果指定，则所有参数都将复制到该设备

返回值:

自身

返回类型:

模块

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_spec: CompositeSpec

观察空间。

必须是 torchrl.data.CompositeSpec 实例。规范中列出的键在重置和执行步骤后可以直接访问。

在 TorchRL 中，即使它们不是严格意义上的“观察”，所有信息、状态、转换结果等环境输出都存储在 observation_spec 中。

因此，"observation_spec" 应该被认为是环境输出的通用数据容器，这些输出不是 done 或 reward 数据。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.observation_spec
CompositeSpec(
    observation: BoundedTensorSpec(
        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 output_spec: TensorSpec

输出空间。

包含来自环境的所有数据输出空间的复合空间。

它包含

• “full_reward_spec”: 奖励的空间

• “full_done_spec”: done 的空间

• “full_observation_spec”: 所有其他环境输出的空间

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

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.output_spec
CompositeSpec(
    full_reward_spec: CompositeSpec(
        reward: UnboundedContinuousTensorSpec(
            shape=torch.Size([1]),
            space=None,
            device=cpu,
            dtype=torch.float32,
            domain=continuous), device=cpu, shape=torch.Size([])),
    full_observation_spec: CompositeSpec(
        observation: BoundedTensorSpec(
            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: CompositeSpec(
        done: DiscreteTensorSpec(
            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([]))

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: Optional[TensorDictBase] = None)

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

参数:

**tensordict** (TensorDictBase, optional) – 应写入结果动作的张量字典。

返回值:

一个张量字典对象，其中“action”条目已更新为来自 action-spec 的随机样本。

rand_step(tensordict: Optional[TensorDictBase] = None) → TensorDictBase

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

参数:

**tensordict** (TensorDictBase, optional) – 应写入结果信息的张量字典。

返回值:

一个张量字典对象，其中包含环境中随机步骤后的新观察结果。动作将使用“action”键存储。

read_action(action)

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

参数:

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

返回：格式与包含的环境兼容的动作。

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" 的环境的回退值。默认为 None。

返回：包含 4 个布尔值/张量值的元组，

• 已终止状态，

• 已截断状态，

• 已完成状态，

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

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

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

参数:

observations (内部环境规定的格式下的观测结果) – 要读取的观测结果。

read_reward(reward)

读取奖励并将其映射到奖励空间。

参数:

reward (torch.Tensor 或 TensorDict) – 要映射的奖励。

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

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

此函数已弃用，建议使用 register_full_backward_hook()，并且此函数的行为将在未来的版本中发生变化。

返回值:

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

返回类型:

torch.utils.hooks.RemovableHandle

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

向模块添加一个缓冲区。

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

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

参数:

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

• tensor (Tensor 或 None) – 要注册的缓冲区。如果为 None，则在缓冲区上运行的操作（例如 cuda）将被忽略。如果为 None，则缓冲区不包含在模块的 state_dict 中。

• persistent (bool) – 缓冲区是否为此模块的 state_dict 的一部分。

示例

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

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

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

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

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

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

如果 with_kwargs 为 True，则前向钩子将传递给前向函数的 kwargs，并期望返回可能已修改的输出。钩子应具有以下签名

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

参数:

• hook (可调用对象) – 用户定义的要注册的钩子。

• prepend (布尔值) – 如果为 True，则提供的 hook 将在该 torch.nn.modules.Module 上所有现有的 forward 钩子之前触发。否则，提供的 hook 将在该 torch.nn.modules.Module 上所有现有的 forward 钩子之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward 钩子将在使用此方法注册的所有钩子之前触发。默认值：False

• with_kwargs (布尔值) – 如果为 True，则 hook 将传递给 forward 函数的 kwargs。默认值：False

• always_call (布尔值) – 如果为 True，则无论在调用模块时是否引发异常，都会运行 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 为假或未指定，则输入仅包含传递给模块的位置参数。关键字参数不会传递给钩子，只会传递给 forward。钩子可以修改输入。用户可以在钩子中返回一个元组或一个修改后的单个值。如果返回单个值（除非该值已经是元组），我们将将其包装成元组。钩子应具有以下签名

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

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

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

参数:

• hook (可调用对象) – 用户定义的要注册的钩子。

• prepend (布尔值) – 如果为真，则提供的 hook 将在该 torch.nn.modules.Module 上所有现有的 forward_pre 钩子之前触发。否则，提供的 hook 将在该 torch.nn.modules.Module 上所有现有的 forward_pre 钩子之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre 钩子将在使用此方法注册的所有钩子之前触发。默认值：False

• with_kwargs (布尔值) – 如果为真，则 hook 将传递给 forward 函数的 kwargs。默认值：False

返回值:

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

返回类型:

torch.utils.hooks.RemovableHandle

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

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

每次计算模块相对于其输出的梯度时，都会调用该钩子，即当且仅当计算模块输出的梯度时，钩子才会执行。钩子应具有以下签名

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

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

由于技术原因，当此钩子应用于模块时，其 forward 函数将接收传递给模块的每个张量的视图。类似地，调用者将接收模块 forward 函数返回的每个张量的视图。

警告

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

参数:

• hook (可调用对象) – 用户定义的要注册的钩子。

• prepend (布尔值) – 如果为真，则提供的 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 中，对于所有非张量参数，其条目都将为 None。

由于技术原因，当此钩子应用于模块时，其 forward 函数将接收传递给模块的每个张量的视图。类似地，调用者将接收模块 forward 函数返回的每个张量的视图。

警告

使用反向传播钩子时，不允许就地修改输入，否则将引发错误。

参数:

• hook (可调用对象) – 用户定义的要注册的钩子。

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

返回值:

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

返回类型:

torch.utils.hooks.RemovableHandle

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

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

此方法的设计考虑了以下范围

• 将 TorchRL-first 环境整合到使用 Gym 的框架中；

• 将其他环境（例如，DeepMind Control、Brax、Jumanji 等）整合到使用 Gym 的框架中。

参数:

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

关键字参数:

• **entry_point** (callable, 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) – 将与 env 一起使用的转换（或 torchrl.envs.Compose 实例中的转换列表）。此参数可以在调用 make() 时传递（请参见下面的示例）。

• **info_keys** (List[NestedKey], optional) –

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

  警告

  使用 info_keys 可能会导致规范为空，因为内容已移动到 info 字典中。Gym 不喜欢规范中的空 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 参数] 认为已学习环境的奖励阈值。

• **nondeterministic** (bool, optional) – [Gym 参数] 环境是否是非确定性的（即使了解初始种子和所有动作）。默认为 False。

• **max_episode_steps** (int, optional) – [Gym 参数] 截断之前的最大情节步数。由 Time Limit 包装器使用。

• **order_enforce** (bool, optional) – [Gym >= 0.14] 是否应应用顺序强制包装器以确保用户按正确的顺序运行函数。默认为 True。

• **autoreset** (bool, optional) – [Gym >= 0.14] 是否应添加自动重置包装器，以便不需要调用重置。默认为 False。

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

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

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

注意

TorchRL 的环境没有 "info" 字典的概念，因为 TensorDict 提供了大多数训练设置中认为必要的存储要求。但是，您可以使用 info_keys 参数对哪些被视为观察结果以及哪些应该被视为信息进行细粒度控制。

示例

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

注意

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

>>> 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 参数是一个包含属性 missing_keys 和 unexpected_keys 的 NamedTuple。 missing_keys 是一个包含缺失键的 str 类型列表，而 unexpected_keys 是一个包含意外键的 str 类型列表。

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

请注意，当使用 strict=True 调用 load_state_dict() 时执行的检查会受到挂钩对 missing_keys 或 unexpected_keys 进行的修改的影响，这与预期一致。对任一组键的添加都将导致在 strict=True 时抛出错误，而清除缺失键和意外键都将避免错误。

返回值:

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

返回类型:

torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)

注册一个预挂钩，在模块的 load_state_dict() 方法调用前运行。

它应该具有以下签名：

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

更改自动梯度是否应记录此模块中参数的操作。

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

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

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

参数:

requires_grad (bool) – 自动梯度是否应记录此模块中参数的操作。默认值：True。

返回值:

自身

返回类型:

模块

reset(tensordict: Optional[TensorDictBase] = None, **kwargs) → TensorDictBase

重置环境。

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

参数:

• tensordict (TensorDictBase, optional) – 用于包含结果新观察结果的张量字典。在某些情况下，此输入也可用于将参数传递给重置函数。

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

返回值:

一个张量字典（或输入张量字典，如果有的话），就地修改为包含结果观察结果。

property reset_keys: List[NestedKey]

返回重置键列表。

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

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

property reward_key

环境的奖励键。

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

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

property reward_keys: List[NestedKey]

环境的奖励键。

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

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

属性 reward_spec: TensorSpec

奖励的规范。

reward_spec 始终存储为复合规范。

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

>>> env.reward_spec = UnboundedContinuousTensorSpec(1)
>>> env.reward_spec
UnboundedContinuousTensorSpec(
    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 = CompositeSpec({"nested": {"reward": UnboundedContinuousTensorSpec(1)}})
>>> env.reward_spec
UnboundedContinuousTensorSpec(
    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 = CompositeSpec({"nested": {"reward": UnboundedContinuousTensorSpec(1), "another_reward": DiscreteTensorSpec(1)}})
>>> env.reward_spec
CompositeSpec(
    nested: CompositeSpec(
        reward: UnboundedContinuousTensorSpec(
            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: DiscreteTensorSpec(
            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
UnboundedContinuousTensorSpec(
    shape=torch.Size([1]),
    space=None,
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

rollout(max_steps: int, policy: Optional[Callable[[TensorDictBase], TensorDictBase]] = None, callback: Optional[Callable[[TensorDictBase, ...], Any]] = None, auto_reset: bool = True, auto_cast_to_device: bool = False, break_when_any_done: bool = True, return_contiguous: bool = True, tensordict: Optional[TensorDictBase] = None, set_truncated: bool = False, out=None)

在环境中执行 rollout。

一旦包含的环境之一返回 done=True，该函数将停止。

参数:

• max_steps (int) – 要执行的最大步数。如果环境在执行 max_steps 之前达到 done 状态，则实际步数可能会更小。

• policy (callable, 可选) – 可调用对象，用于计算所需的 action。如果没有提供策略，则将使用 env.rand_step() 调用 action。策略可以是任何可调用对象，读取 TensorDict 或整个观察条目序列，__按 as__ env.observation_spec.keys() 的顺序排序。默认为 None。

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

• auto_reset (bool, 可选) – 如果 True，则在启动 rollout 时，如果环境处于 done 状态，则会自动重置环境。默认为 True。

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

• break_when_any_done (bool) – 如果任何 done 状态为 True，则中断。如果为 False，则对已完成的子环境调用 reset()。默认为 True。

• return_contiguous (bool) – 如果为 False，则将返回 LazyStackedTensorDict。默认为 True。

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

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

返回值:

包含结果轨迹的 TensorDict 对象。

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

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

示例

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

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

示例

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

在某些情况下，由于无法堆叠，因此无法获得连续的 TensorDict。当每一步返回的数据可能具有不同的形状，或者当一起执行不同的环境时，可能会发生这种情况。在这种情况下， return_contiguous=False 将导致返回的 TensorDict 成为 TensorDict 的延迟堆栈。

非连续 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 可以循环使用来模拟数据收集。为此，您需要在调用 step_mdp() 后，将来自先前 rollout 的最后一个 TensorDict 作为输入传递。

数据收集 rollout 的示例

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

set_extra_state(state: Any) → None

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

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

参数:

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

set_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() 来完成，这将确保环境规范被正确构建。

示例

>>> 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: Optional[int] = None, static_seed: bool = False) → Optional[int]

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

参数:

• seed (int) – 要设置的种子。种子仅在环境中本地设置。要处理全局种子，请参见 manual_seed()。

• static_seed (bool, optional) – 如果为 True，则不会递增种子。默认为 False

返回值:

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

返回类型:

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

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

property shape

等价于 batch_size。

share_memory() → T

参见 torch.Tensor.share_memory_()。

property specs: CompositeSpec

返回一个 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[NestedKey]

环境的状态键。

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

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

property state_spec: CompositeSpec

状态规范。

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

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

因此，"state_spec" 应该被视为环境输入的通用数据容器，这些输入不是动作数据。

示例

>>> from torchrl.envs import BraxEnv
>>> for envname in BraxEnv.available_envs:
...     break
>>> env = BraxEnv(envname)
>>> env.state_spec
CompositeSpec(
    state: CompositeSpec(
        pipeline_state: CompositeSpec(
            q: UnboundedContinuousTensorSpec(
                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([]))

step(tensordict: TensorDictBase) → TensorDictBase

在环境中执行一步。

Step 接受一个参数 tensordict，它通常包含一个“action”键，表示要采取的动作。Step 将调用一个非就地私有方法 _step，该方法是 EnvBase 子类要重写的方法。

参数:

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

返回值:

输入 tensordict，使用结果观察、完成状态和奖励（以及其他需要的内容）就地修改。

step_and_maybe_reset(tensordict: TensorDictBase) → Tuple[TensorDictBase, 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)

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) – 张量，其数据类型和设备是此模块中所有参数和缓冲区的目标数据类型和设备

• **memory_format** (torch.memory_format) – 此模块中 4D 参数和缓冲区的目标内存格式（仅限关键字参数）

返回值:

自身

返回类型:

模块

示例

>>> # 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[device, str, int]], recurse: bool = True) → T

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

参数:

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

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

返回值:

自身

返回类型:

模块

train(mode: bool = True) → T

将模块设置为训练模式。

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

参数:

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

返回值:

自身

返回类型:

模块

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

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

注意

此方法就地修改模块。

参数:

**dst_type** (type 或 string) – 目标类型

返回值:

自身

返回类型:

模块

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

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

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

注意

此方法就地修改模块。

参数:

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

返回值:

自身

返回类型:

模块

zero_grad(set_to_none: bool = True) → None

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

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

参数:

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