分散式資料收集器

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 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)。

關鍵字引數：

• 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 是在每個節點上收集的所有 tensordict 的堆疊。如果為 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。

update_policy_weights_(worker_rank=None) → None

更新工作節點的權重。

引數：

worker_rank (int, optional) – 如果提供，將僅更新此工作程式的權重。