MultiaSyncDataCollector

class torchrl.collectors.MultiaSyncDataCollector(*args, **kwargs)

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

环境类型可以是相同的或不同的。

即使在收集批次 rollout 和下次调用迭代器之间的时间，收集也会在所有进程中持续进行。 此类可以安全地用于离线 RL sota 实现。

注意

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

>>> from torchrl.collectors import MultiaSyncDataCollector
>>> 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 MultiaSyncDataCollector
>>> if __name__ == "__main__":
...     env_maker = lambda: GymEnv("Pendulum-v1", device="cpu")
...     policy = TensorDictModule(nn.Linear(3, 1), in_keys=["observation"], out_keys=["action"])
...     collector = MultiaSyncDataCollector(
...         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]) – Callables 列表，每个返回 EnvBase 的实例。

• policy (Callable) –

  要在环境中执行的策略。 必须接受 tensordict.tensordict.TensorDictBase 对象作为输入。 如果提供 None（默认），则使用的策略将是具有环境 action_spec 的 RandomPolicy 实例。 接受的策略通常是 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, optional) –

  一个仅关键字参数，表示收集器在其生命周期内返回的总帧数。 如果 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 指示的值。 对于长轨迹，可能需要在与策略和 env 执行设备不同的设备上存储数据。 默认为 None（输出 tensordict 不在特定设备上，叶张量位于它们创建的设备上）。 如果希望为每个工作进程指示不同的设备，则支持设备列表。 该列表的长度必须与工作进程的数量相同。

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

• policy_device (int, str or torch.device, optional) – 策略应转换到的设备。 如果传递 device 且 policy_device=None，则它将默认为 device。 如果如此指定的 policy_device 值与 env_device 不同，并且其中一个不是 None，则数据将在传递到策略之前转换为 policy_device（即，支持将不同的设备传递给策略和 env）。 默认为 None。 如果希望为每个工作进程指示不同的设备，则支持设备列表。 该列表的长度必须与工作进程的数量相同。

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

• 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 之间的值，用于指定在强制其余工作进程提前结束之前，允许完成 rollout 收集的工作进程的比例。

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

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

• cat_results (str, int or None) –

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

  注意

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

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

• use_buffers (bool, optional) – 如果 True，则将使用缓冲区来堆叠数据。 这与具有动态规范的环境不兼容。 对于没有动态规范的 env，默认为 True；对于其他 env，默认为 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 字典，则将用于包装策略。

load_state_dict(state_dict: OrderedDict) → None

在工作进程上加载 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。