MultiaSyncDataCollector

類 torchrl.collectors.MultiaSyncDataCollector(*args, **kwargs)

在單獨的程序上非同步執行給定數量的 DataCollectors。

環境型別可以相同或不同。

即使在收集到批次 rollout 與下一次呼叫迭代器之間，所有程序上的收集也會持續進行。該類可以安全地用於離線 RL 的 sota 實現。

注意

Python 要求在主守護中例項化多程序程式碼

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

有關更多資訊，請參見 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 MultiaSyncDataCollector
>>> if __name__ == "__main__":
...     env_maker = lambda: GymEnv("Pendulum-v1", device="cpu")
...     policy = TensorDictModule(nn.Linear(3, 1), in_keys=["observation"], out_keys=["action"])
...     collector = MultiaSyncDataCollector(
...         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)

在單獨的程序上執行給定數量的 DataCollectors。

引數：:

• create_env_fn (List[可呼叫物件]) – 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, 可選) –

  一個僅限關鍵字的引數，表示收集器在其生命週期內返回的總幀數。如果 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（無預設裝置）。如果希望為每個 worker 指定不同的裝置，支援提供裝置列表。該列表的長度必須與 worker 數量相同。

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

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

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

• 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，例如 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 optional) – 如果為 True，則每次資料收集之前（同步）或之後（非同步）都會呼叫 update_policy_weight_()。預設為 False。

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

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

• num_sub_threads (int, 可選) – 子程序的執行緒數。應等於每個子程序內啟動的程序數加一（如果只啟動一個程序，則為一）。出於安全考慮，預設為 1：如果未指定，啟動多個 worker 可能會使 CPU 負載過高並損害效能。

• cat_results (str, int 或 None) –

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

  注意

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

• set_truncated (bool, 可選) – 如果為 True，當達到 rollout 的最後一幀時，截斷訊號（以及相應的“done”，但不是“terminated”）將被設定為 True。如果未找到“truncated”鍵，則會引發異常。可以透過 env.add_truncated_keys 設定截斷鍵。預設為 False。

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

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

• trust_policy (bool, 可選) – 如果為 True，則將信任非 TensorDictModule 策略，認為其與收集器相容。對於 CudaGraphModules，此值預設為 True；否則為 False。

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

• cudagraph_policy (bool 或 Dict[str, Any], 可選) – 如果為 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, 可選) – 如果為 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_weights (TensorDictBase, 可選) – 如果提供，則為包含用於更新策略權重的 TensorDict。