SyncDataCollector

class torchrl.collectors.SyncDataCollector(create_env_fn: Union[EnvBase, 'EnvCreator', Sequence[Callable[[], EnvBase]]], policy: Optional[Union[TensorDictModule, Callable[[TensorDictBase], TensorDictBase]]] = None, *, frames_per_batch: int, total_frames: int = - 1, device: DEVICE_TYPING = None, storing_device: DEVICE_TYPING = None, policy_device: DEVICE_TYPING = None, env_device: DEVICE_TYPING = None, create_env_kwargs: dict | 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, trust_policy: bool = None, compile_policy: bool | Dict[str, Any] | None = None, cudagraph_policy: bool | Dict[str, Any] |None = None, no_cuda_sync: bool = False, **kwargs)

用於強化學習問題的通用資料收集器。需要一個環境建構函式和一個策略。

引數:

• create_env_fn (Callable) – 一個可呼叫物件，返回 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)。

關鍵字引數:

• 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，例如 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。

• return_same_td (bool, optional) – 如果為 True，則每次迭代都會返回相同的 TensorDict，其值將被更新。應謹慎使用此功能：例如，如果將相同的 tensordict 新增到重放緩衝區，則緩衝區的整個內容將完全相同。預設為 False。

• interruptor (_Interruptor, optional) – 一個 _Interruptor 物件，可用於從類外部控制 rollout 收集。_Interruptor 類具有方法 ´start_collection´ 和 ´stop_collection´，可用於實現例如搶佔式停止 rollout 收集等策略。預設為 False。

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

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

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

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

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

• cudagraph_policy (bool or Dict[str, Any], optional) – 如果為 True，策略將使用預設 kwargs 包裝在 CudaGraphModule 中。如果傳入 kwargs 字典，將使用它來包裝策略。

• no_cuda_sync (bool) – 如果為 True，將繞過顯式的 CUDA 同步呼叫。對於直接在 CUDA 上執行的環境（IsaacLab 或 ManiSkills），CUDA 同步可能導致意外崩潰。預設為 False。

示例

>>> 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"

iterator() → Iterator[TensorDictBase]

遍歷 DataCollector。

Yields: TensorDictBase 物件，包含（分塊的）軌跡

load_state_dict(state_dict: OrderedDict, **kwargs) → None

在環境和策略上載入 state_dict。

引數:

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

reset(index=None, **kwargs) → None

將環境重置到新的初始狀態。

rollout() → TensorDictBase

使用提供的策略在環境中執行一次 rollout。

Returns:

包含計算得到的 rollout 的 TensorDictBase。

set_seed(seed: int, static_seed: bool = False) → int

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

引數:

• seed (int) – 用於環境的種子整數。

• static_seed (bool, optional) – 如果為 True，種子不會遞增。預設為 False

Returns:

輸出種子。當 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() → None

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

state_dict() → OrderedDict

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

Returns:

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

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

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

引數:

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