RPCDataCollector

類 torchrl.collectors.distributed.RPCDataCollector(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, sync=False, slurm_kwargs=None, update_after_each_batch=False, max_weight_update_interval=-1, launcher='submitit', tcp_port=None, visible_devices=None, tensorpipe_options=None)

一個基於 RPC 的分散式資料收集器。

支援同步和非同步資料收集。

引數：

• create_env_fn (可呼叫物件 或 可呼叫物件列表) – 可呼叫物件列表，每個物件返回一個 EnvBase 例項。

• policy (可呼叫物件) –

  要在環境中執行的策略。必須接受 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 (可呼叫物件, 可選) – 一個後處理 transform，例如 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 之一。預設為 torchrl.envs.utils.ExplorationType.RANDOM。

• collector_class (型別 或 str, 可選) –

  遠端節點的收集器類。可以是 SyncDataCollector、MultiSyncDataCollector、MultiaSyncDataCollector 或它們的派生類。字串“single”、“sync”和“async”對應各自的類。預設為 SyncDataCollector。

  注意

  對 MultiSyncDataCollector 和 MultiaSyncDataCollector 的支援是實驗性的，應始終優先使用 SyncDataCollector。如果需要在單個節點上執行多個同時環境，請考慮使用 ParallelEnv 例項。

• collector_kwargs (dict 或 list, 可選) – 要傳遞給遠端資料收集器的引數字典。如果提供一個列表，則每個元素將對應於指定收集器的一組獨立的關鍵字引數。

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

• sync (bool, 可選) – 如果為 True，則結果 tensordict 是在每個節點上收集的所有 tensordict 的堆疊。如果為 False（預設），每個 tensordict 來自一個單獨的節點，採用“先就緒，先服務”的方式。

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

• update_after_each_batch (bool, 可選) – 如果為 True，則在每次收集後更新權重。對於 sync=True，這意味著所有工作器都將看到其權重被更新。對於 sync=False，只有從中收集資料的那個工作器會被更新。預設為 False，即必須透過 update_policy_weights_() 手動執行更新。

• max_weight_update_interval (int, 可選) – 在一個工作器的策略權重更新之前，可以收集的最大批次數量。對於同步收集，此引數會被 update_after_each_batch 覆蓋。對於非同步收集，即使 update_after_each_batch 開啟，也可能存在某個工作器的引數長時間未更新的情況。預設為 -1（無強制更新）。

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

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

• visible_devices (Union[int, torch.device, str] 列表, 可選) – 一個長度與節點數量相同的列表，包含用於將資料傳遞到主程序的裝置。

• tensorpipe_options (dict, 可選) – 要傳遞給 torch.distributed.rpc.TensorPipeRpcBackendOption 的關鍵字引數字典。

update_policy_weights_(workers=None, wait=True) → None

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

引數：

policy_weights (TensorDictBase, 可選) – 如果提供，一個包含用於更新的策略權重的 TensorDict。