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: Optional[Union[device, str, int]] = None, storing_device: Optional[Union[device, str, int]] = None, policy_device: Optional[Union[device, str, int]] = None, env_device: Optional[Union[device, str, int]] = None, create_env_kwargs: Optional[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, return_same_td: bool = False, reset_when_done: bool = True, interruptor=None, set_truncated: bool = False, use_buffers: Optional[bool] = None, replay_buffer: Optional[ReplayBuffer] = None, trust_policy: Optional[bool] = None, compile_policy: Optional[Union[bool, Dict[str, Any]]] = None, cudagraph_policy: Optional[Union[bool, Dict[str, Any]]] = None, **kwargs)

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

參數:

• create_env_fn (Callable) – 一個可呼叫的物件，它會傳回 EnvBase 類別的執行個體。

• policy (Callable) –

  要在環境中執行的策略。必須接受 tensordict.tensordict.TensorDictBase 物件作為輸入。如果提供 None，則使用的策略將是具有環境 action_spec 的 RandomPolicy 執行個體。接受的策略通常是 TensorDictModuleBase 的子類別。這是收集器的建議用法。也接受其他可呼叫物件：如果策略不是 TensorDictModuleBase（例如，常規的 Module 執行個體），它將首先被包裝在 nn.Module 中。然後，收集器將嘗試評估這些模組是否需要包裝在 TensorDictModule 中。 - 如果策略正向簽章符合 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 或 torch.device, optional) – 收集器的通用裝置。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 不在特定裝置上，leaf tensors 位於它們被建立的裝置上）。

• 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, 選用) – create_env_fn 的 kwargs 字典。

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

• init_random_frames (int, 選用) – 在呼叫策略之前，忽略策略的幀數。此功能主要用於離線/基於模型的設定，其中可以使用一批隨機軌跡來初始化訓練。如果提供，它將四捨五入到最接近的 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 其中之一。

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

• interruptor (_Interruptor, 選用) – 一個 _Interruptor 物件，可以從類別外部使用它來控制 rollout 收集。_Interruptor 類別具有 ´start_collection´ 和 ´stop_collection´ 方法，允許實作諸如搶先停止 rollout 收集之類的策略。預設值為 False。

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

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

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

• trust_policy (bool, 選用) – 如果 True，將信任非 TensorDictModule 策略，假定其與收集器相容。對於 CudaGraphModules，預設值為 True，否則為 False。

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

• cudagraph_policy (bool 或 Dict[str, Any], optional) – 如果為 True，則 policy 將使用預設 kwargs 包裝在 CudaGraphModule 中。如果傳入 kwargs 的字典，它將用於包裝 policy。

範例

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

產生：包含（軌跡區塊）的 TensorDictBase 物件

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

在環境和 policy 上載入 state_dict。

參數:

state_dict (OrderedDict) – 包含欄位 “policy_state_dict” 和 "env_state_dict" 的已排序字典。

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

將環境重設為新的初始狀態。

rollout() → TensorDictBase

使用提供的 policy 在環境中計算 rollout。

傳回:

包含計算的 rollout 的 TensorDictBase。

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

設定儲存在 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() → None

關閉所有 worker 和/或關閉本地環境。

state_dict() → OrderedDict

傳回資料收集器（環境和 policy）的本地 state_dict。

傳回:

具有欄位 "policy_state_dict" 和 “env_state_dict” 的已排序字典。

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

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

參數:

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