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, exploration_mode: str | None = None, return_same_td: bool = False, reset_when_done: bool = True, interruptor=None, set_truncated: bool = False, use_buffers: bool | None = None)

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, 可选) – 收集器的通用设备。 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, 可选) – 应该将环境转换为的设备（如果支持该功能，则执行）。如果未指定且 env 具有非 None 设备，则 env_device 将默认为该值。如果传递了 device 并且 env_device=None，则它将默认为 device。如果 env_device 的这样指定的值与 policy_device 不同，并且其中一个不是 None，则数据将在传递给 env 之前转换为 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。

示例

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

迭代数据收集器。

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

设置数据收集器中存储的环境的种子。

参数:

• seed (int) – 表示要用于环境的种子的整数。

• static_seed (bool, optional) – 如果True，则种子不会递增。默认为 False

Returns:

输出种子。当数据收集器中包含多个环境时，这很有用，因为每个环境的种子都会递增。生成的种子是最后一个环境的种子。

示例

>>> 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，其中包含用于更新的策略的权重。