MultiaSyncDataCollector

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

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

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

即使在收集批量 rollout 和下次呼叫迭代器之間的時間內，所有行程上的收集都會持續進行。 這個類別可以安全地與離線 RL sota 實作一起使用。

注意

Python 需要在 main guard 中實例化多重處理程式碼

>>> from torchrl.collectors import MultiaSyncDataCollector
>>> 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 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[Callabled]) – Callables 的列表，每個都回傳 EnvBase 的實例。

• policy (Callable) –

  要在環境中執行的策略。 必須接受 tensordict.tensordict.TensorDictBase 物件作為輸入。 如果提供 None（預設），則使用的策略將會是具有環境 action_spec 的 RandomPolicy 實例。 接受的策略通常是 TensorDictModuleBase 的子類別。 這是收集器的建議用法。 也接受其他 callables：如果策略不是 TensorDictModuleBase（例如，普通的 Module 實例），它將首先被包裝在 nn.Module 中。 接著，收集器將嘗試評估這些模組是否需要包裝在 TensorDictModule 中。 - 如果策略正向簽章符合 forward(self, tensordict) 中的任何一個，

  forward(self, td) 或 forward(self, <anything>: TensorDictBase)（或任何以 TensorDictBase 的子類別作為類型化的單一引數的 typing），則策略將不會包裝在 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, optional) – 收集器的通用裝置。 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 不在特定的裝置上，leaf tensors 位於它們被建立的裝置上)。如果想要為每個 worker 指示不同的裝置，則支援裝置列表。列表的長度必須與 worker 的數量相同。

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

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

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

• 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 之間的值，指定在強制提早結束之前，允許完成其 rollout 的 worker 比例。

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

• num_sub_threads (int, optional) – 子程序的執行緒數量。 應等於在每個子程序中啟動的程序數量加上一 (如果啟動單個程序則為一)。為安全起見，預設為 1：如果沒有指定，啟動多個 worker 可能會使 CPU 負載過高並損害效能。

• cat_results (str, int 或 None) –

  (僅適用於 MultiSyncDataCollector)。如果為 "stack"，從 worker 收集的資料將沿著第一個維度堆疊。 這是較佳的行為，因為它與函式庫的其餘部分最相容。如果為 0，結果將沿著輸出的第一個維度串聯，如果環境是批次處理的，則可以是批次維度，如果不是，則可以是時間維度。 cat_results 值為 -1 將始終沿著時間維度串聯結果。 應優先選擇此選項，而不是預設值。 也接受中間值。 預設為 "stack"。

  注意

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

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

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

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

• trust_policy (bool, optional) – 如果 True，則會信任非 TensorDictModule 策略，並假定其與收集器相容。 對於 CudaGraphModules，預設為 True，否則為 False。

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

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

load_state_dict(state_dict: OrderedDict) → None

將 state_dict 載入到 worker 上。

參數:

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 中的環境的種子 (seeds)。

參數:

• 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_weights (TensorDictBase, optional) – 如果提供，則為包含要用於更新的策略權重的 TensorDict。