aSyncDataCollector

類 torchrl.collectors.aSyncDataCollector(create_env_fn: Callable[[], EnvBase], policy: Optional[Union[TensorDictModule, Callable[[TensorDictBase], TensorDictBase]]], *, 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, num_threads: int = None, num_sub_threads: int = 1, set_truncated: bool = False, **kwargs)

在單獨的程序中執行單個 `DataCollector`。

這主要適用於離線強化學習正規化，其中訓練的策略可能與用於收集資料的策略不同。在線上設定中，應優先使用常規的 `DataCollector`。這個類只是 `MultiaSyncDataCollector` 的一個包裝器，其中只建立一個單獨的程序。

引數:

• create_env_fn (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, 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 不在特定裝置上，葉張量位於建立它們的裝置上）。如果希望為每個 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 | None, optional) – 每條軌跡的最大步數。請注意，一條軌跡可以跨越多個批次（除非將 reset_at_each_iter 設定為 True，詳見下文）。一旦一條軌跡達到 n_steps，環境就會重置。如果環境包裝了多個環境，則會為每個環境獨立跟蹤步數。允許負值，此時該引數將被忽略。預設為 None（即沒有最大步數）。

• init_random_frames (int | None, 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 負載過高並影響效能。

• set_truncated (bool, optional) – 如果為 True，則當達到 rollout 的最後一幀時，截斷訊號（以及相應的 "done" 但不是 "terminated"）將被設定為 True。如果找不到 "truncated" 鍵，則會引發異常。截斷鍵可以透過 env.add_truncated_keys 設定。預設為 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`。

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

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

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

引數:

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