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: DEVICE_TYPING | Sequence[DEVICE_TYPING] | None = None, storing_device: DEVICE_TYPING | Sequence[DEVICE_TYPING] | None = None, env_device: DEVICE_TYPING | Sequence[DEVICE_TYPING] | None = None, policy_device: DEVICE_TYPING | Sequence[DEVICE_TYPING] | None = None, create_env_kwargs: Optional[Sequence[dict]] = None, max_frames_per_traj: int | None = None, init_random_frames: int | None = None, reset_at_each_iter: bool = False, postproc: Optional[Callable[[TensorDictBase], TensorDictBase]] = None, split_trajs: Optional[bool] = None, exploration_type: ExplorationType = InteractionType.RANDOM, reset_when_done: bool = True, update_at_each_batch: boolm optional = False, preemptive_threshold: float | None = None, num_threads: int | None = None, num_sub_threads: int | None = 1, cat_results: str | int | None = None, set_truncated: bool = False, use_buffers: bool | None = None, replay_buffer: ReplayBuffer | None = None, replay_buffer_chunk: bool = True, trust_policy: bool | None = None, compile_policy: bool | Dict[str, Any] | None = None, cudagraph_policy: bool | Dict[str, Any] | None = None, no_cuda_sync: bool = False)

在單獨程序中同步執行給定數量的 DataCollector。

環境可以相同或不同。

當查詢 collector 的下一個專案時，收集開始，並且在接收一批軌跡與開始下一次收集之間不計算任何環境步。此類可以安全地用於線上強化學習 (RL) 的 SOTA 實現。

注意

Python 要求多程序程式碼在主程序保護塊內例項化

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

更多資訊請參見 https://docs.python.club.tw/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]) – Callable 列表，每個 Callable 返回一個 EnvBase 例項。

• policy (Callable) –

  要在環境中執行的策略。必須接受 tensordict.tensordict.TensorDictBase 物件作為輸入。如果提供 None (預設)，則使用的策略將是一個 RandomPolicy 例項，並使用環境的 action_spec。接受的策略通常是 TensorDictModuleBase 的子類。這是 collector 的推薦用法。也接受其他可呼叫物件：如果策略不是 TensorDictModuleBase (例如，常規的 Module 例項)，它將首先被包裝在一個 nn.Module 中。然後，collector 將嘗試評估這些模組是否需要包裝在 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) –

  一個僅關鍵字引數，表示 collector 在其生命週期內返回的總幀數。如果 total_frames 不能被 frames_per_batch 整除，則會引發異常。

  可以透過傳遞 total_frames=-1 建立無限期 collector。預設值為 -1 (永不結束的 collector)。

• device (int, str 或 torch.device, optional) – collector 的通用裝置。 device 引數填充任何未指定的裝置：如果 device 不是 None 且 storing_device、policy_device 或 env_device 中的任何一個未指定，則其值將設定為 device。預設值為 None (無預設裝置)。如果希望為每個 worker 指定不同的裝置，支援裝置列表。列表長度必須與 worker 數量相同。

• storing_device (int, str 或 torch.device, optional) – 輸出 TensorDict 將被儲存的裝置。如果傳遞了 device 且 storing_device 是 None，它將預設為 device 指示的值。對於長軌跡，可能需要將資料儲存在與執行策略和環境的裝置不同的裝置上。預設值為 None (輸出 tensordict 不在特定裝置上，葉張量位於它們建立的裝置上)。如果希望為每個 worker 指定不同的裝置，支援裝置列表。列表長度必須與 worker 數量相同。

• env_device (int, str 或 torch.device, optional) – 環境應被 cast 到 (或如果支援該功能則在其上執行) 的裝置。如果未指定且環境有一個非 None 裝置，則 env_device 將預設為該值。如果傳遞了 device 且 env_device=None，它將預設為 device。如果如此指定的 env_device 的值與 policy_device 不同且其中一個不是 None，則資料將在傳遞給環境之前被 cast 到 env_device (即，支援為策略和環境傳遞不同的裝置)。預設值為 None。如果希望為每個 worker 指定不同的裝置，支援裝置列表。列表長度必須與 worker 數量相同。

• policy_device (int, str 或 torch.device, optional) – 策略應被 cast 到的裝置。如果傳遞了 device 且 policy_device=None，它將預設為 device。如果如此指定的 policy_device 的值與 env_device 不同且其中一個不是 None，則資料將在傳遞給策略之前被 cast 到 policy_device (即，支援為策略和環境傳遞不同的裝置)。預設值為 None。如果希望為每個 worker 指定不同的裝置，支援裝置列表。列表長度必須與 worker 數量相同。

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

• 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 之一。

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

• update_at_each_batch (boolm optional) – 如果為 True，則在每次資料收集之前 (同步) 或之後 (非同步) 呼叫 update_policy_weight_()。預設值為 False。

• preemptive_threshold (float, optional) – 一個介於 0.0 和 1.0 之間的值，指定允許在其餘 worker 被強制提前結束之前完成 rollout 收集的 worker 比例。

• num_threads (int, optional) – 此程序的執行緒數。預設為 worker 數。

• num_sub_threads (int, optional) – 子程序的執行緒數。應等於每個子程序中啟動的程序數加一 (如果啟動單個程序則為一)。出於安全考慮，預設值為 1：如果未指定，啟動多個 worker 可能會過度佔用 CPU 負載並損害效能。

• cat_results (str, int 或 None) –

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

  注意

  從 v0.5 版本起，此引數將預設為 "stack"，以更好地與庫的其餘部分互操作。

• set_truncated (bool, optional) – 如果為 True，當達到 rollout 的最後一幀時，truncated 訊號 (以及相應的 "done" 但不是 "terminated") 將被設定為 True。如果沒有找到 "truncated" 鍵，將引發異常。 truncated 鍵可以透過 env.add_truncated_keys 設定。預設值為 False。

• use_buffers (bool, optional) – 如果為 True，將使用 buffer 堆疊資料。這與具有動態 specs 的環境不相容。對於沒有動態 specs 的環境，預設為 True，對於其他環境，預設為 False。

• replay_buffer (ReplayBuffer, optional) – 如果提供，collector 將不 yield tensordict，而是填充 buffer。預設值為 None。

• trust_policy (bool, optional) – 如果為 True，則非 TensorDictModule 策略將被信任並假定與 collector 相容。對於 CudaGraphModules，此引數預設為 True，否則為 False。

• compile_policy (bool 或 Dict[str, Any], optional) – 如果為 True，策略將使用 compile() 的預設行為進行編譯。如果傳遞一個 kwargs 字典，它將用於編譯策略。

• cudagraph_policy (bool 或 Dict[str, Any], optional) – 如果為 True，策略將使用預設 kwargs 被包裝在 CudaGraphModule 中。如果傳遞一個 kwargs 字典，它將用於包裝策略。

• no_cuda_sync (bool) – 如果為 True，將繞過顯式的 CUDA 同步呼叫。對於直接在 CUDA 上執行的環境 (IsaacLab 或 ManiSkills)，CUDA 同步可能會導致意外崩潰。預設值為 False。

load_state_dict(state_dict: OrderedDict) → None

在 worker 上載入 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 – 表示用於環境的種子的整數。

• 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。

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

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

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

引數:

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