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, exploration_mode: str = None, 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]) – 可调用对象的列表，每个对象都返回 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 指示的值。对于长轨迹，可能需要将数据存储在与策略和环境执行所在的设备不同的设备上。默认为 None（输出 tensordict 不在特定设备上，叶子张量位于创建它们的设备上）。支持设备列表。

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

• policy_device (int, str 或 torch.device, 可选) – 策略应该转换到的远程设备。如果传递了 device 且 policy_device=None，则它将默认为 device。如果 policy_device 的指定值与 env_device 不同，并且其中一个不为 None，则数据将在传递给策略之前转换为 policy_device（即，支持将不同的设备传递给策略和环境）。默认为 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，可选） – 如果提供，则仅更新此工作进程的权重。