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。