MultiSyncDataCollector

class torchrl.collectors.MultiSyncDataCollector(create_env_fn: Sequence[Callable[[], EnvBase]], policy: Optional[Union[TensorDictModule, Callable[[TensorDictBase], TensorDictBase]]] = None, *, frames_per_batch: int, total_frames: Optional[int] = - 1, device: Optional[Union[device, str, int, Sequence[Union[device, str, int]]]] = None, storing_device: Optional[Union[device, str, int, Sequence[Union[device, str, int]]]] = None, env_device: Optional[Union[device, str, int, Sequence[Union[device, str, int]]]] = None, policy_device: Optional[Union[device, str, int, Sequence[Union[device, str, int]]]] = None, create_env_kwargs: Optional[Sequence[dict]] = None, max_frames_per_traj: Optional[int] = None, init_random_frames: Optional[int] = None, reset_at_each_iter: bool = False, postproc: Optional[Callable[[TensorDictBase], TensorDictBase]] = None, split_trajs: Optional[bool] = None, exploration_type: InteractionType = InteractionType.RANDOM, reset_when_done: bool = True, update_at_each_batch: bool = False, preemptive_threshold: Optional[float] = None, num_threads: Optional[int] = None, num_sub_threads: int = 1, cat_results: Optional[Union[str, int]] = None, set_truncated: bool = False, use_buffers: Optional[bool] = None, replay_buffer: Optional[ReplayBuffer] = None, replay_buffer_chunk: bool = True, trust_policy: Optional[bool] = None, compile_policy: Optional[Union[bool, Dict[str, Any]]] = None, cudagraph_policy: Optional[Union[bool, Dict[str, Any]]] = None)

在不同的程序上同步執行指定數量的 DataCollector。

環境可以是相同的或不同的。

當查詢收集器的下一個項目時，集合會開始，並且在接收到一批軌跡和開始下一個集合之間，不會計算環境步驟。此類別可以安全地與線上 RL sota 實作一起使用。

注意

Python 要求多處理程式碼在主防護中被實例化

>>> from torchrl.collectors import MultiSyncDataCollector
>>> if __name__ == "__main__":
...     # Create your collector here

有關更多資訊，請參閱 https://docs.python.org/3/library/multiprocessing.html。

範例

>>> from torchrl.envs.libs.gym import GymEnv
>>> from tensordict.nn import TensorDictModule
>>> from torch import nn
>>> from torchrl.collectors import MultiSyncDataCollector
>>> if __name__ == "__main__":
...     env_maker = lambda: GymEnv("Pendulum-v1", device="cpu")
...     policy = TensorDictModule(nn.Linear(3, 1), in_keys=["observation"], out_keys=["action"])
...     collector = MultiSyncDataCollector(
...         create_env_fn=[env_maker, env_maker],
...         policy=policy,
...         total_frames=2000,
...         max_frames_per_traj=50,
...         frames_per_batch=200,
...         init_random_frames=-1,
...         reset_at_each_iter=False,
...         device="cpu",
...         storing_device="cpu",
...         cat_results="stack",
...     )
...     for i, data in enumerate(collector):
...         if i == 2:
...             print(data)
...             break
... collector.shutdown()
... del collector
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.float32, is_shared=False),
        collector: TensorDict(
            fields={
                traj_ids: Tensor(shape=torch.Size([200]), device=cpu, dtype=torch.int64, is_shared=False)},
            batch_size=torch.Size([200]),
            device=cpu,
            is_shared=False),
        done: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([200, 3]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                step_count: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.int64, is_shared=False),
                truncated: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([200]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([200, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        step_count: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.int64, is_shared=False),
        truncated: Tensor(shape=torch.Size([200, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([200]),
    device=cpu,
    is_shared=False)

在不同的程序上執行指定數量的 DataCollector。

參數:

• create_env_fn (List[Callabled]) – Callables 的列表，每個 Callable 都返回一個 EnvBase 的實例。

• policy (Callable) –

  要在環境中執行的策略。必須接受 tensordict.tensordict.TensorDictBase 物件作為輸入。如果提供了 None (預設值)，則使用的策略將是一個 RandomPolicy 實例，其具有環境 action_spec。接受的策略通常是 TensorDictModuleBase 的子類別。這是收集器的建議用法。也接受其他 callables：如果策略不是 TensorDictModuleBase (例如，常規的 Module 實例)，它將首先被包裝在一個 nn.Module 中。然後，收集器將嘗試評估這些模組是否需要包裝在 TensorDictModule 中。 - 如果策略前向簽名匹配 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) –

  一個僅限關鍵字的參數，表示收集器在其生命週期內返回的總幀數。如果 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 不在特定裝置上，leaf tensors 位於它們被建立的裝置上)。 如果希望為每個工作者指示不同的裝置，則支援裝置列表。 該列表的長度必須與工作者的數量相同。

• 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。 如果希望為每個工作者指示不同的裝置，則支援裝置列表。 該列表的長度必須與工作者的數量相同。

• create_env_kwargs (dict, 選用) – 包含用於建立環境的關鍵字引數的字典。 如果提供了列表，則其每個元素將被分配給一個子收集器。

• 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 (Callable, 選用) – 一個後處理轉換，例如 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 其中之一。

• reset_when_done (bool, 選擇性) – 如果 True (預設)，在 "done" 或 "truncated" 條目中返回 True 值的環境將在相應的索引處重置。

• update_at_each_batch (boolm, 選擇性) – 如果 True, update_policy_weight_() 將在每次資料收集之前 (同步) 或之後 (非同步) 被呼叫。預設為 False。

• preemptive_threshold (float, 選擇性) – 介於 0.0 和 1.0 之間的值，用於指定在強制其餘 workers 提早結束之前，允許多少比例的 workers 完成收集其 rollout。

• num_threads (int, 選擇性) – 此進程的執行緒數量。預設為 workers 的數量。

• num_sub_threads (int, 選擇性) – 子進程的執行緒數量。應等於 1 加上每個子進程內啟動的進程數量 (如果只啟動一個進程，則為 1)。為安全起見，預設為 1：如果沒有指定，啟動多個 workers 可能會過度增加 CPU 負載並損害效能。

• cat_results (str, int or None) –

  (僅限 MultiSyncDataCollector)。如果 "stack"，從 workers 收集的資料將沿著第一個維度堆疊。這是首選行為，因為它與函式庫的其餘部分最相容。如果 0，結果將沿著輸出的第一個維度連接，如果環境是批次的，則可以是批次維度；如果不是批次的，則可以是時間維度。cat_results 的值為 -1 將始終沿著時間維度連接結果。這應該優先於預設值。也接受中間值。預設為 "stack"。

  注意

  從 v0.5 開始，為了更好地與函式庫的其餘部分互通，此參數將預設為 "stack"。

• set_truncated (bool, 選擇性) – 如果 True，當到達 rollout 的最後一幀時，truncated 信號 (和相應的 "done"，但不包含 "terminated") 將被設定為 True。如果找不到 "truncated" 鍵，則會引發異常。Truncated 鍵可以透過 env.add_truncated_keys 設定。預設為 False。

• use_buffers (bool, 選擇性) – 如果 True，將使用緩衝區來堆疊資料。這與具有動態規格的環境不相容。對於沒有動態規格的環境，預設為 True；對於其他環境，預設為 False。

• replay_buffer (ReplayBuffer, 選擇性) – 如果提供，收集器將不會產生 tensordict，而是填充緩衝區。預設為 None。

• trust_policy (bool, 選擇性) – 如果 True，將信任非 TensorDictModule 策略與收集器相容。對於 CudaGraphModules，這預設為 True，否則為 False。

• compile_policy (bool or Dict[str, Any], 選擇性) – 如果 True, 策略將使用 compile() 的預設行為編譯。 如果傳入 kwargs 的字典, 它將被用來編譯策略。

• cudagraph_policy (bool or Dict[str, Any], 選擇性) – 如果 True, 策略將使用預設 kwargs 包裹在 CudaGraphModule 中。 如果傳入 kwargs 的字典, 它將被用來包裹策略。

load_state_dict(state_dict: OrderedDict) → None

在 workers 上加載 state_dict。

參數:

state_dict (OrderedDict) – 形式為 {"worker0": state_dict0, "worker1": state_dict1} 的 state_dict。

reset(reset_idx: Optional[Sequence[bool]] = None) → None

將環境重置為新的初始狀態。

參數:

reset_idx – 選擇性參數。指示必須重置哪些環境的序列。如果為 None，則重置所有環境。

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

設定 DataCollector 中儲存之環境的種子 (seed)。

參數:

• seed – 代表環境所使用的種子的整數。

• static_seed (bool, optional) – 若 True，則種子不會遞增。預設值為 False。

回傳:

輸出的種子。當 DataCollector 中包含多個環境時，這非常有用，因為每個環境的種子都會遞增。結果種子是最後一個環境的種子。

範例

>>> from torchrl.envs import ParallelEnv
>>> from torchrl.envs.libs.gym import GymEnv
>>> from tensordict.nn import TensorDictModule
>>> from torch import nn
>>> env_fn = lambda: GymEnv("Pendulum-v1")
>>> env_fn_parallel = lambda: ParallelEnv(6, env_fn)
>>> policy = TensorDictModule(nn.Linear(3, 1), in_keys=["observation"], out_keys=["action"])
>>> collector = SyncDataCollector(env_fn_parallel, policy, frames_per_batch=100, total_frames=300)
>>> out_seed = collector.set_seed(1)  # out_seed = 6

shutdown()

關閉所有程序。此操作不可逆。

state_dict() → OrderedDict

回傳資料收集器的 state_dict。

每個欄位代表一個 worker，包含其自己的 state_dict。

update_policy_weights_(policy_weights: Optional[TensorDictBase] = None) → None

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

參數:

policy_weights (TensorDictBase, optional) – 如果有提供，則為包含要用於更新之 policy 權重的 TensorDict。