aSyncDataCollector

class torchrl.collectors.aSyncDataCollector(create_env_fn: Callable[[], EnvBase], policy: None | TensorDictModule | Callable[[TensorDictBase], TensorDictBase] = None, *, policy_factory: Callable[[], Callable] | None = None, frames_per_batch: int, total_frames: int | None = - 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: Sequence[dict[str, Any]] | 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, reset_when_done: bool = True, update_at_each_batch: bool = False, preemptive_threshold: float | None = None, num_threads: int | None = None, num_sub_threads: int = 1, set_truncated: bool = False, **kwargs)

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

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

参数:

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

  注意

  如果策略需要作为策略工厂传递（例如，不应直接序列化/腌制），则应改用 :arg:`policy_factory`。

关键字参数:

• policy_factory (Callable[[], Callable], optional) –

  一个可调用对象，它返回一个策略实例。这与 policy 参数互斥。

  注意

  policy_factory 在策略无法序列化时非常有用。

• frames_per_batch (int) – 一个仅关键字参数，表示批次中的总元素数。

• total_frames (int, optional) –

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

  可以通过传递 total_frames=-1 来创建无限收集器。默认为 -1（永不结束的收集器）。

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

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

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

• policy_device (int, str 或 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_weights_()。默认为 False。

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

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

• num_sub_threads (int, optional) – 子进程的线程数。应等于每个子进程中启动的进程数加一（或者如果只启动一个进程则为一）。默认为 1 以确保安全：如果未指定，启动多个 worker 可能会过度消耗 CPU 负载并损害性能。

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

async_shutdown(timeout: float | None = None)

当收集器通过 start 方法异步启动时，关闭收集器。

参数

timeout (float, optional): 等待收集器关闭的最长时间。 close_env (bool, optional): 如果为 True，收集器将关闭包含的环境。

默认为 True。

另请参阅

start()

init_updater(*args, **kwargs)

使用自定义参数初始化权重更新器。

此方法将参数传递给权重更新器的 init 方法。如果未设置权重更新器，则此方法无效。

参数:

• *args – 用于权重更新器初始化的位置参数

• **kwargs – 用于权重更新器初始化的关键字参数

load_state_dict(state_dict: OrderedDict) → None

在工作节点上加载 state_dict。

参数:

state_dict (OrderedDict) – 状态字典格式为 {"worker0": state_dict0, "worker1": state_dict1}。

pause()

上下文管理器，如果收集器正在自由运行，则暂停收集器。

reset(reset_idx: Sequence[bool] | None = 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(timeout: float | None = None, close_env: bool = True) → None

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

参数:

• timeout (float, optional) – 关闭工作节点之间管道的超时时间。

• close_env (bool, optional) – 是否关闭环境。默认为 True。

start()

为异步数据收集启动收集器。

收集到的数据将存储在提供的回放缓冲区中。此方法启动后台数据收集，允许数据收集和训练分离。

抛出:

RuntimeError – 如果在收集器初始化期间未定义回放缓冲区。

示例

>>> import time
>>> from functools import partial
>>>
>>> import tqdm
>>>
>>> from torchrl.collectors import MultiaSyncDataCollector, RandomPolicy
>>> from torchrl.data import LazyTensorStorage, ReplayBuffer
>>> from torchrl.envs import GymEnv, set_gym_backend
>>> import ale_py
>>>
>>> # Set the gym backend to gymnasium
>>> set_gym_backend("gymnasium").set()
>>>
>>> if __name__ == "__main__":
...     # Create a random policy for the Pong environment
...     env_fn = partial(GymEnv, "ALE/Pong-v5")
...     policy = RandomPolicy(env_fn().action_spec)
...
...     # Initialize a shared replay buffer
...     rb = ReplayBuffer(storage=LazyTensorStorage(10000), shared=True)
...
...     # Create a multi-async data collector with 16 environments
...     num_envs = 16
...     collector = MultiaSyncDataCollector(
...         [env_fn] * num_envs,
...         policy=policy,
...         replay_buffer=rb,
...         frames_per_batch=num_envs * 16,
...         total_frames=-1,
...     )
...
...     # Progress bar to track the number of collected frames
...     pbar = tqdm.tqdm(total=100_000)
...
...     # Start the collector asynchronously
...     collector.start()
...
...     # Track the write count of the replay buffer
...     prec_wc = 0
...     while True:
...         wc = rb.write_count
...         c = wc - prec_wc
...         prec_wc = wc
...
...         # Update the progress bar
...         pbar.update(c)
...         pbar.set_description(f"Write Count: {rb.write_count}")
...
...         # Check the write count every 0.5 seconds
...         time.sleep(0.5)
...
...         # Stop when the desired number of frames is reached
...         if rb.write_count . 100_000:
...             break
...
...     # Shut down the collector
...     collector.async_shutdown()

state_dict() → OrderedDict

返回数据收集器的 state_dict。

每个字段代表一个工作节点，其中包含其自身的 state_dict。

update_policy_weights_(policy_or_weights: TensorDictBase | TensorDictModuleBase | dict | None = None, *, worker_ids: int | list[int] | torch.device | list[torch.device] | None = None, **kwargs) → None

更新数据收集器的策略权重，支持本地和远程执行上下文。

此方法确保数据收集器使用的策略权重与最新的训练权重同步。它支持本地和远程权重更新，具体取决于数据收集器的配置。本地（下载）更新在远程（上传）更新之前执行，以便可以将权重从服务器传输到子工作进程。

参数:

• policy_or_weights (TensorDictBase | TensorDictModuleBase | dict | None) – 用于更新的权重。可以是： - TensorDictModuleBase：一个将提取其权重的策略模块 - TensorDictBase：一个包含权重的 TensorDict - dict：一个常规的包含权重的 dict - None：将尝试从服务器获取权重，使用 _get_server_weights()

• worker_ids (int | List[int] | torch.device | List[torch.device] | None, optional) – 需要更新的 worker 的标识符。当收集器关联了多个 worker 时，这一点很重要。

抛出:

TypeError – 如果提供了 worker_ids 但未配置 weight_updater。

注意

用户应扩展 WeightUpdaterBase 类来定制特定用例的权重更新逻辑。不应覆盖此方法。

另请参阅

LocalWeightsUpdaterBase 和 RemoteWeightsUpdaterBase()。