ParallelEnv¶

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

为每个进程创建一个环境。

TensorDicts 通过共享内存或内存映射传递。

批量环境允许用户查询远程运行的环境的任意方法/属性。

这些查询将返回一个列表，其长度等于工作进程的数量，其中包含来自这些查询的值。

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

参数:

num_workers – 要同时部署的工作进程（即环境实例）的数量；
create_env_fn (callable 或 list of callables) – 用于环境创建的函数（或函数列表）。如果使用单个任务，则应使用可调用对象，而不是相同的可调用对象列表：如果提供了可调用对象列表，则环境将像需要多个不同的任务一样执行，这会带来轻微的计算开销；

关键字参数:

create_env_kwargs (dict 或 list of dicts, optional) – 与正在创建的环境一起使用的 kwargs；
share_individual_td (bool, optional) – 如果 True，则为每个进程/工作进程创建一个不同的 tensordict，并返回一个惰性堆栈。默认值 = None（如果为单任务则为 False）；
shared_memory (bool) – 返回的 tensordict 是否将放置在共享内存中；
memmap (bool) – 返回的 tensordict 是否将放置在内存映射中。
policy_proof (callable, optional) – 如果提供，它将用于获取通过 step() 和 reset() 方法返回的张量列表，例如 "hidden" 等。
device (str, int, torch.device) – 可以传递批量环境的设备。如果未传递，则从 env 推断。在这种情况下，假定所有环境的设备都匹配。如果提供了设备，则它可以与子环境设备不同。在这种情况下，数据将在收集期间自动转换为适当的设备。这可以用于加速收集，以防转换为设备引入开销（例如，基于 numpy 的环境等）：通过对批量环境使用 "cuda" 设备，但对嵌套环境使用 "cpu" 设备，可以将开销保持在最低水平。
num_threads (int, optional) – 此进程的线程数。应等于 1 加上每个子进程中启动的进程数（如果启动单个进程，则为 1）。默认为工作进程数 + 1。此参数对于 SerialEnv 类无效。
num_sub_threads (int, optional) – 子进程的线程数。为了安全起见，默认为 1：如果未指示任何值，则启动多个工作进程可能会过度增加 cpu 负载并损害性能。此参数对于 SerialEnv 类无效。
serial_for_single (bool, optional) – 如果 True，则使用单个工作进程创建并行环境将返回一个 SerialEnv。此选项对于 SerialEnv 无效。默认为 False。
non_blocking (bool, optional) – 如果 True，则设备移动将使用 non_blocking=True 选项完成。默认为 True。
mp_start_method (str, optional) – 多进程启动方法。如果未指示，则使用默认启动方法（如果未在首次导入之前以其他方式初始化，则 TorchRL 中默认为 ‘spawn’）。仅与 ParallelEnv 子类一起使用。
use_buffers (bool, optional) –
工作进程之间的通信是否应通过循环预分配内存缓冲区进行。除非其中一个环境具有动态规范，否则默认为 True。

注意

在此处了解有关动态规范和环境的更多信息 here。

注意

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

示例

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

警告

TorchRL 的 ParallelEnv 在环境规范方面非常严格，因为这些规范用于为进程间通信构建共享内存缓冲区。因此，我们鼓励用户首先使用 check_env_specs() 检查环境规范

>>> from torchrl.envs import check_env_specs
>>> env = make_env()
>>> check_env_specs(env) # if this passes without error you're good to go!
>>> penv = ParallelEnv(2, make_env)

特别是，如果未正确设置规范，则具有 info-dict 读取器的类似 gym 的 env 可能难以跨进程共享，这很难自动完成。查看 set_info_dict_reader() 以获取更多信息。这是一个简短示例

>>> from torchrl.envs import GymEnv, set_gym_backend, check_env_specs, TransformedEnv, TensorDictPrimer
>>> import torch
>>> env = GymEnv("HalfCheetah-v4")
>>> env.rollout(3)  # no info registered, this env passes check_env_specs
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10, 6]), device=cpu, dtype=torch.float32, 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, 17]), device=cpu, dtype=torch.float64, 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, 17]), device=cpu, dtype=torch.float64, 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)
>>> check_env_specs(env)  # succeeds!
>>> env.set_info_dict_reader()  # sets the default info_dict reader
>>> env.rollout(10)  # because the info_dict is empty at reset time, we're missing the root infos!
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10, 6]), device=cpu, dtype=torch.float32, 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, 17]), device=cpu, dtype=torch.float64, is_shared=False),
                reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                reward_ctrl: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False),
                reward_run: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, 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),
                x_position: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False),
                x_velocity: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False)},
            batch_size=torch.Size([10]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([10, 17]), device=cpu, dtype=torch.float64, 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)
>>> check_env_specs(env)  # This check now fails! We should not use an env constructed like this in a parallel env
>>> # This ad-hoc fix registers the info-spec for reset. It is wrapped inside `env.auto_register_info_dict()`
>>> env_fixed = TransformedEnv(env, TensorDictPrimer(env.info_dict_reader[0].info_spec))
>>> env_fixed.rollout(10)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10, 6]), device=cpu, dtype=torch.float32, 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, 17]), device=cpu, dtype=torch.float64, is_shared=False),
                reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                reward_ctrl: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False),
                reward_run: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, 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),
                x_position: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False),
                x_velocity: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False)},
            batch_size=torch.Size([10]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([10, 17]), device=cpu, dtype=torch.float64, is_shared=False),
        reward_ctrl: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False),
        reward_run: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, 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),
        x_position: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False),
        x_velocity: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False)},
    batch_size=torch.Size([10]),
    device=cpu,
    is_shared=False)
>>> check_env_specs(env_fixed)  # Succeeds! This env can be used within a parallel env!

相关类和方法：auto_register_info_dict() 和 default_info_dict_reader。

警告

ParallelEnv 需要执行的设备的选择会极大地影响其性能。经验法则是

如果基础环境（后端，例如 Gym）在 CPU 上执行，则子环境应在 CPU 上执行，并且数据应通过共享物理内存传递。

如果基础环境是（或可以是）在 CUDA 上执行，则子环境也应放置在 CUDA 上。

如果 CUDA 设备可用且策略将在 CUDA 上执行，则应将 ParallelEnv 设备设置为 CUDA。

因此，假设 CUDA 设备可用，我们有以下场景

>>> # The sub-envs are executed on CPU, but the policy is on GPU
>>> env = ParallelEnv(N, MyEnv(..., device="cpu"), device="cuda")
>>> # The sub-envs are executed on CUDA
>>> env = ParallelEnv(N, MyEnv(..., device="cuda"), device="cuda")
>>> # this will create the exact same environment
>>> env = ParallelEnv(N, MyEnv(..., device="cuda"))
>>> # If no cuda device is available
>>> env = ParallelEnv(N, MyEnv(..., device="cpu"))

警告

ParallelEnv 在所有操作中禁用梯度 (step(), reset() 和 step_and_maybe_reset())，因为梯度无法通过 multiprocessing.Pipe 对象传递。只有 SerialEnv 将支持反向传播。

property action_key: NestedKey¶

环境的动作键。

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

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

property action_keys: List[NestedKey]¶

环境的动作键。

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

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

property action_spec: TensorSpec¶

action 规范。

action_spec 始终存储为复合规范。

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

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

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

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

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

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

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

>>> env.input_spec["full_action_spec"]

此属性是可变的。

示例

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

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

向当前模块添加子模块。

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

参数:

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

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

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

示例

>>> @torch.no_grad()
>>> def init_weights(m):
>>>     print(m)
>>>     if type(m) == nn.Linear:
>>>         m.weight.fill_(1.0)
>>>         print(m.weight)
>>> net = nn.Sequential(nn.Linear(2, 2), nn.Linear(2, 2))
>>> net.apply(init_weights)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
)

property batch_locked: bool¶

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

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

property batch_size: Size¶

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

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

bfloat16() → T¶

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

注意

此方法会就地修改模块。

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

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

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

参数:: recurse (bool) – 如果为 True，则生成此模块和所有子模块的缓冲区。否则，仅生成作为此模块直接成员的缓冲区。
产出:: torch.Tensor – 模块缓冲区

示例

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

children() → Iterator[Module]¶

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

产出:: Module – 子模块

compile(*args, **kwargs)¶

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

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

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

cpu() → T¶

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

注意

此方法会就地修改模块。

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

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

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

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

注意

此方法会就地修改模块。

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

property done_key¶

环境的完成键。

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

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

property done_keys: List[NestedKey]¶

环境的完成键。

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

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

property done_keys_groups¶

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

这是一个列表的列表。外层列表的长度与重置键的长度相同，内层列表包含可以读取的完成键（例如，done 和 truncated），以确定何时缺少重置。

property done_spec: TensorSpec¶

done 规范。

done_spec 始终存储为复合规范。

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

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

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

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

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

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

要始终检索传递的完整规范，请使用

>>> env.output_spec["full_done_spec"]

此属性是可变的。

示例

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

double() → T¶

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

注意

此方法会就地修改模块。

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

empty_cache()¶

清除所有缓存值。

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

eval() → T¶

将模块设置为评估模式。

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

这等效于 self.train(False)。

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

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

extra_repr() → str¶

设置模块的额外表示。

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

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

float() → T¶

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

注意

此方法会就地修改模块。

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

forward(tensordict: TensorDictBase) → TensorDictBase¶

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

应由所有子类覆盖。

注意

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

property full_action_spec: Composite¶

完整的动作规范。

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

示例

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

Composite(

action: BoundedContinuous(

shape=torch.Size([8]), space=ContinuousBox(

low=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True)),

device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([]))

property full_done_spec: Composite¶

完整的完成规范。

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

示例

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

property full_reward_spec: Composite¶

完整的奖励规范。

full_reward_spec 是一个 Composite` 实例，其中包含了所有的奖励条目。

示例

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

property full_state_spec: Composite¶

完整的状态规范。

full_state_spec 是一个 Composite` 实例，其中包含了所有的状态条目（即，非动作的输入数据）。

示例

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

get_buffer(target: str) → Tensor¶

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

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

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

get_extra_state() → Any¶

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

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

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

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

get_parameter(target: str) → Parameter¶

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

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

参数:: target – 要查找的 Parameter 的完整限定字符串名称。（有关如何指定完整限定字符串，请参阅 get_submodule。）
返回:: 由 target 引用的 Parameter
返回类型:: torch.nn.Parameter
Raises:: 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
Raises:: AttributeError – 如果目标字符串引用了无效路径或解析为非 nn.Module 的内容

half() → T¶

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

注意

此方法会就地修改模块。

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

property input_spec: TensorSpec¶

输入规范。

包含环境输入数据的全部规范的复合规范。

它包含

“full_action_spec”：输入动作的规范
“full_state_spec”：所有其他环境输入的规范

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

示例

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

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

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

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

注意

此方法会就地修改模块。

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

load_state_dict(*args, **kwargs)[source]¶

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

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

警告

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

参数:

state_dict (dict) – 包含参数和持久缓冲区的字典。
strict (bool, optional) – 是否严格强制 state_dict 中的键与此模块的 state_dict() 函数返回的键匹配。默认值： True
assign (bool, optional) – 当 False 时，保留当前模块中张量的属性，而当 True 时，保留状态字典中张量的属性。唯一的例外是 requires_grad 字段。默认值： ``False`

返回:

missing_keys 是一个字符串列表，其中包含此模块预期但在提供的 state_dict 中缺失的任何键。
by this module but missing from the provided state_dict.
unexpected_keys 是一个字符串列表，其中包含此模块不预期但在提供的 state_dict 中存在的键。
expected by this module but present in the provided 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, optional) – 如果指定，则所有参数都将复制到该设备
返回:: self
返回类型:: Module

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

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

参数:

prefix (str) – 要添加到所有缓冲区名称的前缀。
recurse (bool, optional) – 如果为 True，则产生此模块和所有子模块的缓冲区。否则，仅产生作为此模块直接成员的缓冲区。默认为 True。
remove_duplicate (bool, optional) – 是否删除结果中重复的缓冲区。默认为 True。

产出:

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

示例

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

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

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

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

示例

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

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

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

参数:

memo – 用于存储已添加到结果中的模块集合的 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: Composite¶

观测规范。

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

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

因此，"observation_spec" 应被视为环境输出（非 done 或奖励数据）的通用数据容器。

示例

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

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) – tensordict，其中应写入生成的动作。
返回:: 一个 tensordict 对象，其中的 “action” 条目已使用来自 action-spec 的随机样本更新。

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

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

参数:: tensordict (TensorDictBase, optional) – tensordict，其中应写入生成的信息。
返回:: 一个 tensordict 对象，其中包含在环境中随机步后的新观测。动作将使用 “action” 键存储。

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

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

此函数已被弃用，推荐使用 register_full_backward_hook()，并且此函数的行为将在未来版本中更改。

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

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

向模块添加缓冲区。

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

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

参数:

name (str) – 缓冲区的名称。可以使用给定的名称从此模块访问缓冲区
tensor (Tensor 或 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，则前向钩子将传递给 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¶

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

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

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

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

出于技术原因，当此钩子应用于模块时，其 forward 函数将接收传递给模块的每个 Tensor 的视图。同样，调用者将接收模块的 forward 函数返回的每个 Tensor 的视图。

警告

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

参数:

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

返回:

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

返回类型:

torch.utils.hooks.RemovableHandle

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

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

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

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

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

出于技术原因，当此钩子应用于模块时，其 forward 函数将接收传递给模块的每个 Tensor 的视图。同样，调用者将接收模块的 forward 函数返回的每个 Tensor 的视图。

警告

使用后向钩子时，不允许就地修改输入，否则会引发错误。

参数:

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

返回:

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

返回类型:

torch.utils.hooks.RemovableHandle

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

在 gym(nasium) 中注册环境。

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

将 TorchRL 优先的环境整合到使用 Gym 的框架中；

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

参数:

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

关键字参数:

entry_point (callable, optional) –

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

>>> from torchrl.envs import DMControlEnv
>>> DMControlEnv.register_gym("DMC-cheetah-v0", env_name="cheetah", task="run")
>>> # equivalently
>>> EnvBase.register_gym("DMC-cheetah-v0", entry_point=DMControlEnv, env_name="cheetah", task="run")

transform (torchrl.envs.Transform) – 变换（或 torchrl.envs.Compose 实例中的变换列表），用于环境。此参数可以在调用 make() 期间传递（见下面的示例）。
info_keys (List[NestedKey], optional) –
如果提供，这些键将用于构建 info 字典，并将从 observation 键中排除。此参数可以在调用 make() 期间传递（见下面的示例）。

警告

可能出现的情况是，使用 info_keys 会使 spec 为空，因为内容已移动到 info 字典中。Gym 不喜欢 specs 中有空的 Dict，因此应使用 RemoveEmptySpecs 删除此空内容。
backend (str, optional) – 后端。可以是 “gym” 或 “gymnasium”，或任何其他与 set_gym_backend 兼容的后端。
to_numpy (bool, optional) – 如果为 True，则对 step 和 reset 的调用结果将映射到 numpy 数组。默认为 False（结果为张量）。此参数可以在调用 make() 期间传递（见下面的示例）。
reward_threshold (float, optional) – [Gym kwarg] 奖励阈值，被认为是环境已学习的阈值。
nondeterministic (bool, optional) – [Gym kwarg] 如果环境是非确定性的（即使知道初始种子和所有动作）。默认为 False。
max_episode_steps (int, optional) – [Gym kwarg] 截断之前的最大 episode 步数。由 Time Limit wrapper 使用。
order_enforce (bool, optional) – [Gym >= 0.14] 是否应应用顺序执行器 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 参数来精细控制哪些被认为是 observation，哪些应该被视为 info。

示例

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

注意

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

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

register_load_state_dict_post_hook(hook)¶

注册一个 post-hook，在模块的 load_state_dict() 被调用后运行。

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

module 参数是注册此 hook 的当前模块，incompatible_keys 参数是一个 NamedTuple，由属性 missing_keys 和 unexpected_keys 组成。missing_keys 是一个 list 类型的 str，包含缺失的键，而 unexpected_keys 是一个 list 类型的 str，包含意外的键。

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

请注意，当使用 strict=True 调用 load_state_dict() 时执行的检查会受到 hook 对 missing_keys 或 unexpected_keys 所做的修改的影响，正如预期的那样。向任一键集添加内容将在 strict=True 时导致抛出错误，而清除缺失键和意外键都将避免错误。

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

register_load_state_dict_pre_hook(hook)¶

注册一个 pre-hook，在模块的 load_state_dict() 被调用之前运行。

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

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

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() 方法注册一个 post-hook。

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

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

register_state_dict_pre_hook(hook)¶

为 state_dict() 方法注册一个 pre-hook。

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

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

requires_grad_(requires_grad: bool = True) → T¶

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

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

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

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

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

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

重置环境。

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

参数:

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

返回:

一个 tensordict（或任何输入 tensordict），就地修改为结果 observation。

property reset_keys: List[NestedKey]¶

返回 reset 键的列表。

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

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

property reward_key¶

环境的 reward 键。

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

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

property reward_keys: List[NestedKey]¶

环境的 reward 键。

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

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

property reward_spec: TensorSpec¶

reward spec。

reward_spec 始终存储为复合 spec。

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

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

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

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

>>> env.reward_spec = Composite({"nested": {"reward": Unbounded(1), "another_reward": Categorical(1)}})
>>> env.reward_spec
Composite(
    nested: Composite(
        reward: UnboundedContinuous(
            shape=torch.Size([1]),
            space=ContinuousBox(
                low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
                high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
            device=cpu,
            dtype=torch.float32,
            domain=continuous),
        another_reward: Categorical(
            shape=torch.Size([]),
            space=DiscreteBox(n=1),
            device=cpu,
            dtype=torch.int64,
            domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

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

>>> env.output_spec["full_reward_spec"]

此属性是可变的。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.reward_spec
UnboundedContinuous(
    shape=torch.Size([1]),
    space=None,
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

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: Optional[bool] = None, break_when_all_done: Optional[bool] = None, return_contiguous: bool = True, tensordict: Optional[TensorDictBase] = None, set_truncated: bool = False, out=None, trust_policy: bool = False)¶

在环境中执行 rollout。

只要包含的环境之一返回 done=True，该函数就会停止。

参数:

max_steps (int) – 要执行的最大步数。如果环境在执行 max_steps 之前达到 done 状态，则实际步数可能会更少。
policy (callable, optional) – 可调用对象，用于计算期望的动作。如果未提供 policy，则将使用 env.rand_step() 调用动作。policy 可以是任何可调用对象，它可以读取 tensordict 或 observation 条目的整个序列，这些条目按照 env.observation_spec.keys() 进行 __sorted as__。默认为 None。
callback (Callable[[TensorDict], Any], optional) – 在每次迭代时使用给定的 TensorDict 调用的函数。默认为 None。callback 的输出将不会被收集，用户有责任在 callback 调用中保存任何结果，如果数据需要超出 rollout 的调用范围。

关键字参数:

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

返回:

包含结果轨迹的 TensorDict 对象。

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

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

示例

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

使用 policy（常规 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_seed(*args, **kwargs)[source]¶

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

参数:

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 – 要将子模块设置为的模块。

Raises:

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

property shape¶: 等效于 batch_size。

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

property specs: Composite¶

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

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

state_dict(*args, **kwargs)[source]¶

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

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

注意

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

警告

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

警告

请避免使用参数 destination，因为它并非为最终用户设计。

参数:

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

返回:

包含模块整个状态的字典

返回类型:

dict

示例

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

property state_keys: List[NestedKey]¶

环境的状态键。

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

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

property state_spec: Composite¶

状态规范。

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

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

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

示例

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

step(tensordict: TensorDictBase) → TensorDictBase¶

在环境中执行一个步进。

Step 接受一个参数 tensordict，它通常携带一个 'action' 键，指示要采取的动作。Step 将调用一个就地私有方法 _step，该方法是 EnvBase 子类要重写的方法。

参数:: tensordict (TensorDictBase) – 包含要采取的动作的 TensorDict。如果输入 tensordict 包含一个 "next" 条目，则其中包含的值将优先于新计算的值。这提供了一种覆盖底层计算的机制。
返回:: 输入的 tensordict，就地修改为包含结果的观测、完成状态和奖励（以及其他需要的）。

step_and_maybe_reset(*args, **kwargs)[source]¶

在环境中运行一个步进，并在需要时（部分）重置它。

参数:: 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])[source]¶

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

可以这样调用

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

to(dtype, non_blocking=False)[source]

to(tensor, non_blocking=False)[source]

to(memory_format=torch.channels_last)[source]

它的签名类似于 torch.Tensor.to()，但仅接受浮点型或复数 dtype。此外，此方法将仅将浮点型或复数参数和缓冲区转换为 dtype（如果给定）。整数参数和缓冲区将被移动到 device，如果给定，但 dtype 不变。当设置 non_blocking 时，如果可能，它会尝试相对于主机异步转换/移动，例如，将具有 pinned memory 的 CPU Tensor 移动到 CUDA 设备。

请参阅下面的示例。

注意

此方法会就地修改模块。

参数:

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

返回:

self

返回类型:

Module

示例

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

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

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

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

参数:

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

返回:

self

返回类型:

Module

train(mode: bool = True) → T¶

将模块设置为训练模式。

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

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

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

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

注意

此方法会就地修改模块。

参数:: dst_type (type 或 string) – 期望的类型
返回:: self
返回类型:: Module

update_kwargs(kwargs: Union[dict, List[dict]]) → None¶

更新每个环境的 kwargs，给定一个字典或字典列表。

参数:: kwargs (dict 或 dict 列表) – 要与环境一起使用的新 kwargs

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

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

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

注意

此方法会就地修改模块。

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

zero_grad(set_to_none: bool = True) → None¶

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

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

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

ParallelEnv¶

文档

教程

资源