DistributedDataCollector

class torchrl.collectors.distributed.DistributedDataCollector(create_env_fn, policy, *, frames_per_batch: int, total_frames: int = -1, device: torch.device | List[torch.device] = None, storing_device: torch.device | List[torch.device] = None, env_device: torch.device | List[torch.device] = None, policy_device: torch.device | List[torch.device] = None, max_frames_per_traj: int = -1, init_random_frames: int = -1, reset_at_each_iter: bool = False, postproc: Callable | None = None, split_trajs: bool = False, exploration_type: ExporationType = InteractionType.RANDOM, collector_class: Type = <class 'torchrl.collectors.collectors.SyncDataCollector'>, collector_kwargs: dict = None, num_workers_per_collector: int = 1, sync: bool = False, slurm_kwargs: dict | None = None, backend: str = 'gloo', update_after_each_batch: bool = False, max_weight_update_interval: int = -1, launcher: str = 'submitit', tcp_port: int = None)

一个带有 torch.distributed 后端的分布式数据收集器。

支持同步和异步数据收集。

参数:

• create_env_fn (Callable 或 List[Callabled]) – Callables 列表，每个都返回 EnvBase 的实例。

• policy (Callable) –

  要在环境中执行的策略。必须接受 tensordict.tensordict.TensorDictBase 对象作为输入。如果提供 None，则使用的策略将是具有环境 action_spec 的 RandomPolicy 实例。接受的策略通常是 TensorDictModuleBase 的子类。这是推荐的收集器用法。也接受其他可调用对象：如果策略不是 TensorDictModuleBase（例如，常规的 Module 实例），它将首先被包装在 nn.Module 中。然后，收集器将尝试评估这些模块是否需要包装在 TensorDictModule 中。- 如果策略前向签名与 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（无默认设备）。支持设备列表。

• storing_device (int, str 或 torch.device, 可选) – 远程设备，输出 TensorDict 将存储在该设备上。如果传递了 device 且 storing_device 为 None，则它将默认为 device 指示的值。对于长轨迹，可能需要在与策略和 env 执行设备不同的设备上存储数据。默认为 None（输出 tensordict 不在特定设备上，叶张量位于它们创建的设备上）。支持设备列表。

• env_device (int, str 或 torch.device, 可选) – 远程设备，环境应在该设备上进行转换（或执行，如果该功能受支持）。如果未指定且 env 具有非 None 设备，则 env_device 将默认为该值。如果传递了 device 且 env_device=None，则它将默认为 device。如果如此指定的 env_device 值与 policy_device 不同，并且其中一个不是 None，则数据将在传递给 env 之前转换为 env_device（即，支持将不同的设备传递给策略和 env）。默认为 None。支持设备列表。

• policy_device (int, str 或 torch.device, 可选) – 远程设备，策略应在该设备上进行转换。如果传递了 device 且 policy_device=None，则它将默认为 device。如果如此指定的 policy_device 值与 env_device 不同，并且其中一个不是 None，则数据将在传递给策略之前转换为 policy_device（即，支持将不同的设备传递给策略和 env）。默认为 None。支持设备列表。

• 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 或 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 之一。

• collector_class (type 或 str, 可选) – 远程节点的收集器类。可以是 SyncDataCollector、MultiSyncDataCollector、MultiaSyncDataCollector 或这些的派生类。字符串“single”、“sync”和“async”分别对应于相应的类。默认为 SyncDataCollector。

• collector_kwargs (dict 或 list, 可选) – 要传递给远程数据收集器的参数字典。如果提供列表，则每个元素将对应于专用收集器的各个关键字参数集。

• num_workers_per_collector (int, 可选) – 远程节点上要使用的 env 构造函数的副本数。默认为 1（每个收集器一个 env）。在单个工作节点上，所有子工作程序都将执行相同的环境。如果需要执行不同的环境，则应将它们分派到工作节点而不是子节点。

• sync (bool, 可选) – 如果 True，则生成的 tensordict 是在每个节点上收集的所有 tensordict 的堆栈。如果 False（默认），则每个 tensordict 都来自一个单独的节点，以“先准备好，先服务”的方式。

• slurm_kwargs (dict) – 要传递给 submitit 执行器的参数字典。

• backend (str, 可选) – 必须是字符串“<distributed_backed>”，其中 <distributed_backed> 是 "gloo"、"mpi"、"nccl" 或 "ucc" 之一。有关更多信息，请参见 torch.distributed 文档。默认为 "gloo"。

• update_after_each_batch (bool, 可选) – 如果 True，则权重将在每次收集后更新。对于 sync=True，这意味着所有工作程序都将看到其权重已更新。对于 sync=False，仅会更新从中收集数据的工作程序。默认为 False，即，必须通过 update_policy_weights_() 手动执行更新。

• max_weight_update_interval (int, 可选) – 在更新工作程序的策略权重之前可以收集的最大批次数。对于同步集合，此参数将被 update_after_each_batch 覆盖。对于异步集合，即使 update_after_each_batch 已打开，也可能存在一个工作程序在一段时间内未看到其参数被更新的情况。默认为 -1（无强制更新）。

• launcher (str, 可选) – 应如何启动作业。可以是 “submitit” 或 “mp” 之一，用于多处理。如果您的集群不支持从现有作业生成作业，请使用 “submitit_delayed”。前者可以跨多个节点启动作业，而后者仅在单台机器上启动作业。“submitit” 需要安装同名库。要了解有关 submitit 的更多信息，请访问 https://github.com/facebookincubator/submitit 并查看我们的示例以了解更多信息。默认为 "submitit"。

• tcp_port (int, 可选) – 要使用的 TCP 端口。默认为 10003。

update_policy_weights_(worker_rank=None) → None

更新工作节点权重。

参数:

worker_rank (int, 可选) – 如果提供，则仅更新此工作程序权重。