RayCollector

class torchrl.collectors.distributed.RayCollector(create_env_fn: Callable | EnvBase | list[Callable] | list[EnvBase], policy: Callable[[TensorDictBase], TensorDictBase] | None = None, *, policy_factory: Callable[[], Callable] | list[Callable[[], Callable]] | None = None, frames_per_batch: int, total_frames: int = -1, device: torch.device | list[torch.device] | None = None, storing_device: torch.device | list[torch.device] | None = None, env_device: torch.device | list[torch.device] | None = None, policy_device: torch.device | list[torch.device] | None = None, max_frames_per_traj=-1, init_random_frames=-1, reset_at_each_iter=False, postproc=None, split_trajs=False, exploration_type=InteractionType.RANDOM, collector_class: Callable[[TensorDict], TensorDict] = <class 'torchrl.collectors.collectors.SyncDataCollector'>, collector_kwargs: dict[str, Any] | list[dict] | None = None, num_workers_per_collector: int = 1, sync: bool = False, ray_init_config: dict[str, Any] | None = None, remote_configs: dict[str, Any] | list[dict[str, Any]] | None = None, num_collectors: int | None = None, update_after_each_batch: bool = False, max_weight_update_interval: int = -1, replay_buffer: ReplayBuffer | None = None, weight_updater: WeightUpdaterBase | Callable[[], WeightUpdaterBase] | None = None)

使用 Ray 后端的分布式数据收集器。

这个 Python 类作为一种基于 ray 的解决方案，用于在分布式集群中实例化和协调多个数据收集器。与 TorchRL 的非分布式收集器一样，这个收集器是一个可迭代对象，它会生成 TensorDicts 直到达到目标收集帧数，但在后台处理分布式数据收集。

类字典输入参数“ray_init_config”可用于提供调用 Ray 初始化方法 ray.init() 的关键字参数。如果未提供“ray_init_config”，则默认行为是自动检测现有的 Ray 集群，或者在未找到现有集群时本地启动一个新的 Ray 实例。有关高级初始化关键字参数，请参阅 Ray 文档。

同样，字典输入参数“remote_configs”可用于指定调用 ray.remote() 时创建每个远程收集器 Actor 的关键字参数，包括收集器的计算资源。所有收集器资源的总和应在集群中可用。有关 ray.remote() 方法的高级配置，请参阅 Ray 文档。默认关键字参数为

>>> kwargs = {
...     "num_cpus": 1,
...     "num_gpus": 0.2,
...     "memory": 2 * 1024 ** 3,
... }

收集器实例之间的协调可以指定为“同步”或“异步”。在同步协调中，此类会等待所有远程收集器收集一个 rollout，将所有 rollouts 串联成一个 TensorDict 实例，然后生成串联后的数据。另一方面，如果协调是异步进行的，此类会在各个远程收集器可用时提供 rollouts。

参数:

• create_env_fn (Callable 或 List[Callable]) – 返回 EnvBase 实例的 Callable 列表。

• policy (Callable, 可选) –

  在环境中执行的策略。必须接受 tensordict.tensordict.TensorDictBase 对象作为输入。如果提供 None，则使用的策略将是具有环境 action_spec 的 RandomPolicy 实例。接受的策略通常是 TensorDictModuleBase 的子类。这是收集器的推荐用法。也接受其他 Callable：如果策略不是 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], list of Callable[[], Callable], 可选) –

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

  注意

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

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

• total_frames (int, 可选) – 收集器返回的总帧数的下限。迭代器将在收集的总帧数等于或超过传递给收集器的总帧数时停止。默认值为 -1，表示没有目标总帧数（即收集器将无限期运行）。

• device (int, str 或 torch.device, 可选) – 收集器的通用设备。 device 参数会填充任何未指定的设备：如果 device 不是 None 并且 storing_device、policy_device 或 env_device 中任何一个未指定，其值将设置为 device。默认值为 None（无默认设备）。支持设备列表。

• storing_device (int, str 或 torch.device, 可选) – 输出 TensorDict 将被存储的*远程*设备。如果提供了 device 且 storing_device 为 None，它将默认使用 device 指示的值。对于长轨迹，可能需要将数据存储在与策略和环境执行的设备不同的设备上。默认值为 None（输出 tensordict 不在特定设备上，叶子张量位于创建它们的设备上）。支持设备列表。

• env_device (int, str 或 torch.device, 可选) – 环境应被转换（或执行，如果支持该功能）的*远程*设备。如果未指定且环境具有非 None 设备，env_device 将默认使用该值。如果提供了 device 且 env_device=None，它将默认使用 device。如果如此指定的 env_device 值与 policy_device 不同，并且其中一个不是 None，数据将在传递给环境之前被转换为 env_device（即，支持向策略和环境传递不同的设备）。默认值为 None。支持设备列表。

• policy_device (int, str 或 torch.device, 可选) – 策略应被转换的*远程*设备。如果提供了 device 且 policy_device=None，它将默认使用 device。如果如此指定的 policy_device 值与 env_device 不同，并且其中一个不是 None，数据将在传递给策略之前被转换为 policy_device（即，支持向策略和环境传递不同的设备）。默认值为 None。支持设备列表。

• create_env_kwargs (dict, 可选) – create_env_fn 的关键字参数字典。

• max_frames_per_traj (int, 可选) – 每个轨迹的最大步数。请注意，一个轨迹可以跨越多个批次（除非 reset_at_each_iter 设置为 True，见下文）。一旦轨迹达到 n_steps，环境将被重置。如果环境包装了多个环境，步数将为每个环境独立跟踪。允许负值，在这种情况下将忽略此参数。默认为 None（即，没有最大步数）。

• init_random_frames (int, 可选) – 在调用策略之前忽略策略的帧数。此功能主要用于离线/基于模型设置，其中可以使用一批随机轨迹来初始化训练。如果提供了，它将被向上舍入到最接近的 frames_per_batch 的倍数。默认为 None（即，无随机帧）。

• reset_at_each_iter (bool, optional) – 是否在批次收集开始时重置环境。默认为 False。

• postproc (Callable, 可选) – 后处理转换，例如 Transform 或 MultiStep 实例。默认为 None。

• split_trajs (bool, 可选) – 指示结果 TensorDict 是否应根据轨迹进行拆分的布尔值。有关更多信息，请参阅 split_trajectories()。默认为 False。

• exploration_type (ExplorationType, 可选) – 收集数据时使用的交互模式。必须是 torchrl.envs.utils.ExplorationType.DETERMINISTIC、torchrl.envs.utils.ExplorationType.RANDOM、torchrl.envs.utils.ExplorationType.MODE 或 torchrl.envs.utils.ExplorationType.MEAN 之一。

• collector_class (Python class 或 构造函数) – 要远程实例化的收集器类。可以是 SyncDataCollector、MultiSyncDataCollector、MultiaSyncDataCollector 或其派生类。默认为 SyncDataCollector。

• collector_kwargs (dict 或 list, 可选) – 要传递给远程数据收集器的参数字典。如果提供列表，每个元素将对应于专用收集器的单个关键字参数集。

• num_workers_per_collector (int) – 要在远程节点上使用的环境构造函数的副本数。默认为 1（每个收集器一个环境）。在单个工作节点上，所有子工作器都将执行相同的环境。如果需要执行不同的环境，应将它们分发到工作节点，而不是子节点。

• ray_init_config (dict, 可选) – 用于调用 ray.init() 的关键字参数。

• remote_configs (list of dicts, 可选) – 每个远程收集器的 Ray 资源规范。也可以提供单个字典，它将被用于所有收集器。

• num_collectors (int, 可选) – 要实例化的收集器总数。

• sync (bool) – 如果为 True，则生成的 tensordict 是在每个节点上收集的所有 tensordicts 的堆栈。如果为 False（默认），则每个 tensordict 来自单独的节点，以“先到先得”的方式。

• update_after_each_batch (bool, 可选) – 如果为 True，则在每次收集后都会更新权重。对于 sync=True，这意味着所有工作器都将看到其权重被更新。对于 sync=False，只有收集到数据的那个工作器将被更新。这相当于 max_weight_update_interval=0。默认为 False，即更新必须通过 torchrl.collectors.DataCollector.update_policy_weights_() 手动执行

• max_weight_update_interval (int, 可选) – 在工作器的策略权重被更新之前可以收集的最大批次数。对于同步收集，此参数将被 update_after_each_batch 覆盖。对于异步收集，一个工作器可能在一段时间内未看到其参数被更新，即使 update_after_each_batch 已开启。默认为 -1（无强制更新）。

• replay_buffer (RayReplayBuffer, 可选) –

  如果提供，收集器将不会生成 tensordicts，而是填充缓冲区。默认为 None。

  注意

  虽然没有强制要求（以便用户可以实现自己的回放缓冲区类），但此处应使用 RayReplayBuffer 实例。

• weight_updater (WeightUpdaterBase 或 构造函数, 可选) – WeightUpdaterBase 或其子类的实例，负责更新 Ray 管理的远程推理工作器上的策略权重。如果未提供，默认将使用 RayWeightUpdater，它利用 Ray 的分布式功能。考虑使用构造函数，如果需要序列化更新器。

示例

>>> from torch import nn
>>> from tensordict.nn import TensorDictModule
>>> from torchrl.envs.libs.gym import GymEnv
>>> from torchrl.collectors.collectors import SyncDataCollector
>>> from torchrl.collectors.distributed import RayCollector
>>> env_maker = lambda: GymEnv("Pendulum-v1", device="cpu")
>>> policy = TensorDictModule(nn.Linear(3, 1), in_keys=["observation"], out_keys=["action"])
>>> distributed_collector = RayCollector(
...     create_env_fn=[env_maker],
...     policy=policy,
...     collector_class=SyncDataCollector,
...     max_frames_per_traj=50,
...     init_random_frames=-1,
...     reset_at_each_iter=-False,
...     collector_kwargs={
...         "device": "cpu",
...         "storing_device": "cpu",
...     },
...     num_collectors=1,
...     total_frames=10000,
...     frames_per_batch=200,
... )
>>> for i, data in enumerate(collector):
...     if i == 2:
...         print(data)
...         break

add_collectors(create_env_fn, num_envs, policy, collector_kwargs, remote_configs)

创建并向集合添加一些远程收集器。

async async_shutdown()

结束 ray.init() 在异步执行期间启动的进程。

init_updater(*args, **kwargs)

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

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

参数:

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

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

load_state_dict(state_dict: OrderedDict | list[OrderedDict]) → None

调用父方法以处理每个远程收集器。

local_policy()

返回本地收集器。

pause()

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

property remote_collectors

返回远程收集器列表。

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

迭代地调用父方法以处理每个远程收集器，并返回最终种子。

shutdown(timeout: float | None = None) → None

停止由 ray.init() 启动的进程。

start()

启动 RayCollector。

state_dict() → list[OrderedDict]

调用父方法以处理每个远程收集器，并返回结果列表。

stop_remote_collectors()

停止所有远程收集器。

update_policy_weights_(policy_or_weights: TensorDictBase | TensorDictModuleBase | dict | 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, 可选) – 需要更新的工作器的标识符。当收集器关联有多个工作器时，此参数很重要。

抛出:

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

注意

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

另请参阅

LocalWeightsUpdaterBase 和 RemoteWeightsUpdaterBase()。