SyncDataCollector¶

class torchrl.collectors.SyncDataCollector(create_env_fn: EnvBase | EnvCreator | Sequence[Callable[[], EnvBase]], policy: None | TensorDictModule | Callable[[TensorDictBase], TensorDictBase] = None, *, policy_factory: Callable[[], Callable] | None = None, frames_per_batch: int, total_frames: int = - 1, device: DEVICE_TYPING | None = None, storing_device: DEVICE_TYPING | None = None, policy_device: DEVICE_TYPING | None = None, env_device: DEVICE_TYPING | None = None, create_env_kwargs: 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, return_same_td: bool = False, reset_when_done: bool = True, interruptor=None, set_truncated: bool = False, use_buffers: bool | None = None, replay_buffer: ReplayBuffer | None = None, extend_buffer: bool = False, 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, weight_updater: WeightUpdaterBase | Callable[[], WeightUpdaterBase] | None = None, **kwargs)[源码]¶

RL 问题通用数据收集器。需要环境构造器和策略。

参数:

create_env_fn (Callable) – 一个可调用对象，返回一个 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)。
注意

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

关键字参数:

policy_factory (Callable[[], Callable], optional) –
一个可调用对象，它返回一个策略实例。这与 policy 参数互斥。

注意

policy_factory 在策略无法序列化时非常有用。
frames_per_batch (int) – 一个仅关键字参数，表示批次中的总元素数。
total_frames (int) –
一个仅关键字参数，表示收集器在其生命周期内返回的总帧数。如果 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) – create_env_fn 的 kwargs 字典。
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 之一。
return_same_td (bool, optional) – 如果为 True，则每次迭代都会返回相同的 TensorDict，其值会更新。此功能应谨慎使用：例如，如果将相同的 tensordict 添加到回放缓冲区，则缓冲区的整个内容将相同。默认为 False。
interruptor (_Interruptor, optional) – 可从类外部使用的 _Interruptor 对象来控制 rollouts 收集。 _Interruptor 类具有 ´start_collection´ 和 ´stop_collection´ 方法，这些方法允许实现诸如抢先停止 rollouts 收集之类的策略。默认为 False。
set_truncated (bool, optional) – 如果为 True，则在达到 rollouts 的最后一帧时，截断信号 (以及对应的 "done" 但不包括 "terminated") 将被设置为 True。如果未找到 "truncated" 键，将引发异常。截断键可以通过 env.add_truncated_keys 设置。默认为 False。
use_buffers (bool, optional) – 如果为 True，将使用缓冲区来堆叠数据。这与具有动态规范的环境不兼容。对于没有动态规范的环境，默认为 True，对于其他环境，默认为 False。
replay_buffer (ReplayBuffer, optional) –
如果提供了回放缓冲区，收集器将不会产生 tensordicts，而是填充缓冲区。默认为 None。

另请参阅

默认情况下，缓冲区在收集到 (一批) 帧时填充。如果需要用整个 rollouts 扩展缓冲区，请将 extend_buffer 设置为 True。

警告

使用具有 postproc 或 split_trajs=True 的回放缓冲区是禁止的，除非 extend_buffer=True，因为需要观察整个批次才能应用这些转换。
extend_buffer (bool, optional) – 如果为 True，则回放缓冲区将用整个 rollouts 扩展，而不是用单个步骤扩展。默认为 False。
trust_policy (bool, optional) – 如果为 True，将信任非 TensorDictModule 策略，并假设其与收集器兼容。对于 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。
weight_updater (WeightUpdaterBase 或 构造器, optional) – WeightUpdaterBase 实例或其子类，负责在远程推理工作者上更新策略权重。这通常不用于 SyncDataCollector，因为它在单进程环境中运行。如果需要序列化更新器，请考虑使用构造器。

示例

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

收集器提供的批次数据都带有 "time" 维度标记。

示例

>>> assert data.names[-1] == "time"

async_shutdown(timeout: float | None = None, close_env: bool = True) → None[源码]¶: 结束 ray.init() 在异步执行期间启动的进程。

init_updater(*args, **kwargs)¶

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

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

参数:

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

iterator() → Iterator[TensorDictBase][源码]¶

迭代 DataCollector。

Yields: 包含轨迹 (块) 的 TensorDictBase 对象

load_state_dict(state_dict: OrderedDict, **kwargs) → None[源码]¶

在环境和策略上加载 state_dict。

参数:: state_dict (OrderedDict) – 包含 “policy_state_dict” 和 "env_state_dict" 字段的有序字典。

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

reset(index=None, **kwargs) → None[源]¶: 将环境重置到新的初始状态。

rollout() → TensorDictBase[源]¶

使用提供的策略在环境中计算 rollout。

返回:: 包含所计算 rollout 的 TensorDictBase。

set_seed(seed: int, static_seed: bool = False) → int[源]¶

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

参数:

seed (int) – 用于环境的种子整数。
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 = ParallelEnv(6, env_fn)
>>> policy = TensorDictModule(nn.Linear(3, 1), in_keys=["observation"], out_keys=["action"])
>>> collector = SyncDataCollector(env_fn_parallel, policy, total_frames=300, frames_per_batch=100)
>>> 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 SyncDataCollector, 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 = GymEnv("ALE/Pong-v5")
...     policy = RandomPolicy(env.action_spec)
...
...     # Initialize a shared replay buffer
...     rb = ReplayBuffer(storage=LazyTensorStorage(1000), shared=True)
...
...     # Create a synchronous data collector
...     collector = SyncDataCollector(
...         env,
...         policy=policy,
...         replay_buffer=rb,
...         frames_per_batch=256,
...         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（环境和策略）。

返回:: 包含 "policy_state_dict" 和 “env_state_dict” 字段的有序字典。

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

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

参数:

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) – 需要更新的工作进程的标识符。当收集器具有多个相关工作进程时，此参数是相关的。

抛出:

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

注意

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

另请参阅

LocalWeightsUpdaterBase 和 RemoteWeightsUpdaterBase()。

SyncDataCollector¶

文档

教程

资源