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，包含用於更新的策略權重。