DistributedSyncDataCollector

class torchrl.collectors.distributed.DistributedSyncDataCollector(create_env_fn, policy: Callable[[TensorDictBase], TensorDictBase] | None = None, *, policy_factory: Callable[[], Callable] | list[Callable[[], Callable]] | None = None, 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 | Callable[[], DataCollectorBase] = <class 'torchrl.collectors.collectors.SyncDataCollector'>, collector_kwargs: dict[str, Any] | None = None, num_workers_per_collector: int = 1, slurm_kwargs: dict[str, Any] | None = None, backend: Literal['gloo', 'nccl'] = 'gloo', max_weight_update_interval: int = -1, update_interval: int = 1, launcher: str = 'submitit', tcp_port: str | None = None)

一個帶有 torch.distributed 後端的分散式同步資料收集器。

引數:

• create_env_fn (Callable 或 List[Callabled]) – 返回 EnvBase 例項的 Callables 列表。

• policy (Callable) –

  要在環境中執行的策略。必須接受 tensordict.tensordict.TensorDictBase 物件作為輸入。如果提供 None，則使用的策略將是 RandomPolicy 例項，並具有環境 action_spec。通常接受的策略是 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)。

  注意

  如果策略需要作為策略工廠傳遞（例如，不應直接序列化/醃製），則應改用 :arg:`policy_factory`。

關鍵字引數:

• policy_factory (Callable[[], Callable], list of Callable[[], Callable], optional) –

  一個可呼叫物件（或可呼叫物件列表），它返回一個策略例項。這與 policy 引數互斥。

  注意

  policy_factory 在策略無法序列化時非常有用。

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

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

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

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

• backend (str, 可選) – 必須是字串“<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, 可選) – 更新策略的頻率。預設為 1。

• launcher (str, 可選) – 作業的啟動方式。可以是“submitit”或“mp”（用於多程序）之一。前者可以跨多個節點啟動作業，而後者只能在單臺機器上啟動作業。“submitit”需要安裝同名的庫。要了解有關 submitit 的更多資訊，請訪問 https://github.com/facebookincubator/submitit。預設為“submitit”。

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

async_shutdown(timeout: float | None = None, close_env: bool = True) → None

當收集器透過 start 方法非同步啟動時，關閉收集器。

引數

timeout (float, optional): 等待收集器關閉的最長時間。 close_env (bool, optional): 如果為 True，收集器將關閉包含的環境。

預設為 True。

另請參閱

start()

init_updater(*args, **kwargs)

使用自定義引數初始化權重更新器。

此方法將引數傳遞給權重更新器的 init 方法。如果未設定權重更新器，則此方法無效。

引數:

• *args – 用於權重更新器初始化的位置引數

• **kwargs – 用於權重更新器初始化的關鍵字引數

pause()

上下文管理器，如果收集器正在自由執行，則暫停收集器。

start()

啟動收集器以進行非同步資料收集。

此方法啟動後臺資料收集，允許資料收集和訓練解耦。

收集的資料通常儲存在收集器初始化期間傳入的經驗回放緩衝區中。

注意

呼叫此方法後，在使用完畢時務必使用 async_shutdown() 關閉收集器以釋放資源。

警告

由於其解耦的性質，非同步資料收集可能會顯著影響訓練效能。在使用此模式之前，請確保瞭解其對您特定演算法的影響。

丟擲:

NotImplementedError – 如果子類未實現。

update_policy_weights_(policy_or_weights: TensorDictBase | None = None, *, worker_ids=None, wait=True, **kwargs) → None

更新資料收集器的策略權重，支援本地和遠端執行上下文。

此方法確保資料收集器使用的策略權重與最新的訓練權重同步。它支援本地和遠端權重更新，具體取決於資料收集器的配置。本地（下載）更新在遠端（上傳）更新之前執行，以便可以將權重從伺服器傳輸到子工作器。

引數:

• policy_or_weights (TensorDictBase | TensorDictModuleBase | dict | None) – 要更新的權重。可以是： - TensorDictModuleBase：將提取其權重的策略模組 - TensorDictBase：包含權重的 TensorDict - dict：包含權重的常規 dict - None：將嘗試使用 _get_server_weights() 從伺服器獲取權重

• worker_ids (int | List[int] | torch.device | List[torch.device] | None, optional) – 需要更新的工作器的識別符號。當收集器關聯多個工作器時，此項很重要。

丟擲:

TypeError – 如果提供了 worker_ids 但未配置 weight_updater。

注意

使用者應擴充套件 WeightUpdaterBase 類來定製特定用例的權重更新邏輯。不應覆蓋此方法。

另請參閱

LocalWeightsUpdaterBase 和 RemoteWeightsUpdaterBase()。