aSyncDataCollector

class torchrl.collectors.aSyncDataCollector(create_env_fn: Callable[[], EnvBase], policy: Optional[Union[TensorDictModule, Callable[[TensorDictBase], TensorDictBase]]], *, 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, set_truncated: bool = False, **kwargs)

在单独的进程中运行单个 DataCollector。

这对于离线 RL 范式最有用，其中训练的策略可能与用于收集数据的策略不同。在在线设置中，应优先使用常规的 DataCollector。此类只是 MultiaSyncDataCollector 的包装器，其中正在创建单个进程。

参数:

• create_env_fn (Callabled) – 返回 EnvBase 实例的可调用对象

• policy (Callable) –

  要在环境中执行的策略。必须接受 tensordict.tensordict.TensorDictBase 对象作为输入。如果提供 None，则使用的策略将是 RandomPolicy 实例，其环境为 action_spec。可接受的策略通常是 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 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（输出张量字典不在特定设备上，叶子张量位于它们创建的设备上）。如果希望为每个工作器指定不同的设备，则支持设备列表。该列表的长度必须与工作器的数量相同。

• 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) – 用于创建环境的关键字参数的字典。如果提供列表，则其每个元素将被分配给子收集器。

• 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 之间的值，指定允许完成收集其 rollouts 的工作器数量与剩余工作器被迫提前结束的工作器数量之比。

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

• num_sub_threads (int, 可选) – 子进程的线程数。应等于每个子进程中启动的进程数加一（如果只启动一个进程，则为一）。默认值为 1，以确保安全：如果未指定，则启动多个工作进程可能会过度占用 CPU 资源并影响性能。

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

load_state_dict(state_dict: OrderedDict) → None

在工作进程上加载 state_dict。

参数:

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

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, 可选) – 如果为 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, 可选) – 如果提供，则为一个包含用于更新的策略权重的 TensorDict。