RayCollector¶

class torchrl.collectors.distributed.RayCollector(create_env_fn: ~typing.Union[~typing.Callable, ~torchrl.envs.common.EnvBase, ~typing.List[~typing.Callable], ~typing.List[~torchrl.envs.common.EnvBase]], policy: ~typing.Callable[[~tensordict._td.TensorDict], ~tensordict._td.TensorDict], *, frames_per_batch: int, total_frames: int = -1, device: ~typing.Optional[~typing.Union[~torch.device, ~typing.List[~torch.device]]] = None, storing_device: ~typing.Optional[~typing.Union[~torch.device, ~typing.List[~torch.device]]] = None, env_device: ~typing.Optional[~typing.Union[~torch.device, ~typing.List[~torch.device]]] = None, policy_device: ~typing.Optional[~typing.Union[~torch.device, ~typing.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: ~typing.Callable[[~tensordict._td.TensorDict], ~tensordict._td.TensorDict] = <class 'torchrl.collectors.collectors.SyncDataCollector'>, collector_kwargs: ~typing.Optional[~typing.Union[~typing.Dict, ~typing.List[~typing.Dict]]] = None, num_workers_per_collector: int = 1, sync: bool = False, ray_init_config: ~typing.Optional[~typing.Dict] = None, remote_configs: ~typing.Optional[~typing.Union[~typing.Dict, ~typing.List[~typing.Dict]]] = None, num_collectors: ~typing.Optional[int] = None, update_after_each_batch=False, max_weight_update_interval=-1)[來源]¶

具有 Ray 後端的分布式資料收集器。

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

類別字典輸入參數 “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,
... }

收集器實例之間的協調可以指定為 “synchronous”（同步）或 “asynchronous”（非同步）。在同步協調中，此類別會等待所有遠端收集器收集一個 rollout，將所有 rollouts 連接成單個 TensorDict 實例，最後產生連接的資料。另一方面，如果協調以非同步方式進行，則此類別會在個別遠端收集器可用時提供 rollouts。

參數:

create_env_fn (Callable 或 List[Callabled]) – Callables 的列表，每個都回傳 EnvBase 的實例。
policy (Callable) –
要在環境中執行的 Policy。必須接受 tensordict.tensordict.TensorDictBase 物件作為輸入。如果提供 None，則使用的 Policy 將會是具有環境 action_spec 的 RandomPolicy 實例。接受的 Policy 通常是 TensorDictModuleBase 的子類別。這是收集器的建議用法。也接受其他 callables：如果 Policy 不是 TensorDictModuleBase（例如，常規的 Module 實例），它將首先被包裝在 nn.Module 中。然後，收集器將嘗試評估這些模組是否需要包裝在 TensorDictModule 中。 - 如果 Policy forward 簽章符合 forward(self, tensordict)、

forward(self, td) 或 forward(self, <anything>: TensorDictBase)（或任何將單個參數類型設定為 TensorDictBase 子類別的類型）中的任何一個，則 Policy 不會被包裝在 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 指示的值。對於長軌跡，可能有必要將資料儲存在與執行 Policy 和 Env 的裝置不同的裝置上。預設為 None（輸出 tensordict 不在特定裝置上，葉節點張量位於它們被建立的裝置上）。支援裝置列表。
env_device (int, str 或 torch.device, optional) – 環境應該被轉換（或在支援該功能的情況下執行）的遠端裝置。如果未指定，且 Env 具有非 None 裝置，則 env_device 將預設為該值。如果傳遞 device 並且 env_device=None，則它將預設為 device。如果如此指定的 env_device 值與 policy_device 不同，並且其中一個不是 None，則資料將在傳遞給 Env 之前被轉換為 env_device（即，支援將不同的裝置傳遞給 Policy 和 Env）。預設為 None。支援裝置列表。
policy_device (int, str 或 torch.device, optional) – Policy 應該被轉換到的遠端裝置。如果傳遞 device 並且 policy_device=None，則它將預設為 device。如果如此指定的 policy_device 值與 env_device 不同，並且其中一個不是 None，則資料將在傳遞給 Policy 之前被轉換為 policy_device（即，支援將不同的裝置傳遞給 Policy 和 Env）。預設為 None。支援裝置列表。
create_env_kwargs (dict, optional) – create_env_fn 的 kwargs 字典。
max_frames_per_traj (int, optional) – 每個 trajectory 的最大步數。請注意，一個 trajectory 可以跨越多個批次（除非 reset_at_each_iter 設定為 True，請參閱下方）。一旦 trajectory 達到 n_steps，環境就會重置。如果環境將多個環境包在一起，則會針對每個環境獨立追蹤步數。允許負值，在這種情況下，此參數將被忽略。預設值為 None（即，沒有最大步數）。
init_random_frames (int, optional) – 在呼叫 policy 之前忽略 policy 的幀數。此功能主要用於離線/基於模型的設定，其中可以使用一批隨機 trajectory 來初始化訓練。如果提供，它將四捨五入到 frames_per_batch 的最接近倍數。預設值為 None（即，沒有隨機幀）。
reset_at_each_iter (bool, optional) – 是否應在每次批次收集開始時重置環境。預設值為 False。
postproc (Callable, optional) – 一個後處理轉換，例如 Transform 或 MultiStep 實例。預設值為 None。
split_trajs (bool, optional) – 布林值，指示是否應根據 trajectory 分割產生的 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 or list, optional) – 要傳遞給遠端資料收集器的參數字典。如果提供列表，則每個元素將對應於專用收集器的一組個別關鍵字參數。
num_workers_per_collector (int) – 要在遠端節點上使用的 env 建構函式副本數。預設值為 1（每個收集器單一 env）。在單一 worker 節點上，所有子 worker 都將執行相同的環境。如果需要執行不同的環境，則應將它們分派到 worker 節點，而不是子節點。
ray_init_config (dict, Optional) – 用於呼叫 ray.init() 的 kwargs。
remote_configs (list of dicts, Optional) – 每個遠端收集器的 ray 資源規格。也可以提供單一字典，並將在所有收集器中使用。
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 的 policy 權重之前可以收集的最大批次數。對於同步收集，此參數將被 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)[source]¶: 建立並將一些遠端收集器添加到集合中。

load_state_dict(state_dict: Union[OrderedDict, List[OrderedDict]]) → None[source]¶: 為每個遠端收集器呼叫父方法。

local_policy()[source]¶: 回傳本地收集器。

remote_collectors()[source]¶: 回傳遠端收集器的列表。

set_seed(seed: int, static_seed: bool = False) → List[int][source]¶: 為每個遠端收集器迭代呼叫父方法，並回傳最終的 seed。

shutdown()[source]¶: 結束 ray.init() 啟動的程序。

state_dict() → List[OrderedDict][source]¶: 為每個遠端收集器呼叫父方法，並回傳結果的列表。

stop_remote_collectors()[source]¶: 停止所有遠端收集器。

update_policy_weights_(worker_rank=None) → None[source]¶

更新 worker 節點的權重。

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

RayCollector¶

文件

Tutorials

Resources