RayCollector

class torchrl.collectors.distributed.RayCollector(create_env_fn: Callable | EnvBase | list[Callable] | list[EnvBase], 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 = None, storing_device: torch.device | list[torch.device] | None = None, env_device: torch.device | list[torch.device] | None = None, policy_device: torch.device | list[torch.device] | None = None, max_frames_per_traj=-1, init_random_frames=-1, reset_at_each_iter=False, postproc=None, split_trajs=False, exploration_type=InteractionType.RANDOM, collector_class: Callable[[TensorDict], TensorDict] = <class 'torchrl.collectors.collectors.SyncDataCollector'>, collector_kwargs: dict[str, Any] | list[dict] | None = None, num_workers_per_collector: int = 1, sync: bool = False, ray_init_config: dict[str, Any] | None = None, remote_configs: dict[str, Any] | list[dict[str, Any]] | None = None, num_collectors: int | None = None, update_after_each_batch: bool = False, max_weight_update_interval: int = -1, replay_buffer: ReplayBuffer | None = None, weight_updater: WeightUpdaterBase | Callable[[], WeightUpdaterBase] | None = None)

使用 Ray 後端的分散式資料收集器。

這個 Python 類作為基於 ray 的解決方案，用於在分散式叢集中例項化和協調多個數據收集器。與 TorchRL 的非分散式收集器一樣，這個收集器是一個可迭代物件，它會產生 TensorDict，直到達到目標收集幀數，但在底層處理分散式資料收集。

類字典輸入引數“ray_init_config”可用於提供呼叫 Ray 初始化方法 ray.init() 的關鍵字引數。如果未提供“ray_init_config”，則預設行為是自動檢測現有的 Ray 叢集，或者在未找到現有叢集時本地啟動一個新的 Ray 例項。有關高階初始化關鍵字引數，請參閱 Ray 文件。

同樣，字典輸入引數“remote_configs”可用於指定建立每個遠端收集器 actor 時呼叫 ray.remote() 的關鍵字引數，包括收集器的計算資源。所有收集器資源的聚合應該可以在叢集中找到。有關 ray.remote() 方法的高階配置，請參閱 Ray 文件。預設關鍵字引數是

>>> kwargs = {
...     "num_cpus": 1,
...     "num_gpus": 0.2,
...     "memory": 2 * 1024 ** 3,
... }

收集器例項之間的協調可以指定為“同步”或“非同步”。在同步協調中，此類會等待所有遠端收集器收集一個 rollout，將所有 rollouts 串聯成一個 TensorDict 例項，最後產生串聯後的資料。另一方面，如果協調是非同步進行的，此類會提供從各個遠端收集器那裡獲得的 rollouts。

引數:

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

• policy (Callable, optional) –

  要在環境中執行的策略。必須接受 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)。

  注意

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

關鍵字引數:

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

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

  注意

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

• frames_per_batch (int) – 一個僅關鍵字引數，表示批次中的總元素數。

• total_frames (int, Optional) – 收集器返回的總幀數的下限。迭代器將在收集的總幀數等於或超過傳遞給收集器的總幀數時停止。預設值為 -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。支援裝置列表。

• create_env_kwargs (dict, optional) – create_env_fn 的關鍵字引數字典。

• 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 (Python class or constructor) – 要遠端例項化的收集器類。可以是 SyncDataCollector、MultiSyncDataCollector、MultiaSyncDataCollector 或它們的派生類。預設為 SyncDataCollector。

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

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

• ray_init_config (dict, Optional) – 用於呼叫 ray.init() 的關鍵字引數。

• remote_configs (list of dicts, Optional) – 每個遠端收集器的 Ray 資源規範。也可以提供單個字典，它將用於所有收集器。

• num_collectors (int, Optional) – 要例項化的總收集器數量。

• sync (bool) – 如果為 True，則生成的 tensordict 是在每個節點上收集的所有 tensordicts 的堆疊。如果為 False（預設），則每個 tensordict 以“先到先得”的方式從單獨的節點生成。

• update_after_each_batch (bool, optional) – 如果為 True，則在每次收集後更新權重。對於 sync=True，這意味著所有工作程式都將看到其權重得到更新。對於 sync=False，只有從中收集資料的工件將被更新。這等同於max_weight_update_interval=0。預設為 False，即必須透過 torchrl.collectors.DataCollector.update_policy_weights_() 手動執行更新。

• max_weight_update_interval (int, optional) – 在更新工作程式的策略權重之前可以收集的最大批次數。對於同步收集，此引數將被 update_after_each_batch 覆蓋。對於非同步收集，一個工作程式可能在一段時間內未檢視其引數更新，即使 update_after_each_batch 已開啟。預設為 -1（無強制更新）。

• replay_buffer (RayReplayBuffer, optional) –

  如果提供，收集器將不會產生 tensordicts，而是填充緩衝區。預設為 None。

  注意

  雖然沒有強制執行（為了允許使用者實現自己的回放緩衝區類），但此處應使用 RayReplayBuffer 例項。

• weight_updater (WeightUpdaterBase or constructor, optional) – WeightUpdaterBase 或其子類的例項，負責更新 Ray 管理的遠端推理工作程式上的策略權重。如果未提供，預設將使用 RayWeightUpdater，它利用 Ray 的分散式功能。如果需要序列化更新程式，請考慮使用建構函式。

示例

>>> from torch import nn
>>> from tensordict.nn import TensorDictModule
>>> from torchrl.envs.libs.gym import GymEnv
>>> from torchrl.collectors import SyncDataCollector
>>> from torchrl.collectors.distributed import RayCollector
>>> env_maker = lambda: GymEnv("Pendulum-v1", device="cpu")
>>> policy = TensorDictModule(nn.Linear(3, 1), in_keys=["observation"], out_keys=["action"])
>>> distributed_collector = RayCollector(
...     create_env_fn=[env_maker],
...     policy=policy,
...     collector_class=SyncDataCollector,
...     max_frames_per_traj=50,
...     init_random_frames=-1,
...     reset_at_each_iter=-False,
...     collector_kwargs={
...         "device": "cpu",
...         "storing_device": "cpu",
...     },
...     num_collectors=1,
...     total_frames=10000,
...     frames_per_batch=200,
... )
>>> for i, data in enumerate(collector):
...     if i == 2:
...         print(data)
...         break

add_collectors(create_env_fn, num_envs, policy, collector_kwargs, remote_configs)

建立並向集合新增一定數量的遠端收集器。

async async_shutdown()

結束 ray.init() 在非同步執行期間啟動的程序。

init_updater(*args, **kwargs)

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

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

引數:

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

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

load_state_dict(state_dict: OrderedDict | list[OrderedDict]) → None

為每個遠端收集器呼叫父方法。

local_policy()

返回本地收集器。

pause()

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

property remote_collectors

返回遠端收集器列表。

set_seed(seed: int, static_seed: bool = False) → list[int]

迭代呼叫父方法為每個遠端收集器設定種子，並返回最終種子。

shutdown(timeout: float | None = None) → None

結束由 ray.init() 啟動的程序。

start()

啟動 RayCollector。

state_dict() → list[collections.OrderedDict]

為每個遠端收集器呼叫父方法並返回結果列表。

stop_remote_collectors()

停止所有遠端收集器。

update_policy_weights_(policy_or_weights: TensorDictBase | TensorDictModuleBase | dict | None = None, *, worker_ids: int | list[int] | torch.device | list[torch.device] | None = None, **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()。