RayCollector

class torchrl.collectors.distributed.RayCollector(create_env_fn: Union[Callable, EnvBase, List[Callable], List[EnvBase]], policy: Callable[[TensorDict], TensorDict], *, frames_per_batch: int, total_frames: int = -1, device: torch.device | List[torch.device] = None, storing_device: torch.device | List[torch.device] = None, env_device: torch.device | List[torch.device] = None, policy_device: torch.device | List[torch.device] = 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: Union[Dict, List[Dict]] = None, num_workers_per_collector: int = 1, sync: bool = False, ray_init_config: Dict = None, remote_configs: Union[Dict, List[Dict]] = None, num_collectors: int = None, update_after_each_batch=False, max_weight_update_interval=-1)

带有 Ray 后端的分布式数据收集器。

这个 Python 类是基于 Ray 的解决方案，用于在分布式集群中实例化和协调多个数据收集器。与 TorchRL 非分布式收集器类似，这个收集器是一个可迭代对象，它会持续产生 TensorDict，直到达到目标收集帧数，并在底层处理分布式数据收集。

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

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

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

收集器实例之间的协调可以指定为“同步”或“异步”。在同步协调中，此类会等待所有远程收集器完成一次 rollout 收集，将所有 rollout 连接成一个 TensorDict 实例，最后产生连接后的数据。另一方面，如果协调要异步进行，此类会按各个远程收集器完成 rollout 的顺序提供数据。

参数：

• create_env_fn (Callable 或 List[Callabled]) – Callable 列表，每个 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)。

关键字参数：

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

• total_frames (int, Optional) – 收集器返回的总帧数的下限。一旦总帧数等于或超过传递给收集器的总帧数，迭代器将停止。默认值为 -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 中的一个。

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

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

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

• ray_init_config (dict, Optional) – 调用 ray.init() 时使用的 kwargs。

• remote_configs (list of dicts, Optional) – 每个远程收集器的 ray 资源规范。也可以提供单个 dict，该 dict 将用于所有收集器。

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

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

• update_after_each_batch (bool, optional) – 如果为 True，则在每次收集后更新权重。对于 sync=True，这意味着所有 worker 的权重都会得到更新。对于 sync=False，只会更新从中收集数据的 worker 的权重。默认为 False，即必须通过 torchrl.collectors.distributed.RayDistributedCollector.update_policy_weights_() 手动执行更新。

• max_weight_update_interval (int, optional) – 在 worker 的策略权重更新之前可以收集的最大批次数。对于同步收集，此参数会被 update_after_each_batch 覆盖。对于异步收集，即使 update_after_each_batch 已开启，某个 worker 的参数也可能在一定时间内没有得到更新。默认为 -1（不强制更新）。

示例

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

创建并向集合中添加多个远程收集器。

load_state_dict(state_dict: Union[OrderedDict, List[OrderedDict]]) → None

为每个远程收集器调用父方法。

local_policy()

返回本地收集器。

remote_collectors()

返回远程收集器列表。

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

为每个远程收集器迭代调用父方法并返回最终种子。

shutdown()

结束由 ray.init() 启动的进程。

state_dict() → List[OrderedDict]

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

stop_remote_collectors()

停止所有远程收集器。

update_policy_weights_(worker_rank=None) → None

更新 worker 节点的权重。

参数：

worker_rank (int, optional) – 如果提供，则仅更新此 worker 的权重。