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, reset_when_done: bool = True, update_at_each_batch: boolm optional = False, preemptive_threshold: float | None = None, num_threads: int | None = None, num_sub_threads: int | None = 1, cat_results: str | int | None = None, set_truncated: bool = False, use_buffers: bool | None = None, replay_buffer: ReplayBuffer | None = None, replay_buffer_chunk: bool = True, trust_policy: bool | None = None, compile_policy: bool | Dict[str, Any] | None = None, cudagraph_policy: bool | Dict[str, Any] | None = None, no_cuda_sync: bool = False)

在单独进程中同步运行给定数量的 DataCollector。

环境可以相同或不同。

当查询 collector 的下一个项目时，收集开始，并且在接收一批轨迹与开始下一次收集之间不计算任何环境步。此类可以安全地用于在线强化学习 (RL) 的 SOTA 实现。

注意

Python 要求多进程代码在主进程保护块内实例化

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

更多信息请参见 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)

在单独进程中运行给定数量的 DataCollector。

参数:

• create_env_fn (List[Callabled]) – Callable 列表，每个 Callable 返回一个 EnvBase 实例。

• policy (Callable) –

  要在环境中执行的策略。必须接受 tensordict.tensordict.TensorDictBase 对象作为输入。如果提供 None (默认)，则使用的策略将是一个 RandomPolicy 实例，并使用环境的 action_spec。接受的策略通常是 TensorDictModuleBase 的子类。这是 collector 的推荐用法。也接受其他可调用对象：如果策略不是 TensorDictModuleBase (例如，常规的 Module 实例)，它将首先被包装在一个 nn.Module 中。然后，collector 将尝试评估这些模块是否需要包装在 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, optional) –

  一个仅关键字参数，表示 collector 在其生命周期内返回的总帧数。如果 total_frames 不能被 frames_per_batch 整除，则会引发异常。

  可以通过传递 total_frames=-1 创建无限期 collector。默认值为 -1 (永不结束的 collector)。

• device (int, str 或 torch.device, optional) – collector 的通用设备。 device 参数填充任何未指定的设备：如果 device 不是 None 且 storing_device、policy_device 或 env_device 中的任何一个未指定，则其值将设置为 device。默认值为 None (无默认设备)。如果希望为每个 worker 指定不同的设备，支持设备列表。列表长度必须与 worker 数量相同。

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

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

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

• create_env_kwargs (dict, optional) – 一个字典，包含用于创建环境的关键字参数。如果提供列表，则其每个元素将分配给一个子 collector。

• 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 或 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 之一。

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

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

• preemptive_threshold (float, optional) – 一个介于 0.0 和 1.0 之间的值，指定允许在其余 worker 被强制提前结束之前完成 rollout 收集的 worker 比例。

• num_threads (int, optional) – 此进程的线程数。默认为 worker 数。

• num_sub_threads (int, optional) – 子进程的线程数。应等于每个子进程中启动的进程数加一 (如果启动单个进程则为一)。出于安全考虑，默认值为 1：如果未指定，启动多个 worker 可能会过度占用 CPU 负载并损害性能。

• cat_results (str, int 或 None) –

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

  注意

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

• set_truncated (bool, optional) – 如果为 True，当达到 rollout 的最后一帧时，truncated 信号 (以及相应的 "done" 但不是 "terminated") 将被设置为 True。如果没有找到 "truncated" 键，将引发异常。 truncated 键可以通过 env.add_truncated_keys 设置。默认值为 False。

• use_buffers (bool, optional) – 如果为 True，将使用 buffer 堆叠数据。这与具有动态 specs 的环境不兼容。对于没有动态 specs 的环境，默认为 True，对于其他环境，默认为 False。

• replay_buffer (ReplayBuffer, optional) – 如果提供，collector 将不 yield tensordict，而是填充 buffer。默认值为 None。

• trust_policy (bool, optional) – 如果为 True，则非 TensorDictModule 策略将被信任并假定与 collector 兼容。对于 CudaGraphModules，此参数默认为 True，否则为 False。

• compile_policy (bool 或 Dict[str, Any], optional) – 如果为 True，策略将使用 compile() 的默认行为进行编译。如果传递一个 kwargs 字典，它将用于编译策略。

• cudagraph_policy (bool 或 Dict[str, Any], optional) – 如果为 True，策略将使用默认 kwargs 被包装在 CudaGraphModule 中。如果传递一个 kwargs 字典，它将用于包装策略。

• no_cuda_sync (bool) – 如果为 True，将绕过显式的 CUDA 同步调用。对于直接在 CUDA 上运行的环境 (IsaacLab 或 ManiSkills)，CUDA 同步可能会导致意外崩溃。默认值为 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 的 worker。

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

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

参数:

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