aSyncDataCollector

class torchrl.collectors.aSyncDataCollector(create_env_fn: Callable[[], EnvBase], policy: None | TensorDictModule | Callable[[TensorDictBase], TensorDictBase] = None, *, policy_factory: Callable[[], Callable] | None = None, frames_per_batch: int, total_frames: int | None = - 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: Sequence[dict[str, Any]] | None = None, max_frames_per_traj: int | None = None, init_random_frames: int | None = None, reset_at_each_iter: bool = False, postproc: Callable[[TensorDictBase], TensorDictBase] | None = None, split_trajs: bool | None = None, exploration_type: ExplorationType = InteractionType.RANDOM, reset_when_done: bool = True, update_at_each_batch: bool = False, preemptive_threshold: float | None = None, num_threads: int | None = None, num_sub_threads: int = 1, set_truncated: bool = False, **kwargs)

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

這對於離線 RL 正規化非常有用，在這種正規化中，正在訓練的策略可能與用於收集資料的策略不同。在線上設定中，應優先使用常規的 DataCollector。此類僅是 MultiaSyncDataCollector 的包裝器，其中建立了一個程序。

引數:

• create_env_fn (可呼叫) – 返回 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)。

  注意

  如果策略需要作為策略工廠傳遞（例如，不應直接序列化/醃製），則應改用 :arg:`policy_factory`。

關鍵字引數:

• policy_factory (Callable[[], Callable], optional) –

  一個可呼叫物件，它返回一個策略例項。這與 policy 引數互斥。

  注意

  policy_factory 在策略無法序列化時非常有用。

• 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（無預設裝置）。如果希望為每個工作程序指定不同的裝置，則支援裝置列表。列表的長度必須與工作程序的數量相同。

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

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

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

• 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 (bool, 可選) – 如果為 True，則在每次資料收集之前（同步）或之後（非同步）呼叫 update_policy_weights_()。預設為 False。

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

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

• num_sub_threads (int, optional) – 子程序的執行緒數。應等於每個子程序中啟動的程序數加一（如果只啟動一個程序，則為一）。預設為 1 以確保安全：如果不指定，啟動多個 worker 可能會使 CPU 負載過重並損害效能。

• set_truncated (bool, optional) – 如果為 True，則在達到回滾的最後一幀時，截斷訊號（以及對應的 "done" 但不是 "terminated"）將設定為 True。如果找不到 "truncated" 鍵，則會引發異常。可以透過 env.add_truncated_keys 設定截斷鍵。預設為 False。

async_shutdown(timeout: float | None = None)

當收集器透過 start 方法非同步啟動時，關閉收集器。

引數

timeout (float, optional): 等待收集器關閉的最長時間。 close_env (bool, optional): 如果為 True，收集器將關閉包含的環境。

預設為 True。

另請參閱

start()

init_updater(*args, **kwargs)

使用自定義引數初始化權重更新器。

此方法將引數傳遞給權重更新器的 init 方法。如果未設定權重更新器，則此方法無效。

引數:

• *args – 用於權重更新器初始化的位置引數

• **kwargs – 用於權重更新器初始化的關鍵字引數

load_state_dict(state_dict: OrderedDict) → None

在工作節點上載入 state_dict。

引數:

state_dict (OrderedDict) – 形式為 {"worker0": state_dict0, "worker1": state_dict1} 的 state_dict。

pause()

上下文管理器，如果收集器正在自由執行，則暫停收集器。

reset(reset_idx: Sequence[bool] | None = 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(timeout: float | None = None, close_env: bool = True) → None

關閉所有程序。此操作不可逆。

引數:

• timeout (float, optional) – 關閉工作節點之間管道的超時時間。

• close_env (bool, optional) – 是否關閉環境。預設為 True。

start()

為非同步資料收集啟動收集器。

收集到的資料將儲存在提供的回放緩衝區中。此方法啟動後臺資料收集，允許資料收集和訓練分離。

丟擲:

RuntimeError – 如果在收集器初始化期間未定義回放緩衝區。

示例

>>> import time
>>> from functools import partial
>>>
>>> import tqdm
>>>
>>> from torchrl.collectors import MultiaSyncDataCollector, RandomPolicy
>>> from torchrl.data import LazyTensorStorage, ReplayBuffer
>>> from torchrl.envs import GymEnv, set_gym_backend
>>> import ale_py
>>>
>>> # Set the gym backend to gymnasium
>>> set_gym_backend("gymnasium").set()
>>>
>>> if __name__ == "__main__":
...     # Create a random policy for the Pong environment
...     env_fn = partial(GymEnv, "ALE/Pong-v5")
...     policy = RandomPolicy(env_fn().action_spec)
...
...     # Initialize a shared replay buffer
...     rb = ReplayBuffer(storage=LazyTensorStorage(10000), shared=True)
...
...     # Create a multi-async data collector with 16 environments
...     num_envs = 16
...     collector = MultiaSyncDataCollector(
...         [env_fn] * num_envs,
...         policy=policy,
...         replay_buffer=rb,
...         frames_per_batch=num_envs * 16,
...         total_frames=-1,
...     )
...
...     # Progress bar to track the number of collected frames
...     pbar = tqdm.tqdm(total=100_000)
...
...     # Start the collector asynchronously
...     collector.start()
...
...     # Track the write count of the replay buffer
...     prec_wc = 0
...     while True:
...         wc = rb.write_count
...         c = wc - prec_wc
...         prec_wc = wc
...
...         # Update the progress bar
...         pbar.update(c)
...         pbar.set_description(f"Write Count: {rb.write_count}")
...
...         # Check the write count every 0.5 seconds
...         time.sleep(0.5)
...
...         # Stop when the desired number of frames is reached
...         if rb.write_count . 100_000:
...             break
...
...     # Shut down the collector
...     collector.async_shutdown()

state_dict() → OrderedDict

返回資料收集器的 state_dict。

每個欄位代表一個工作節點，其中包含其自身的 state_dict。

update_policy_weights_(policy_or_weights: TensorDictBase | TensorDictModuleBase | dict | None = None, *, worker_ids: int | list[int] | torch.device | list[torch.device] | None = None, **kwargs) → None

更新資料收集器的策略權重，支援本地和遠端執行上下文。

此方法確保資料收集器使用的策略權重與最新的訓練權重同步。它支援本地和遠端權重更新，具體取決於資料收集器的配置。本地（下載）更新在遠端（上傳）更新之前執行，以便可以將權重從伺服器傳輸到子工作器。

引數:

• policy_or_weights (TensorDictBase | TensorDictModuleBase | dict | None) – 要更新的權重。可以是： - TensorDictModuleBase：將提取其權重的策略模組 - TensorDictBase：包含權重的 TensorDict - dict：包含權重的常規 dict - None：將嘗試使用 _get_server_weights() 從伺服器獲取權重

• worker_ids (int | List[int] | torch.device | List[torch.device] | None, optional) – 需要更新的工作器的識別符號。當收集器關聯多個工作器時，此項很重要。

丟擲:

TypeError – 如果提供了 worker_ids 但未配置 weight_updater。

注意

使用者應擴充套件 WeightUpdaterBase 類來定製特定用例的權重更新邏輯。不應覆蓋此方法。

另請參閱

LocalWeightsUpdaterBase 和 RemoteWeightsUpdaterBase()。