MultiSyncDataCollector

class torchrl.collectors.MultiSyncDataCollector(create_env_fn: Sequence[Callable[[], EnvBase]], policy: Optional[Union[TensorDictModule, Callable[[TensorDictBase], TensorDictBase]]] = None, *, frames_per_batch: int, total_frames: Optional[int] = - 1, device: DEVICE_TYPING | Sequence[DEVICE_TYPING] | None = None, storing_device: DEVICE_TYPING | Sequence[DEVICE_TYPING] | None = None, env_device: DEVICE_TYPING | Sequence[DEVICE_TYPING] | None = None, policy_device: DEVICE_TYPING | Sequence[DEVICE_TYPING] | None = None, create_env_kwargs: Optional[Sequence[dict]] = None, max_frames_per_traj: int | None = None, init_random_frames: int | None = None, reset_at_each_iter: bool = False, postproc: Optional[Callable[[TensorDictBase], TensorDictBase]] = None, split_trajs: Optional[bool] = None, exploration_type: ExplorationType = InteractionType.RANDOM, exploration_mode=None, reset_when_done: bool = True, update_at_each_batch: bool = False, preemptive_threshold: float = None, num_threads: int = None, num_sub_threads: int = 1, cat_results: str | int | None = None, set_truncated: bool = False, use_buffers: bool | None = None)

在单独的进程上同步运行给定数量的 DataCollectors。

环境可以相同或不同。

收集在查询收集器的下一个项目时开始，并且在接收一批轨迹和开始下一个收集之间不会计算任何环境步骤。此类可以安全地与在线 RL sota 实现一起使用。

注意

Python 要求多进程代码在主守护进程中实例化

>>> from torchrl.collectors import MultiSyncDataCollector
>>> if __name__ == "__main__":
...     # Create your collector here

有关更多信息，请参见 https://docs.pythonlang.cn/3/library/multiprocessing.html。

例子

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

在单独的进程上运行给定数量的 DataCollectors。

参数:

• create_env_fn (List[Callabled]) – 可调用对象的列表，每个可调用对象都返回一个 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, optional) –

  代表收集器在其生命周期内返回的帧总数的关键字参数。如果 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（无默认设备）。如果希望为每个 worker 指定不同的设备，则支持设备列表。列表长度必须与 worker 数量相同。

• storing_device (int, str 或 torch.device, 可选) – 将输出 TensorDict 存储到的设备。如果传递了 device 且 storing_device 为 None，则将默认为 device 所指示的值。对于长轨迹，可能需要将数据存储到与策略和环境执行所在的设备不同的设备上。默认值为 None（输出 tensordict 不在特定设备上，叶张量位于创建它们的设备上）。如果希望为每个 worker 指定不同的设备，则支持设备列表。列表长度必须与 worker 数量相同。

• env_device (int, str 或 torch.device, 可选) – 应该将环境转换为（或执行，如果支持该功能）的设备。如果未指定且环境具有非 None 设备，则 env_device 将默认为该值。如果传递了 device 且 env_device=None，则将默认为 device。如果 env_device 的值与 policy_device 不同，并且其中一个不是 None，则在将数据传递给环境之前会将其转换为 env_device（即，支持将不同的设备传递给策略和环境）。默认值为 None。如果希望为每个 worker 指定不同的设备，则支持设备列表。列表长度必须与 worker 数量相同。

• policy_device (int, str 或 torch.device, 可选) – 应该将策略转换为的设备。如果传递了 device 且 policy_device=None，则将默认为 device。如果 policy_device 的值与 env_device 不同，并且其中一个不是 None，则在将数据传递给策略之前会将其转换为 policy_device（即，支持将不同的设备传递给策略和环境）。默认值为 None。如果希望为每个 worker 指定不同的设备，则支持设备列表。列表长度必须与 worker 数量相同。

• create_env_kwargs (dict, 可选) – 用于创建环境的关键字参数字典。如果提供列表，则其每个元素将分配给子收集器。

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

• reset_when_done (bool, 可选) – 如果为 True（默认），则返回其 "done" 或 "truncated" 条目中的 True 值的环境将在相应的索引处重置。

• update_at_each_batch (boolm 可选) – 如果为 True，则在每个数据收集之前（同步）或之后（异步）调用 update_policy_weight_()。默认值为 False。

• preemptive_threshold (float, 可选) – 一个介于 0.0 和 1.0 之间的值，指定允许完成其回滚收集的 worker 比例，然后再强制其他 worker 提前结束。

• num_threads (int, 可选) – 此进程的线程数。默认值为 worker 数量。

• num_sub_threads (int, 可选) – 子进程的线程数。应等于每个子进程中启动的进程数加一（或如果启动单个进程，则为一）。默认值为 1 以确保安全：如果未指定，则启动多个 worker 可能导致 CPU 负载过高并影响性能。

• cat_results (str, int 或 None) –

  (MultiSyncDataCollector 独占）。如果为 "stack"，则将从 worker 收集的数据沿着第一个维度堆叠起来。这是首选行为，因为它与库的其余部分最兼容。如果为 0，则将沿着输出的第一个维度连接结果，如果环境是批处理的，则该维度可以是批处理维度，如果未批处理，则可以是时间维度。 cat_results 值为 -1 将始终沿着时间维度连接结果。这应优先于默认值。也接受中间值。默认值为 0。

  注意

  从 v0.5 开始，此参数将默认为 "stack"，以便更好地与库的其余部分互操作。

• set_truncated (bool, 可选) – 如果为 True，则在达到回滚的最后一帧时，将截断信号（以及相应的 "done" 但不是 "terminated"）设置为 True。如果未找到 "truncated" 键，则会引发异常。截断键可以通过 env.add_truncated_keys 设置。默认值为 False。

• use_buffers (bool, 可选) – 如果为 True，则将使用缓冲区来堆叠数据。这与具有动态规范的环境不兼容。对于没有动态规范的环境，默认值为 True，对于其他环境，默认值为 False。

load_state_dict(state_dict: OrderedDict) → None

在 worker 上加载 state_dict。

参数:

state_dict (OrderedDict) – 形式为 {"worker0": state_dict0, "worker1": state_dict1} 的 state_dict。

reset(reset_idx: Optional[Sequence[bool]] = None) → None

将环境重置为新的初始状态。

参数:

reset_idx – 可选。序列，指示需要重置哪些环境。如果为 None，则重置所有环境。

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

设置 DataCollector 中存储的环境的种子。

参数:

• seed – 用于环境的整数种子。

• 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 = lambda: ParallelEnv(6, env_fn)
>>> policy = TensorDictModule(nn.Linear(3, 1), in_keys=["observation"], out_keys=["action"])
>>> collector = SyncDataCollector(env_fn_parallel, policy, frames_per_batch=100, total_frames=300)
>>> out_seed = collector.set_seed(1)  # out_seed = 6

shutdown()

关闭所有进程。此操作不可逆。

state_dict() → OrderedDict

返回数据收集器的 state_dict。

每个字段代表一个工作程序，包含其自己的 state_dict。

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

如果数据收集器的策略和训练后的策略位于不同的设备上，则更新策略权重。

参数:

policy_weights (TensorDictBase, optional) – 如果提供，则为 TensorDict，其中包含用于更新的策略的权重。