aSyncDataCollector

class 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: 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, set_truncated: bool = False, **kwargs)

在個別程序上執行單一 DataCollector。

這對於訓練中的策略可能與用於收集資料的策略不同的離線 RL 範例特別有用。在線上設定中，應該優先使用常規 DataCollector。此類別僅僅是 MultiaSyncDataCollector 的封裝，其中僅建立單一程序。

參數:

• create_env_fn (Callabled) – 可呼叫物件，傳回 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, 可選) – 收集器的通用裝置。 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 指示的值。 對於長軌跡，可能需要將資料儲存在與執行 policy 和 env 不同的裝置上。 預設為 None (輸出 tensordict 不在特定裝置上，leaf tensors 位於其建立的裝置上)。 若希望為每個 worker 指示不同的裝置，則支援裝置列表。 列表長度必須與 worker 數量相同。

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

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

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

• max_frames_per_traj (int, 可選) – 每個軌跡的最大步數。 請注意，軌跡可以跨越多個批次 (除非 reset_at_each_iter 設定為 True，請參閱下文)。 一旦軌跡達到 n_steps，環境就會重置。 如果環境將多個環境包裝在一起，則會獨立追蹤每個環境的步數。 允許負值，在這種情況下，將忽略此引數。 預設為 None (即，沒有最大步數)。

• init_random_frames (int, 可選) – 在呼叫 policy 之前忽略 policy 的幀數。 此功能主要用於離線/基於模型的設定，其中可以使用一批隨機軌跡來初始化訓練。 如果提供，它將四捨五入為 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 optional) – 如果 True，update_policy_weight_() 將在每次資料收集之前 (同步) 或之後 (非同步) 被呼叫。 預設為 False。

• preemptive_threshold (float, optional) – 一個介於 0.0 和 1.0 之間的值，用於指定有多少比例的 workers 可以完成它們的 rollout 收集，之後剩餘的 workers 會被強制提早結束。

• 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

在 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 – 代表用於環境的種子的整數。

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