DistributedSyncDataCollector

类 torchrl.collectors.distributed.DistributedSyncDataCollector(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=<class 'torchrl.collectors.collectors.SyncDataCollector'>, collector_kwargs=None, num_workers_per_collector=1, slurm_kwargs=None, backend='gloo', max_weight_update_interval=-1, update_interval=1, launcher='submitit', tcp_port=None)

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

参数：

• create_env_fn (Callable 或 List[Callabled]) – 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, <任意>: 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, 可选) – 要在远程节点上使用的环境构造函数的副本数量。默认为 1（每个收集器一个环境）。在单个工作节点上，所有子工作进程将执行相同的环境。如果需要执行不同的环境，应将它们分派到不同的工作节点，而不是子节点。

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

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

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

• update_interval (int, 可选) – 更新策略的频率。默认为 1。

• launcher (str, 可选) – 如何启动任务。可以是“submitit”或“mp”用于多进程。前者可以在多个节点上启动任务，而后者只能在单台机器上启动任务。“submitit”需要安装同名库。要了解更多关于 submitit 的信息，请访问 https://github.com/facebookincubator/submitit 默认为“submitit”。

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

update_policy_weights_(worker_rank=None) → None

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

参数：

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