MultiaSyncDataCollector

类 torchrl.collectors.MultiaSyncDataCollector(*args, **kwargs)

在单独的进程上异步运行给定数量的 DataCollectors。

环境类型可以相同或不同。

即使在收集到批次 rollout 与下一次调用迭代器之间，所有进程上的收集也会持续进行。该类可以安全地用于离线 RL 的 sota 实现。

注意

Python 要求在主守护中实例化多进程代码

>>> from torchrl.collectors import MultiaSyncDataCollector
>>> if __name__ == "__main__":
...     # Create your collector here

有关更多信息，请参见 https://docs.pythonlang.cn/3/library/multiprocessing.html。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> from tensordict.nn import TensorDictModule
>>> from torch import nn
>>> from torchrl.collectors import MultiaSyncDataCollector
>>> if __name__ == "__main__":
...     env_maker = lambda: GymEnv("Pendulum-v1", device="cpu")
...     policy = TensorDictModule(nn.Linear(3, 1), in_keys=["observation"], out_keys=["action"])
...     collector = MultiaSyncDataCollector(
...         create_env_fn=[env_maker, env_maker],
...         policy=policy,
...         total_frames=2000,
...         max_frames_per_traj=50,
...         frames_per_batch=200,
...         init_random_frames=-1,
...         reset_at_each_iter=False,
...         device="cpu",
...         storing_device="cpu",
...         cat_results="stack",
...     )
...     for i, data in enumerate(collector):
...         if i == 2:
...             print(data)
...             break
... collector.shutdown()
... del collector
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.float32, is_shared=False),
        collector: TensorDict(
            fields={
                traj_ids: Tensor(shape=torch.Size([200]), device=cpu, dtype=torch.int64, is_shared=False)},
            batch_size=torch.Size([200]),
            device=cpu,
            is_shared=False),
        done: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([200, 3]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                step_count: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.int64, is_shared=False),
                truncated: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([200]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([200, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        step_count: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.int64, is_shared=False),
        truncated: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([200]),
    device=cpu,
    is_shared=False)

在单独的进程上运行给定数量的 DataCollectors。

参数：:

• create_env_fn (List[可调用对象]) – Callable 列表，每个 Callable 返回 EnvBase 的一个实例。

• policy (Callable) –

  在环境中执行的策略。必须接受 tensordict.tensordict.TensorDictBase 对象作为输入。如果提供 None（默认值），使用的策略将是带有环境 action_spec 的 RandomPolicy 实例。接受的策略通常是 TensorDictModuleBase 的子类。这是收集器推荐的使用方式。也接受其他可调用对象：如果策略不是 TensorDictModuleBase（例如，常规的 Module 实例），它将首先被包装在 nn.Module 中。然后，收集器将尝试评估这些模块是否需要包装在 TensorDictModule 中。

  • 如果策略的 forward 签名与 forward(self, tensordict)、forward(self, td) 或 forward(self, <anything>: TensorDictBase)（或任何带有单个参数且参数类型为 TensorDictBase 子类的签名）中的任何一个匹配，则策略不会被包装在 TensorDictModule 中。

  • 在所有其他情况下，将尝试按如下方式包装它：TensorDictModule(policy, in_keys=env_obs_key, out_keys=env.action_keys)。

关键字参数：:

• frames_per_batch (int) – 一个仅限关键字的参数，表示批次中的总元素数量。

• total_frames (int, 可选) –

  一个仅限关键字的参数，表示收集器在其生命周期内返回的总帧数。如果 total_frames 不能被 frames_per_batch 整除，则会引发异常。

  通过传递 total_frames=-1 可以创建无限收集器。默认为 -1（永不停止的收集器）。

• device (int, str 或 torch.device, 可选) – 收集器的通用设备。device 参数用于填充任何未指定的设备：如果 device 不是 None 且 storing_device、policy_device 或 env_device 中的任何一个未指定，则其值将被设置为 device。默认为 None（无默认设备）。如果希望为每个 worker 指定不同的设备，支持提供设备列表。该列表的长度必须与 worker 数量相同。

• storing_device (int, str 或 torch.device, 可选) – 输出 TensorDict 将被存储在哪个设备上。如果传入了 device 且 storing_device 为 None，则默认为 device 指定的值。对于长轨迹，可能需要将数据存储在与策略和环境执行所在设备不同的设备上。默认为 None（输出 tensordict 不在特定设备上，叶张量位于创建它们的设备上）。如果希望为每个 worker 指定不同的设备，支持提供设备列表。该列表的长度必须与 worker 数量相同。

• env_device (int, str 或 torch.device, 可选) – 环境应该被强制转换（或执行，如果支持该功能）到哪个设备上。如果未指定且环境有一个非 None 的设备，env_device 将默认为该值。如果传入了 device 且 env_device=None，则默认为 device。如果如此指定的 env_device 的值与 policy_device 不同且其中一个不是 None，则数据在传递给环境之前将被强制转换为 env_device（即，支持为策略和环境传递不同的设备）。默认为 None。如果希望为每个 worker 指定不同的设备，支持提供设备列表。该列表的长度必须与 worker 数量相同。

• policy_device (int, str 或 torch.device, 可选) – 策略应该被强制转换到哪个设备上。如果传入了 device 且 policy_device=None，则默认为 device。如果如此指定的 policy_device 的值与 env_device 不同且其中一个不是 None，则数据在传递给策略之前将被强制转换为 policy_device（即，支持为策略和环境传递不同的设备）。默认为 None。如果希望为每个 worker 指定不同的设备，支持提供设备列表。该列表的长度必须与 worker 数量相同。

• create_env_kwargs (dict, 可选) – 一个字典，包含用于创建环境的关键字参数。如果提供一个列表，其每个元素将被分配给一个子收集器。

• max_frames_per_traj (int, 可选) – 每条轨迹的最大步数。请注意，一条轨迹可以跨越多个批次（除非 reset_at_each_iter 设置为 True，见下文）。一旦一条轨迹达到 n_steps，环境就会重置。如果环境包装了多个环境，则会独立地跟踪每个环境的步数。允许负值，在这种情况下将忽略此参数。默认为 None（即没有最大步数）。

• init_random_frames (int, 可选) – 在调用策略之前，策略被忽略的帧数。此功能主要用于离线/基于模型的设置，其中一批随机轨迹可用于初始化训练。如果提供，它将被向上舍入到 frames_per_batch 的最近倍数。默认为 None（即没有随机帧）。

• reset_at_each_iter (bool, 可选) – 是否应在批次收集开始时重置环境。默认为 False。

• postproc (Callable, 可选) – 后处理 transform，例如 Transform 或 MultiStep 实例。默认为 None。

• split_trajs (bool, 可选) – 布尔值，指示是否应根据轨迹分割结果 TensorDict。有关更多信息，请参见 split_trajectories()。默认为 False。

• exploration_type (ExplorationType, 可选) – 收集数据时使用的交互模式。必须是 torchrl.envs.utils.ExplorationType.DETERMINISTIC、torchrl.envs.utils.ExplorationType.RANDOM、torchrl.envs.utils.ExplorationType.MODE 或 torchrl.envs.utils.ExplorationType.MEAN 中的一个。

• reset_when_done (bool, 可选) – 如果为 True（默认值），则在“done”或“truncated”条目中返回 True 值的环境将在相应的索引处重置。

• update_at_each_batch (boolm optional) – 如果为 True，则每次数据收集之前（同步）或之后（异步）都会调用 update_policy_weight_()。默认为 False。

• preemptive_threshold (float, 可选) – 一个介于 0.0 和 1.0 之间的值，指定在其余 worker 被强制提前结束之前，允许完成其 rollout 收集的 worker 比例。

• num_threads (int, 可选) – 此进程的线程数。默认为 worker 数量。

• num_sub_threads (int, 可选) – 子进程的线程数。应等于每个子进程内启动的进程数加一（如果只启动一个进程，则为一）。出于安全考虑，默认为 1：如果未指定，启动多个 worker 可能会使 CPU 负载过高并损害性能。

• cat_results (str, int 或 None) –

  （仅限 MultiSyncDataCollector）。如果为 "stack"，则从 worker 收集的数据将沿第一维度堆叠。这是首选行为，因为它与库的其余部分最兼容。如果为 0，结果将沿输出的第一维度连接，如果环境是批量处理的，则可以是批量维度；如果不是，则可以是时间维度。cat_results 值为 -1 将始终沿时间维度连接结果。这应该优先于默认值。也接受中间值。默认为 "stack"。

  注意

  从 v0.5 开始，为了与库的其余部分更好地互操作，此参数将默认为 "stack"。

• set_truncated (bool, 可选) – 如果为 True，当达到 rollout 的最后一帧时，截断信号（以及相应的“done”，但不是“terminated”）将被设置为 True。如果未找到“truncated”键，则会引发异常。可以通过 env.add_truncated_keys 设置截断键。默认为 False。

• use_buffers (bool, 可选) – 如果为 True，将使用缓冲区来堆叠数据。这与具有动态 specs 的环境不兼容。对于没有动态 specs 的环境，默认为 True；对于其他环境，则为 False。

• replay_buffer (ReplayBuffer, 可选) – 如果提供，收集器将不产生 tensordict，而是填充缓冲区。默认为 None。

• trust_policy (bool, 可选) – 如果为 True，则将信任非 TensorDictModule 策略，认为其与收集器兼容。对于 CudaGraphModules，此值默认为 True；否则为 False。

• compile_policy (bool 或 Dict[str, Any], 可选) – 如果为 True，将使用 compile() 的默认行为编译策略。如果传递一个 kwargs 字典，它将用于编译策略。

• cudagraph_policy (bool 或 Dict[str, Any], 可选) – 如果为 True，策略将使用默认 kwargs 包装在 CudaGraphModule 中。如果传递一个 kwargs 字典，它将用于包装策略。

• no_cuda_sync (bool) – 如果为 True，将绕过显式 CUDA 同步调用。对于直接在 CUDA 上运行的环境（IsaacLab 或 ManiSkills），CUDA 同步可能会导致意外崩溃。默认为 False。

load_state_dict(state_dict: OrderedDict) → None

在 worker 上加载 state_dict。

参数：:

state_dict (OrderedDict) – 形式为 {"worker0": state_dict0, "worker1": state_dict1} 的 state_dict。

reset(reset_idx: Optional[Sequence[bool]] = None) → None

将环境重置到新的初始状态。

参数：:

reset_idx – 可选。表示哪些环境需要重置的序列。如果为 None，则所有环境都会重置。

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

设置 DataCollector 中存储的环境的种子。

参数：:

• seed – 表示用于环境的种子的整数。

• static_seed (bool, 可选) – 如果为 True，则种子不自增。默认为 False

返回值：:

输出的种子。当 DataCollector 中包含多个环境时，这非常有用，因为每个环境的种子都会自增。最终的种子是最后一个环境的种子。

示例

>>> from torchrl.envs import ParallelEnv
>>> from torchrl.envs.libs.gym import GymEnv
>>> from tensordict.nn import TensorDictModule
>>> from torch import nn
>>> env_fn = lambda: GymEnv("Pendulum-v1")
>>> env_fn_parallel = lambda: ParallelEnv(6, env_fn)
>>> policy = TensorDictModule(nn.Linear(3, 1), in_keys=["observation"], out_keys=["action"])
>>> collector = SyncDataCollector(env_fn_parallel, policy, frames_per_batch=100, total_frames=300)
>>> out_seed = collector.set_seed(1)  # out_seed = 6

shutdown()

关闭所有进程。此操作不可逆。

state_dict() → OrderedDict

返回数据收集器的 state_dict。

每个字段表示一个 worker，其中包含其自身的 state_dict。

update_policy_weights_(policy_weights: Optional[TensorDictBase] = None) → None

如果数据收集器的策略和训练好的策略位于不同的设备上，则更新策略权重。

参数：:

policy_weights (TensorDictBase, 可选) – 如果提供，则为包含用于更新策略权重的 TensorDict。