aSyncDataCollector¶
- 类 torchrl.collectors.aSyncDataCollector(create_env_fn: Callable[[], EnvBase], policy: Optional[Union[TensorDictModule, Callable[[TensorDictBase], TensorDictBase]]], *, frames_per_batch: int, total_frames: Optional[int] = - 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: Optional[Sequence[dict]] = None, max_frames_per_traj: int | None = None, init_random_frames: int | None = None, reset_at_each_iter: bool = False, postproc: Optional[Callable[[TensorDictBase], TensorDictBase]] = None, split_trajs: Optional[bool] = None, exploration_type: ExplorationType = InteractionType.RANDOM, reset_when_done: bool = True, update_at_each_batch: boolm optional = False, preemptive_threshold: float = None, num_threads: int = None, num_sub_threads: int = 1, set_truncated: bool = False, **kwargs)[来源]¶
在单独的进程中运行单个 `DataCollector`。
这主要适用于离线强化学习范式，其中训练的策略可能与用于收集数据的策略不同。在在线设置中，应优先使用常规的 `DataCollector`。这个类只是 `MultiaSyncDataCollector` 的一个包装器，其中只创建一个单独的进程。
- 参数:
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)。
- 关键字参数:
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（无默认设备）。如果希望为每个 worker 指示不同的设备，则支持设备列表。列表的长度必须与 worker 的数量相同。storing_device (int, str 或 torch.device, optional) – 输出
TensorDict将存储在的设备。如果传递了device且storing_device为None，则默认为device指示的值。对于长轨迹，可能需要在与策略和环境执行设备不同的设备上存储数据。默认为None（输出 tensordict 不在特定设备上，叶张量位于创建它们的设备上）。如果希望为每个 worker 指示不同的设备，则支持设备列表。列表的长度必须与 worker 的数量相同。env_device (int, str 或 torch.device, optional) – 环境应被放置（或执行，如果支持该功能）的设备。如果未指定且环境具有非
None设备，则env_device将默认为该值。如果传递了device且env_device=None，则将默认为device。如果如此指定的env_device的值与policy_device不同且其中一个不为None，则在传递给环境之前会将数据转换为env_device（即，支持为策略和环境传递不同的设备）。默认为None。如果希望为每个 worker 指示不同的设备，则支持设备列表。列表的长度必须与 worker 的数量相同。policy_device (int, str 或 torch.device, optional) – 策略应被放置的设备。如果传递了
device且policy_device=None，则将默认为device。如果如此指定的policy_device的值与env_device不同且其中一个不为None，则在传递给策略之前会将数据转换为policy_device（即，支持为策略和环境传递不同的设备）。默认为None。如果希望为每个 worker 指示不同的设备，则支持设备列表。列表的长度必须与 worker 的数量相同。create_env_kwargs (dict, optional) – 一个字典，包含用于创建环境的关键字参数。如果提供列表，则其每个元素将分配给一个子收集器。
max_frames_per_traj (int | None, optional) – 每条轨迹的最大步数。请注意，一条轨迹可以跨越多个批次（除非将
reset_at_each_iter设置为True，详见下文）。一旦一条轨迹达到n_steps，环境就会重置。如果环境包装了多个环境，则会为每个环境独立跟踪步数。允许负值，此时该参数将被忽略。默认为None（即没有最大步数）。init_random_frames (int | None, 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_weight_()。默认为False。preemptive_threshold (
float, optional) – 一个介于 0.0 和 1.0 之间的值，指定允许在其他 worker 被强制提前结束之前完成其 rollout 收集的 worker 的比例。num_threads (int, optional) – 此进程的线程数。默认为 worker 的数量。
num_sub_threads (int, optional) – 子进程的线程数。应等于每个子进程内启动的进程数加一（如果启动单个进程，则为一）。默认为 1，以确保安全：如果未指示，启动多个 worker 可能会导致 CPU 负载过高并影响性能。
set_truncated (bool, optional) – 如果为
True，则当达到 rollout 的最后一帧时，截断信号（以及相应的"done"但不是"terminated"）将被设置为True。如果找不到"truncated"键，则会引发异常。截断键可以通过env.add_truncated_keys设置。默认为False。
- load_state_dict(state_dict: OrderedDict) None[来源]¶
在 worker 上加载 `state_dict`。
- 参数:
state_dict (OrderedDict) – 格式为
{"worker0": state_dict0, "worker1": state_dict1}的 `state_dict`。
- reset(reset_idx: Optional[Sequence[bool]] = 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
- update_policy_weights_(policy_weights: Optional[TensorDictBase] = None) None¶
如果数据收集器的策略和训练的策略位于不同的设备上，则更新策略权重。
- 参数:
policy_weights (TensorDictBase, optional) – 如果提供，则为一个 `TensorDict`，包含用于更新的策略权重。
