DistributedSyncDataCollector

class 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]) – 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 不在特定設備上，葉張量位於它們被創建的設備上）。支持設備列表。

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

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

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

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

• backend (str, optional) – 必須是字串“<distributed_backed>”，其中 <distributed_backed> 是 "gloo"、"mpi"、"nccl" 或 "ucc" 之一。有關更多資訊，請參閱 torch.distributed 文件。預設為 "gloo"。

• max_weight_update_interval (int, optional) – 在更新工作程序的策略權重之前，可以收集的最大批次數量。對於同步收集，此參數會被 update_after_each_batch 覆寫。對於非同步收集，即使開啟 update_after_each_batch，也可能有一個工作程序在一段時間內沒有看到其參數被更新。預設為 -1（無強制更新）。

• update_interval (int, optional) – 更新策略的頻率。預設為 1。

• launcher (str, optional) – 應該如何啟動任務。可以是 “submitit” 或 “mp”（用於多處理）之一。前者可以在多個節點上啟動任務，而後者只會在單台機器上啟動任務。“submitit” 需要安裝同名的函式庫。要了解更多關於 submitit 的資訊，請訪問 https://github.com/facebookincubator/submitit 預設為 “submitit”。

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

update_policy_weights_(worker_rank=None) → None

如果資料收集器的策略和經過訓練的策略位於不同的裝置上，則更新策略權重。

參數:

policy_weights (TensorDictBase, optional) – 如果提供，則為包含用於更新的策略權重的 TensorDict。