DistributedDataCollector

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 或 List[Callabled]) – Callables 的列表，每個都返回 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, optional) – 收集器的通用設備。 device 引數會填入任何未指定的設備：如果 device 不是 None 並且 storing_device、policy_device 或 env_device 中的任何一個都未指定，則其值將設定為 device。預設為 None (無預設設備)。支援設備列表。

• storing_device (int, str 或 torch.device, optional) – 儲存輸出 TensorDict 的遠端裝置。如果傳遞了 device 且 storing_device 為 None，則預設為 device 所指示的值。對於長時間的軌跡，可能需要將資料儲存在與策略和環境執行位置不同的裝置上。預設值為 None (輸出 tensordict 不在特定裝置上，葉節點 tensor 位於它們被建立的裝置上)。支援裝置列表。

• env_device (int, str 或 torch.device, optional) – 遠端裝置，環境應被轉換到此裝置 (如果該功能受支援，則在此裝置上執行)。如果未指定且環境具有非 None 的裝置，則 env_device 將預設為該值。如果傳遞了 device 且 env_device=None，則預設為 device。如果 env_device 的指定值與 policy_device 不同，且其中一個不是 None，則資料將在傳遞給環境之前被轉換為 env_device（即，支援將不同的裝置傳遞給策略和環境）。預設值為 None。支援裝置列表。

• policy_device (int, str 或 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 或 str, optional) – 遠端節點的收集器類別。可以是 SyncDataCollector、MultiSyncDataCollector、MultiaSyncDataCollector 或這些類別的派生類別。字串 "single"、"sync" 和 "async" 對應於各自的類別。預設值為 SyncDataCollector。

• collector_kwargs (dict 或 list, optional) – 要傳遞到遠端資料收集器的參數字典。如果提供列表，則每個元素將對應於專用收集器的個別關鍵字引數集。

• num_workers_per_collector (int, optional) – 要在遠端節點上使用的環境建構函式的副本數量。預設值為 1（每個收集器一個環境）。在單個工作節點上，所有子工作者將執行相同的環境。如果需要執行不同的環境，它們應該跨工作節點而不是子節點進行分派。

• sync (bool, optional) – 如果 True，則產生的 tensordict 是在每個節點上收集的所有 tensordict 的堆疊。如果 False (預設)，則每個 tensordict 來自單獨節點，以 “first-ready, first-served” 的方式提供。

• slurm_kwargs (dict) – 要傳遞給 submitit executor 的參數字典。

• backend (str, optional) – 必須為字串 "<distributed_backed>"，其中 <distributed_backed> 為 "gloo"、"mpi"、"nccl" 或 "ucc" 其中之一。詳情請參閱 torch.distributed 文件。預設值為 "gloo"。

• update_after_each_batch (bool, optional) – 如果 True，則權重將在每次收集後更新。對於 sync=True，這表示所有 worker 都會看到它們的權重更新。對於 sync=False，只有收集到資料的 worker 會被更新。預設值為 False，即更新必須透過 update_policy_weights_() 手動執行。

• max_weight_update_interval (int, optional) – 在 worker 的策略權重更新之前，可以收集的最大批次數量。對於同步收集，此參數會被 update_after_each_batch 覆蓋。對於異步收集，即使 update_after_each_batch 已開啟，也可能發生某個 worker 在一段時間內沒有看到其參數被更新的情況。預設值為 -1 (不強制更新)。

• launcher (str, optional) – 應如何啟動 job。可以是 "submitit" 或 "mp" (用於多進程)。如果您的叢集不支援從現有 job 產生 job，請使用 "submitit_delayed"。前者可以在多個節點上啟動 job，而後者只會在單一機器上啟動 job。"submitit" 需要安裝同名的函式庫。要了解更多關於 submitit 的資訊，請訪問 https://github.com/facebookincubator/submitit 並查看我們的範例以了解更多資訊。預設值為 "submitit"。

• tcp_port (int, optional) – 要使用的 TCP 埠。預設值為 10003。

update_policy_weights_(worker_rank=None) → None

更新 worker 節點的權重。

參數:

worker_rank (int, optional) – 如果提供，則僅更新此 worker 的權重。