RPCDataCollector

class torchrl.collectors.distributed.RPCDataCollector(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=<class 'torchrl.collectors.collectors.SyncDataCollector'>, collector_kwargs=None, num_workers_per_collector=1, sync=False, slurm_kwargs=None, update_after_each_batch=False, max_weight_update_interval=-1, launcher='submitit', tcp_port=None, visible_devices=None, tensorpipe_options=None)

基于 RPC 的分布式数据收集器。

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

参数：

• 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 不为 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 之一。默认值为 torchrl.envs.utils.ExplorationType.RANDOM。

• collector_class (type 或 str, 可选) –

  远程节点的收集器类。可以是 SyncDataCollector、MultiSyncDataCollector、MultiaSyncDataCollector 或这些类的派生类。字符串“single”、“sync”和“async”对应于相应的类。默认值为 SyncDataCollector。

  注意

  对 MultiSyncDataCollector 和 MultiaSyncDataCollector 的支持处于实验阶段，并且应该始终优先使用 SyncDataCollector。如果需要在单个节点上执行多个同时环境，请考虑使用 ParallelEnv 实例。

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

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

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

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

• 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” 需要安装同名的库。要详细了解 submitit，请访问 https://github.com/facebookincubator/submitit 默认值为“submitit”。

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

• visible_devices (list of Union[int, torch.device, str], 可选) – 与节点数量相同的列表，包含用于将数据传递到主节点的设备。

• tensorpipe_options (dict, 可选) – 要传递给 torch.distributed.rpc.TensorPipeRpcBackendOption 的关键字参数字典。

update_policy_weights_(workers=None, wait=True) → None

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

参数：

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