DistributedDataCollector

class torchrl.collectors.distributed.DistributedDataCollector(create_env_fn, policy: Callable[[TensorDictBase], TensorDictBase] | None = None, *, policy_factory: Callable[[], Callable] | list[Callable[[] | Callable]] | None = None, frames_per_batch: int, total_frames: int = -1, device: torch.device | list[torch.device] | None = None, storing_device: torch.device | list[torch.device] | None = None, env_device: torch.device | list[torch.device] | None = None, policy_device: torch.device | list[torch.device] | None = 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[str, Any] | None = None, num_workers_per_collector: int = 1, sync: bool = False, slurm_kwargs: dict[str, Any] | None = None, backend: str = 'gloo', update_after_each_batch: bool = False, max_weight_update_interval: int = -1, launcher: str = 'submitit', tcp_port: int | None = None, weight_updater: WeightUpdaterBase | Callable[[], WeightUpdaterBase] | None = 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)。

  注意

  如果策略需要作为策略工厂传递（例如，不应直接序列化/腌制），则应改用 :arg:`policy_factory`。

关键字参数:

• policy_factory (Callable[[], Callable], list of Callable[[], Callable], optional) –

  一个可调用对象（或可调用对象列表），它返回一个策略实例。这与 policy 参数互斥。

  注意

  policy_factory 在策略无法序列化时非常有用。

• 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 是在每个节点上收集的所有 tensordicts 的堆叠。如果为 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。

• weight_updater (WeightUpdaterBase or constructor, optional) – WeightUpdaterBase 或其子类的实例，负责在分布式推理工作节点上更新策略权重。如果未提供，默认将使用 DistributedWeightUpdater，它处理跨分布式工作节点的权重同步。如果更新器需要序列化，请考虑使用构造函数。

async_shutdown(timeout: float | None = None, close_env: bool = True) → None

当收集器通过 start 方法异步启动时，关闭收集器。

参数

timeout (float, optional): 等待收集器关闭的最长时间。 close_env (bool, optional): 如果为 True，收集器将关闭包含的环境。

默认为 True。

另请参阅

start()

init_updater(*args, **kwargs)

使用自定义参数初始化权重更新器。

此方法将参数传递给权重更新器的 init 方法。如果未设置权重更新器，则此方法无效。

参数:

• *args – 用于权重更新器初始化的位置参数

• **kwargs – 用于权重更新器初始化的关键字参数

pause()

上下文管理器，如果收集器正在自由运行，则暂停收集器。

start()

启动收集器以进行异步数据收集。

此方法启动后台数据收集，允许数据收集和训练解耦。

收集的数据通常存储在收集器初始化期间传入的经验回放缓冲区中。

注意

调用此方法后，在完成使用之前，务必使用 async_shutdown() 关闭收集器以释放资源。

警告

由于其解耦的性质，异步数据收集可能会显著影响训练性能。在使用此模式之前，请确保了解其对您特定算法的影响。

抛出:

NotImplementedError – 如果子类未实现。

update_policy_weights_(policy_or_weights: TensorDictBase | TensorDictModuleBase | dict | None = None, *, worker_ids: int | list[int] | torch.device | list[torch.device] | None = None, **kwargs) → None

更新数据收集器的策略权重，支持本地和远程执行上下文。

此方法可确保数据收集器使用的策略权重与最新的训练权重同步。它支持本地和远程权重更新，具体取决于数据收集器的配置。本地（下载）更新在远程（上传）更新之前执行，以便可以将权重从服务器传输到子工作节点。

参数:

• policy_or_weights (TensorDictBase | TensorDictModuleBase | dict | None) – 要更新的权重。可以是：- TensorDictModuleBase：将提取其权重的策略模块- TensorDictBase：包含权重的 TensorDict- dict：包含权重的常规 dict- None：将尝试使用 _get_server_weights() 从服务器获取权重

• worker_ids (int | List[int] | torch.device | List[torch.device] | None, optional) – 需要更新的工作节点标识符。当收集器关联有多个工作节点时，此参数非常重要。

抛出:

TypeError – 如果提供了 worker_ids 但未配置 weight_updater。

注意

用户应扩展 WeightUpdaterBase 类来定制特定用例的权重更新逻辑。不应覆盖此方法。

另请参阅

LocalWeightsUpdaterBase 和 RemoteWeightsUpdaterBase()。