RayCollector¶

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

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

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

类字典输入参数 “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 从各个远程收集器可用时提供 rollout。

参数:

create_env_fn (Callable 或 List[Callabled]) – 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)。

关键字参数:

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) – 要在远程节点上使用的 env 构造函数的副本数。默认为 1 （每个收集器单个环境）。在单个工作节点上，所有子工作节点将执行相同的环境。如果需要执行不同的环境，则应跨工作节点而不是子节点分派它们。
ray_init_config (dict, Optional) – 用于调用 ray.init() 的 kwargs。
remote_configs (list of dicts, Optional) – 每个远程收集器的 ray 资源规范。也可以提供单个字典，并将用于所有收集器。
num_collectors (int, Optional) – 要实例化的收集器总数。
sync (bool) – 如果 True，则生成的 tensordict 是每个节点上收集的所有 tensordict 的堆叠。如果 False （默认），则每个 tensordict 都来自单独的节点，以“先就绪先服务”的方式提供。
update_after_each_batch (bool, optional) – 如果 True，则将在每次收集后更新权重。对于 sync=True，这意味着所有工作节点都将看到其权重更新。对于 sync=False，仅会更新从中收集数据的工作节点的权重。默认为 False，即必须通过 torchrl.collectors.distributed.RayDistributedCollector.update_policy_weights_() 手动执行更新
max_weight_update_interval (int, optional) – 在更新工作节点的策略权重之前可以收集的最大批次数。对于同步收集，此参数将被 update_after_each_batch 覆盖。对于异步收集，即使打开了 update_after_each_batch，也可能存在一个工作节点在一段时间内没有看到其参数被更新的情况。默认为 -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)[source]¶: 创建并添加多个远程收集器到集合中。

load_state_dict(state_dict: Union[OrderedDict, List[OrderedDict]]) → None[source]¶: 为每个远程收集器调用父方法。

local_policy()[source]¶: 返回本地收集器。

remote_collectors()[source]¶: 返回远程收集器列表。

set_seed(seed: int, static_seed: bool = False) → List[int][source]¶: 迭代地为每个远程收集器调用父方法，并返回最终种子。

shutdown()[source]¶: 完成 ray.init() 启动的进程。

state_dict() → List[OrderedDict][source]¶: 为每个远程收集器调用父方法，并返回结果列表。

stop_remote_collectors()[source]¶: 停止所有远程收集器。

update_policy_weights_(worker_rank=None) → None[source]¶

更新工作节点的权重。

参数:: worker_rank (int, optional) – 如果提供，则仅更新此工作节点的权重。

RayCollector¶

文档

教程

资源