SyncDataCollector¶

class torchrl.collectors.SyncDataCollector(create_env_fn: EnvBase | EnvCreator | Sequence[Callable[[], EnvBase]], policy: None | TensorDictModule | Callable[[TensorDictBase], TensorDictBase] = None, *, policy_factory: Callable[[], Callable] | None = None, frames_per_batch: int, total_frames: int = - 1, device: DEVICE_TYPING | None = None, storing_device: DEVICE_TYPING | None = None, policy_device: DEVICE_TYPING | None = None, env_device: DEVICE_TYPING | None = None, create_env_kwargs: 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, return_same_td: bool = False, reset_when_done: bool = True, interruptor=None, set_truncated: bool = False, use_buffers: bool | None = None, replay_buffer: ReplayBuffer | None = None, extend_buffer: bool = False, trust_policy: bool | None = None, compile_policy: bool | dict[str, Any] | None = None, cudagraph_policy: bool | dict[str, Any] | None = None, no_cuda_sync: bool = False, weight_updater: WeightUpdaterBase | Callable[[], WeightUpdaterBase] | None = None, **kwargs)[source]¶

RL 問題通用資料收集器。需要環境建構函式和策略。

引數:

create_env_fn (Callable or EnvBase) – 返回 EnvBase 類例項的可呼叫物件，或環境本身。
policy (Callable) –
要在環境中執行的策略。必須接受 tensordict.tensordict.TensorDictBase 物件作為輸入。如果提供了 None，則使用的策略將是 RandomPolicy 例項，並使用環境的 action_spec。可接受的策略通常是 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) –
一個關鍵字引數，表示收集器在其生命週期內返回的總幀數。如果 total_frames 不能被 frames_per_batch 整除，則會引發異常。

可以透過傳遞 total_frames=-1 來建立無限收集器。預設為 -1（無限收集器）。
device (int, str or torch.device, optional) – 收集器的通用裝置。 device 引數填充任何未指定的裝置：如果 device 不為 None 且 storing_device、policy_device 或 env_device 中的任何一個未指定，其值將設定為 device。預設為 None（無預設裝置）。
storing_device (int, str or torch.device, optional) – 輸出 TensorDict 將儲存在其上的裝置。如果傳遞了 device 且 storing_device 為 None，則預設為 device 指定的值。對於長軌跡，可能需要在與策略和環境執行裝置不同的裝置上儲存資料。預設為 None（輸出 tensordict 不在特定裝置上，葉子張量位於建立它們的位置）。
env_device (int, str or torch.device, optional) – 環境應被轉換為（或執行，如果支援此功能）的裝置。如果未指定且環境具有非 None 裝置，則 env_device 將預設為該值。如果傳遞了 device 且 env_device=None，則預設為 device。如果如此指定的 env_device 值與 policy_device 不同，並且其中一個不是 None，則在將資料傳遞給環境之前，資料將被轉換為 env_device（即，支援將不同的裝置傳遞給策略和環境）。預設為 None。
policy_device (int, str or torch.device, optional) – 策略應被轉換為的裝置。如果傳遞了 device 且 policy_device=None，則預設為 device。如果如此指定的 policy_device 值與 env_device 不同，並且其中一個不是 None，則在將資料傳遞給策略之前，資料將被轉換為 policy_device（即，支援將不同的裝置傳遞給策略和環境）。預設為 None。
create_env_kwargs (dict, optional) – create_env_fn 的 kwargs 字典。
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 例項。

警告

當使用回放緩衝區且在生成專案時將專案新增到緩衝區時（extend_buffer=False），不應用 postproc。推薦的用法是使用 extend_buffer=True。

預設為 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 之一。
return_same_td (bool, optional) – 如果為 True，將在每次迭代時返回相同的 TensorDict，並更新其值。此功能應謹慎使用：例如，如果相同的 tensordict 被新增到回放緩衝區，則緩衝區的全部內容將相同。預設為 False。
interruptor (_Interruptor, optional) – 一個 _Interruptor 物件，可用於類外部以控制回滾收集。_Interruptor 類具有 ´start_collection´ 和 ´stop_collection´ 方法，允許實現諸如預先停止回滾收集之類的策略。預設為 False。
set_truncated (bool, optional) – 如果為 True，則在達到回滾的最後一幀時，截斷訊號（以及對應的 "done" 但不是 "terminated"）將設定為 True。如果找不到 "truncated" 鍵，則會引發異常。可以透過 env.add_truncated_keys 設定截斷鍵。預設為 False。
use_buffers (bool, optional) – 如果為 True，則將使用緩衝區來堆疊資料。這與具有動態規範的環境不相容。對於沒有動態規範的環境，預設為 True，對於其他環境，預設為 False。
replay_buffer (ReplayBuffer, optional) –
如果提供，收集器將不產生 tensordicts，而是填充緩衝區。預設為 None。

另請參閱

預設情況下，緩衝區在收集（批次）幀時被填充。如果需要用整個回滾來擴充套件緩衝區，請將 extend_buffer 設定為 True。

警告

使用帶有 postproc 或 split_trajs=True 的回放緩衝區是禁止的，除非 extend_buffer=True，因為需要觀察整個批次才能應用這些轉換。
extend_buffer (bool, optional) – 如果為 True，則回放緩衝區將用整個回滾而不是單步來擴充套件。預設為 False。
trust_policy (bool, optional) – 如果為 True，則將信任非 TensorDictModule 策略，並假定其與收集器相容。對於 CudaGraphModules，這預設為 True，否則為 False。
compile_policy (bool or Dict[str, Any], optional) – 如果為 True，則策略將使用 compile() 的預設行為進行編譯。如果傳遞了關鍵字引數字典，則將用於編譯策略。
cudagraph_policy (bool or Dict[str, Any], optional) – 如果為 True，則策略將用預設關鍵字引數包裝在 CudaGraphModule 中。如果傳遞了關鍵字引數字典，則將用於包裝策略。
no_cuda_sync (bool) – 如果為 True，將繞過顯式的 CUDA 同步呼叫。對於直接在 CUDA 上執行的環境（IsaacLab 或 ManiSkills），CUDA 同步可能導致意外崩潰。預設為 False。
weight_updater (WeightUpdaterBase or constructor, optional) – WeightUpdaterBase 或其子類的例項，負責在遠端推理工作器上更新策略權重。這通常不用於 SyncDataCollector，因為它在單程序環境中執行。如果需要序列化更新器，請考慮使用建構函式。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> from tensordict.nn import TensorDictModule
>>> from torch import nn
>>> env_maker = lambda: GymEnv("Pendulum-v1", device="cpu")
>>> policy = TensorDictModule(nn.Linear(3, 1), in_keys=["observation"], out_keys=["action"])
>>> collector = SyncDataCollector(
...     create_env_fn=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",
... )
>>> for i, data in enumerate(collector):
...     if i == 2:
...         print(data)
...         break
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)
>>> del collector

收集器提供的資料批次將帶有 "time" 維度標記。

示例

>>> assert data.names[-1] == "time"

async_shutdown(timeout: float | None = None, close_env: bool = True) → None[source]¶: 結束 ray.init() 在非同步執行期間啟動的程序。

init_updater(*args, **kwargs)¶

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

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

引數:

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

iterator() → Iterator[TensorDictBase][source]¶

迭代 DataCollector。

Yields: 包含軌跡 (塊) 的 TensorDictBase 物件

load_state_dict(state_dict: OrderedDict, **kwargs) → None[source]¶

在環境和策略上載入 state_dict。

引數:: state_dict (OrderedDict) – 包含 “policy_state_dict” 和 "env_state_dict" 欄位的有序字典。

pause()[source]¶: 上下文管理器，如果收集器正在自由執行，則暫停收集器。

reset(index=None, **kwargs) → None[source]¶: 將環境重置到新的初始狀態。

rollout() → TensorDictBase[source]¶

使用提供的策略在環境中計算回滾。

返回:: 包含計算出的回滾的 TensorDictBase。

set_seed(seed: int, static_seed: bool = False) → int[source]¶

設定 DataCollector 中儲存的環境的種子。

引數:

seed (int) – 用於環境的種子整數。
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 = ParallelEnv(6, env_fn)
>>> policy = TensorDictModule(nn.Linear(3, 1), in_keys=["observation"], out_keys=["action"])
>>> collector = SyncDataCollector(env_fn_parallel, policy, total_frames=300, frames_per_batch=100)
>>> out_seed = collector.set_seed(1)  # out_seed = 6

shutdown(timeout: float | None = None, close_env: bool = True) → None[source]¶

關閉所有工作器和/或關閉本地環境。

引數:

timeout (float, optional) – 關閉工作器之間管道的超時時間。對此類無影響。
close_env (bool, optional) – 是否關閉環境。預設為 True。

start()[source]¶

在單獨的執行緒中啟動收集器以進行非同步資料收集。

收集到的資料儲存在提供的回放緩衝區中。當您希望將資料收集與訓練分離時，此方法很有用，允許您的訓練迴圈獨立於資料收集過程執行。

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

示例

>>> import time
>>> from functools import partial
>>>
>>> import tqdm
>>>
>>> from torchrl.collectors import SyncDataCollector, 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 = GymEnv("ALE/Pong-v5")
...     policy = RandomPolicy(env.action_spec)
...
...     # Initialize a shared replay buffer
...     rb = ReplayBuffer(storage=LazyTensorStorage(1000), shared=True)
...
...     # Create a synchronous data collector
...     collector = SyncDataCollector(
...         env,
...         policy=policy,
...         replay_buffer=rb,
...         frames_per_batch=256,
...         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[source]¶

返回資料收集器的本地 state_dict（環境和策略）。

返回:: 包含 "policy_state_dict" 和 “env_state_dict” 欄位的有序字典。

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

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

引數:

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()。

SyncDataCollector¶

文件

教程

資源