分布式数据收集器

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 or List[Callabled]) – 一个可调用对象列表，每个对象返回一个 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 or torch.device, optional) – 收集器的通用设备。参数 device 用于填充任何未指定的设备：如果 device 不是 None 并且 storing_device, policy_device 或 env_device 中的任何一个未指定，其值将被设置为 device。默认为 None（无默认设备）。支持设备列表。

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

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

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

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

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

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

• postproc (Callable, optional) – 一个后处理转换，例如 Transform 或 MultiStep 实例。默认为 None。

• split_trajs (bool, optional) – 布尔值，指示是否应根据轨迹拆分生成的 TensorDict。有关更多信息，请参阅 split_trajectories()。默认为 False。

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

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

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

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

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

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

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

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

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

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

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

update_policy_weights_(worker_rank=None) → None

更新工作节点的权重。

参数：

worker_rank (int, optional) – 如果提供，将仅更新此工作程序的权重。