RayCollector

class torchrl.collectors.distributed.RayCollector(create_env_fn: Union[Callable, EnvBase, List[Callable], List[EnvBase]], policy: Callable[[TensorDict], TensorDict], *, 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=-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: Union[Dict, List[Dict]] = None, num_workers_per_collector: int = 1, sync: bool = False, ray_init_config: Dict = None, remote_configs: Union[Dict, List[Dict]] = None, num_collectors: int = None, update_after_each_batch=False, max_weight_update_interval=-1)

帶有 Ray 後端的分散式資料收集器。

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

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

類似地，字典輸入引數“remote_configs”可用於在呼叫 ray.remote() 建立每個遠端收集器 actor 時指定 kwargs，包括收集器計算資源。所有收集器資源的總和應在叢集中可用。有關 ray.remote() 方法的高階配置，請參閱 Ray 文件。預設 kwargs 為

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

收集器例項之間的協調可以指定為“同步”或“非同步”。在同步協調中，此類會等待所有遠端收集器完成一次 rollout 收集，將所有 rollout 連線成一個 TensorDict 例項，最後產生連線後的資料。另一方面，如果協調要非同步進行，此類會按各個遠端收集器完成 rollout 的順序提供資料。

引數：

• create_env_fn (Callable 或 List[Callabled]) – Callable 列表，每個 Callable 返回一個 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, Optional) – 收集器返回的總幀數的下限。一旦總幀數等於或超過傳遞給收集器的總幀數，迭代器將停止。預設值為 -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。支援裝置列表。

• create_env_kwargs (dict, optional) – create_env_fn 的 kwargs 字典。

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

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

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

• ray_init_config (dict, Optional) – 呼叫 ray.init() 時使用的 kwargs。

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

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

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

• update_after_each_batch (bool, optional) – 如果為 True，則在每次收集後更新權重。對於 sync=True，這意味著所有 worker 的權重都會得到更新。對於 sync=False，只會更新從中收集資料的 worker 的權重。預設為 False，即必須透過 torchrl.collectors.distributed.RayDistributedCollector.update_policy_weights_() 手動執行更新。

• max_weight_update_interval (int, optional) – 在 worker 的策略權重更新之前可以收集的最大批次數。對於同步收集，此引數會被 update_after_each_batch 覆蓋。對於非同步收集，即使 update_after_each_batch 已開啟，某個 worker 的引數也可能在一定時間內沒有得到更新。預設為 -1（不強制更新）。

示例

>>> from torch import nn
>>> from tensordict.nn import TensorDictModule
>>> from torchrl.envs.libs.gym import GymEnv
>>> from torchrl.collectors.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)

建立並向集合中新增多個遠端收集器。

load_state_dict(state_dict: Union[OrderedDict, List[OrderedDict]]) → None

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

local_policy()

返回本地收集器。

remote_collectors()

返回遠端收集器列表。

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

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

shutdown()

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

state_dict() → List[OrderedDict]

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

stop_remote_collectors()

停止所有遠端收集器。

update_policy_weights_(worker_rank=None) → None

更新 worker 節點的權重。

引數：

worker_rank (int, optional) – 如果提供，則僅更新此 worker 的權重。