ParallelEnv¶
- class torchrl.envs.ParallelEnv(*args, **kwargs)[source]¶
为每个进程创建一个环境。
TensorDicts 通过共享内存或内存映射传递。
批处理环境允许用户查询远程运行环境中任意方法/属性。
这些查询将返回一个列表，其长度等于 worker 数量，包含查询结果值。
>>> env = ParallelEnv(3, my_env_fun) >>> custom_attribute_list = env.custom_attribute >>> custom_method_list = env.custom_method(*args)
- 参数:
num_workers – 同时部署的 worker（即环境实例）数量；
create_env_fn (callable 或 callables 列表) – 用于创建环境的函数（或函数列表）。如果使用单个任务，应使用 callable 而非相同 callables 的列表：如果提供 callable 列表，环境将像需要多个不同任务一样执行，这会带来轻微的计算开销；
- 关键字参数:
create_env_kwargs (dict 或 dict 列表, 可选) – 用于创建环境的关键字参数；
share_individual_td (bool, 可选) – 如果为
True，则为每个进程/worker 创建一个不同的 tensordict，并返回一个 lazy stack。默认值 = None（如果为单个任务则为 False）；shared_memory (bool) – 返回的 tensordict 是否将放置在共享内存中；
memmap (bool) – 返回的 tensordict 是否将放置在内存映射中。
policy_proof (callable, 可选) – 如果提供，它将用于获取通过
step()和reset()方法返回的 tensor 列表，例如"hidden"等。device (str, int, torch.device) – 可以传递批处理环境的设备。如果未指定，则从环境推断。在这种情况下，假定所有环境的设备匹配。如果提供，则可以与子环境的设备不同。在这种情况下，数据将在收集过程中自动转换为适当的设备。这可以在转换为设备引入开销（例如基于 numpy 的环境等）的情况下用于加速收集：通过为批处理环境使用
"cuda"设备，但为嵌套环境使用"cpu"设备，可以将开销降至最低。num_threads (int, 可选) – 此进程的线程数。应等于每个子进程内启动的进程数加一（如果启动单个进程则为一）。默认为 worker 数 + 1。此参数对
SerialEnv类无效。num_sub_threads (int, 可选) – 子进程的线程数。出于安全考虑，默认为 1：如果未指定，启动多个 worker 可能会使 cpu 负载过高并损害性能。此参数对
SerialEnv类无效。serial_for_single (bool, 可选) – 如果为
True，使用单个 worker 创建并行环境将返回SerialEnv。此选项对SerialEnv无效。默认为False。non_blocking (bool, 可选) – 如果为
True，设备移动将使用non_blocking=True选项执行。默认为True。mp_start_method (str, 可选) – 多进程启动方法。如果未指定，则使用默认启动方法（如果在首次导入前未另行初始化，则 TorchRL 中默认为 ‘spawn’）。仅用于
ParallelEnv子类。use_buffers (bool, 可选) –
worker 之间的通信是否应通过预分配的循环内存缓冲区进行。除非其中一个环境具有动态 specs，否则默认为
True。注意
在此了解更多关于动态 specs 和环境的信息here。
注意
可以使用以下技术将关键字参数传递给每个子环境：
reset()中的每个关键字参数都将传递给每个环境，但list_of_kwargs参数除外，如果存在，它应包含一个与 worker 数量相同长度的列表，其中 worker 特定的关键字参数存储在字典中。如果查询部分重置，将忽略与未重置的子环境对应的list_of_kwargs元素。示例
>>> from torchrl.envs import GymEnv, ParallelEnv, SerialEnv, EnvCreator >>> make_env = EnvCreator(lambda: GymEnv("Pendulum-v1")) # EnvCreator ensures that the env is sharable. Optional in most cases. >>> env = SerialEnv(2, make_env) # Makes 2 identical copies of the Pendulum env, runs them on the same process serially >>> env = ParallelEnv(2, make_env) # Makes 2 identical copies of the Pendulum env, runs them on dedicated processes >>> from torchrl.envs import DMControlEnv >>> env = ParallelEnv(2, [ ... lambda: DMControlEnv("humanoid", "stand"), ... lambda: DMControlEnv("humanoid", "walk")]) # Creates two independent copies of Humanoid, one that walks one that stands >>> rollout = env.rollout(10) # executes 10 random steps in the environment >>> rollout[0] # data for Humanoid stand TensorDict( fields={ action: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False), com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False), head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False), joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False), next: TensorDict( fields={ com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False), head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False), joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False), reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False) >>> rollout[1] # data for Humanoid walk TensorDict( fields={ action: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False), com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False), head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False), joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False), next: TensorDict( fields={ com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False), head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False), joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False), reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False) >>> # serial_for_single to avoid creating parallel envs if not necessary >>> env = ParallelEnv(1, make_env, serial_for_single=True) >>> assert isinstance(env, SerialEnv) # serial_for_single allows you to avoid creating parallel envs when not necessary
注意
ParallelEnv 将在其中一个 worker 空闲达到指定时间后超时。这可以通过 BATCHED_PIPE_TIMEOUT 环境变量控制，该变量会修改 torchrl._utils.BATCHED_PIPE_TIMEOUT 整型值。默认超时值为 10000 秒。
警告
TorchRL 的 ParallelEnv 在环境 specs 方面相当严格，因为它们用于构建进程间通信的共享内存缓冲区。因此，我们鼓励用户首先使用
check_env_specs()检查环境 specs。>>> from torchrl.envs import check_env_specs >>> env = make_env() >>> check_env_specs(env) # if this passes without error you're good to go! >>> penv = ParallelEnv(2, make_env)
特别是，如果未正确设置 specs，带有 info-dict readers 的类似 gym 的环境可能难以跨进程共享，这很难自动完成。请查看
set_info_dict_reader()以获取更多信息。下面是一个简短示例>>> from torchrl.envs import GymEnv, set_gym_backend, check_env_specs, TransformedEnv, TensorDictPrimer >>> import torch >>> env = GymEnv("HalfCheetah-v4") >>> env.rollout(3) # no info registered, this env passes check_env_specs TensorDict( fields={ action: Tensor(shape=torch.Size([10, 6]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([10, 17]), device=cpu, dtype=torch.float64, is_shared=False), reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([10, 17]), device=cpu, dtype=torch.float64, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False) >>> check_env_specs(env) # succeeds! >>> env.set_info_dict_reader() # sets the default info_dict reader >>> env.rollout(10) # because the info_dict is empty at reset time, we're missing the root infos! TensorDict( fields={ action: Tensor(shape=torch.Size([10, 6]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([10, 17]), device=cpu, dtype=torch.float64, is_shared=False), reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False), reward_ctrl: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False), reward_run: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), x_position: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False), x_velocity: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([10, 17]), device=cpu, dtype=torch.float64, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False) >>> check_env_specs(env) # This check now fails! We should not use an env constructed like this in a parallel env >>> # This ad-hoc fix registers the info-spec for reset. It is wrapped inside `env.auto_register_info_dict()` >>> env_fixed = TransformedEnv(env, TensorDictPrimer(env.info_dict_reader[0].info_spec)) >>> env_fixed.rollout(10) TensorDict( fields={ action: Tensor(shape=torch.Size([10, 6]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([10, 17]), device=cpu, dtype=torch.float64, is_shared=False), reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False), reward_ctrl: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False), reward_run: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), x_position: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False), x_velocity: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([10, 17]), device=cpu, dtype=torch.float64, is_shared=False), reward_ctrl: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False), reward_run: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), x_position: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False), x_velocity: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False) >>> check_env_specs(env_fixed) # Succeeds! This env can be used within a parallel env!
相关类和方法：
auto_register_info_dict()和default_info_dict_reader。警告
选择执行 ParallelEnv 的设备会极大地影响其性能。经验法则是
如果基础环境（后端，例如 Gym）在 CPU 上执行，则子环境也应在 CPU 上执行，数据应通过共享物理内存传递。
如果基础环境在 (或可以在) CUDA 上执行，则子环境也应放置在 CUDA 上。
如果 CUDA 设备可用且策略将在 CUDA 上执行，则 ParallelEnv 设备应设置为 CUDA。
因此，假设 CUDA 设备可用，我们有以下场景
>>> # The sub-envs are executed on CPU, but the policy is on GPU >>> env = ParallelEnv(N, MyEnv(..., device="cpu"), device="cuda") >>> # The sub-envs are executed on CUDA >>> env = ParallelEnv(N, MyEnv(..., device="cuda"), device="cuda") >>> # this will create the exact same environment >>> env = ParallelEnv(N, MyEnv(..., device="cuda")) >>> # If no cuda device is available >>> env = ParallelEnv(N, MyEnv(..., device="cpu"))
警告
ParallelEnv 在所有操作（
step()、reset()和step_and_maybe_reset()）中禁用梯度，因为梯度无法通过multiprocessing.Pipe对象传递。只有SerialEnv支持反向传播。- property action_key: NestedKey¶
环境的动作键。
默认情况下，这将是“action”。
如果环境中存在多个动作键，此函数将引发异常。
- property action_keys: list[tensordict._nestedkey.NestedKey]¶
环境的动作键列表。
默认情况下，只有一个名为“action”的键。
键按数据树中的深度排序。
- property action_spec: TensorSpec¶
action spec。
action_spec 始终存储为复合 spec。
如果 action spec 作为简单 spec 提供，则返回此简单 spec。
>>> env.action_spec = Unbounded(1) >>> env.action_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果 action spec 作为复合 spec 提供且仅包含一个叶节点，此函数将仅返回该叶节点。
>>> env.action_spec = Composite({"nested": {"action": Unbounded(1)}}) >>> env.action_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果 action spec 作为复合 spec 提供且包含多个叶节点，此函数将返回整个 spec。
>>> env.action_spec = Composite({"nested": {"action": Unbounded(1), "another_action": Categorical(1)}}) >>> env.action_spec Composite( nested: Composite( action: UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), another_action: Categorical( shape=torch.Size([]), space=DiscreteBox(n=1), device=cpu, dtype=torch.int64, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
要检索传递的完整 spec，请使用
>>> env.input_spec["full_action_spec"]
此属性是可变的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.action_spec BoundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
- property action_spec_unbatched: TensorSpec¶
返回环境的 action spec，就像它没有批处理维度一样。
- add_module(name: str, module: Optional[Module]) None¶
向当前模块添加一个子模块。
可以使用给定的名称作为属性访问该模块。
- 参数:
name (str) – 子模块的名称。可以使用给定的名称从该模块访问子模块
module (Module) – 要添加到模块的子模块。
- add_truncated_keys()¶
向环境添加截断键。
- all_actions(tensordict: TensorDictBase | None = None) TensorDictBase¶
根据 action spec 生成所有可能的动作。
这仅适用于具有完全离散动作的环境。
- 参数:
tensordict (TensorDictBase, 可选) – 如果给定，则使用此 tensordict 调用
reset()。- 返回:
一个 tensordict 对象，其“action”条目已使用一批所有可能的动作进行更新。这些动作在 leading dimension 中堆叠在一起。
- append_transform(transform: Transform | Callable[[TensorDictBase], TensorDictBase]) EnvBase¶
返回一个转换后的环境，其中应用了传递的 callable/transform。
- 参数:
transform (Transform 或 Callable[[TensorDictBase], TensorDictBase]) – 应用于环境的 transform。
示例
>>> from torchrl.envs import GymEnv >>> import torch >>> env = GymEnv("CartPole-v1") >>> loc = 0.5 >>> scale = 1.0 >>> transform = lambda data: data.set("observation", (data.get("observation") - loc)/scale) >>> env = env.append_transform(transform=transform) >>> print(env) TransformedEnv( env=GymEnv(env=CartPole-v1, batch_size=torch.Size([]), device=cpu), transform=_CallableTransform(keys=[]))
- apply(fn: Callable[[Module], None]) T¶
递归地将
fn应用于每个子模块（由.children()返回）以及自身。典型用途包括初始化模型的参数（另请参阅 torch.nn.init）。
- 参数:
fn (
Module-> None) – 要应用于每个子模块的函数- 返回:
self
- 返回类型:
Module
示例
>>> @torch.no_grad() >>> def init_weights(m): >>> print(m) >>> if type(m) == nn.Linear: >>> m.weight.fill_(1.0) >>> print(m.weight) >>> net = nn.Sequential(nn.Linear(2, 2), nn.Linear(2, 2)) >>> net.apply(init_weights) Linear(in_features=2, out_features=2, bias=True) Parameter containing: tensor([[1., 1.], [1., 1.]], requires_grad=True) Linear(in_features=2, out_features=2, bias=True) Parameter containing: tensor([[1., 1.], [1., 1.]], requires_grad=True) Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) )
- auto_specs_(policy: Callable[[TensorDictBase], TensorDictBase], *, tensordict: TensorDictBase | None = None, action_key: NestedKey | list[NestedKey] = 'action', done_key: NestedKey | list[NestedKey] | None = None, observation_key: NestedKey | list[NestedKey] = 'observation', reward_key: NestedKey | list[NestedKey] = 'reward')¶
根据给定策略的随机 rollout 自动设置环境的规格 (specs)。
此方法使用提供的策略执行 rollout，以推断环境的输入和输出规格。它根据 rollout 期间收集的数据更新环境的 actions、observations、rewards 和 done signals 的 specs。
- 参数:
policy (Callable[[TensorDictBase], TensorDictBase]) – 一个 callable 策略，它接收 TensorDictBase 作为输入并返回 TensorDictBase 作为输出。此策略用于执行 rollout 并确定 specs。
- 关键字参数:
tensordict (TensorDictBase, 可选) – 一个可选的 TensorDictBase 实例，用作 rollout 的初始状态。如果未提供，将调用环境的 reset 方法以获取初始状态。
action_key (NestedKey 或 List[NestedKey], 可选) – 用于在 TensorDictBase 中标识 actions 的键。默认为“action”。
done_key (NestedKey 或 List[NestedKey], 可选) – 用于在 TensorDictBase 中标识 done signals 的键。默认为
None，这将尝试使用 ["done", "terminated", "truncated"] 作为潜在键。observation_key (NestedKey 或 List[NestedKey], 可选) – 用于在 TensorDictBase 中标识 observations 的键。默认为“observation”。
reward_key (NestedKey 或 List[NestedKey], 可选) – 用于在 TensorDictBase 中标识 rewards 的键。默认为“reward”。
- 返回:
具有更新的 specs 的环境实例。
- 返回类型:
- 引发:
RuntimeError – 如果输出 specs 中存在未在提供的键中说明的键。
- property batch_dims: int¶
环境的批处理维度数量。
- property batch_locked: bool¶
环境是否可以使用与其初始化时不同的批处理大小。
如果为 True，则环境需要与具有相同批处理大小的 tensordict 一起使用。batch_locked 是一个不可变属性。
- property batch_size: Size¶
此环境实例中以 torch.Size() 对象组织的批量环境数量。
环境可能相似或不同，但假定它们之间没有（或很少有）交互（例如，并行执行的多任务或批处理）。
- bfloat16() T¶
将所有浮点参数和缓冲区转换为
bfloat16数据类型。注意
此方法就地修改模块。
- 返回:
self
- 返回类型:
Module
- buffers(recurse: bool = True) Iterator[Tensor]¶
返回模块缓冲区的迭代器。
- 参数:
recurse (布尔值) – 如果为True，则会生成此模块及其所有子模块的缓冲区。否则，仅生成此模块的直接成员缓冲区。
- 生成:
torch.Tensor – 模块缓冲区
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for buf in model.buffers(): >>> print(type(buf), buf.size()) <class 'torch.Tensor'> (20L,) <class 'torch.Tensor'> (20L, 1L, 5L, 5L)
- cardinality(tensordict: TensorDictBase | None = None) int¶
动作空间的基数。
默认情况下，这只是
env.action_space.cardinality的一个包装器。当动作规范是可变的时，这个类很有用
动作数量可能未定义，例如
Categorical(n=-1)；动作基数可能取决于动作掩码；
形状可以是动态的，如
Unbound(shape=(-1))。
在这些情况下，应该覆盖
cardinality()方法，- 参数:
tensordict (TensorDictBase, 可选) – 包含计算基数所需数据的张量字典。
- check_env_specs(return_contiguous: bool | None = None, check_dtype=True, seed: int | None = None, tensordict: TensorDictBase | None = None)¶
根据短期 rollout 的结果测试环境规范。
此测试函数应用作对使用 torchrl 的 EnvBase 子类包装的环境进行健全性检查：预期数据与收集到的数据之间的任何差异都应引发断言错误。
损坏的环境规范可能会导致无法使用并行环境。
- 参数:
env (EnvBase) – 需要根据数据检查其规范的环境。
return_contiguous (布尔值, 可选) – 如果为 ``True``，则将以 return_contiguous=True 调用随机 rollout。在某些情况下（例如输入/输出形状异构）这将失败。默认为 ``None``（取决于是否存在动态规范）。
check_dtype (布尔值, 可选) – 如果为 False，将跳过 dtype 检查。默认为 True。
seed (整型, 可选) – 为了重现性，可以设置一个种子。种子将在 pytorch 中临时设置，然后 RNG 状态将恢复到之前的状态。对于环境，我们设置种子，但由于将 rng 状态恢复到之前并不是大多数环境的功能，因此我们将其留给用户完成。默认为 ``None``。
tensordict (TensorDict, 可选) – 用于重置的可选 TensorDict 实例。
注意：此函数会重置环境种子。应将其“离线”使用，以检查环境是否已充分构建，但它可能会影响实验的种子设置，因此应将其排除在训练脚本之外。
- compile(*args, **kwargs)¶
使用
torch.compile()编译此 Module 的 forward 方法。编译此 Module 的 __call__ 方法，所有参数按原样传递给
torch.compile()。有关此函数参数的详细信息，请参阅
torch.compile()。
- cpu() T¶
将所有模型参数和缓冲区移至 CPU。
注意
此方法就地修改模块。
- 返回:
self
- 返回类型:
Module
- cuda(device: Optional[Union[int, device]] = None) T¶
将所有模型参数和缓冲区移至 GPU。
这也会使相关的参数和缓冲区成为不同的对象。因此，如果模块在优化时驻留在 GPU 上，则应在构建优化器之前调用此方法。
注意
此方法就地修改模块。
- 参数:
device (整型, 可选) – 如果指定，所有参数将复制到该设备。
- 返回:
self
- 返回类型:
Module
- property done_key¶
环境的完成键。
默认情况下，这将是“done”。
如果环境中有多个完成键，此函数将引发异常。
- property done_keys: list[tensordict._nestedkey.NestedKey]¶
环境的完成键列表。
默认情况下，将只有一个名为“done”的键。
键按数据树中的深度排序。
- property done_keys_groups¶
一组完成键列表，按重置键分组。
这是一个列表的列表。外部列表的长度与重置键相同，内部列表包含可以读取以确定重置（当它不存在时）的完成键（例如，done 和 truncated）。
- property done_spec: TensorSpec¶
done规范。done_spec始终存储为复合规范。如果完成规范作为简单规范提供，将返回此项。
>>> env.done_spec = Categorical(2, dtype=torch.bool) >>> env.done_spec Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
如果完成规范作为复合规范提供且仅包含一个叶节点，此函数将仅返回该叶节点。
>>> env.done_spec = Composite({"nested": {"done": Categorical(2, dtype=torch.bool)}}) >>> env.done_spec Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
如果完成规范作为复合规范提供且包含多个叶节点，此函数将返回整个规范。
>>> env.done_spec = Composite({"nested": {"done": Categorical(2, dtype=torch.bool), "another_done": Categorical(2, dtype=torch.bool)}}) >>> env.done_spec Composite( nested: Composite( done: Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), another_done: Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
若要始终检索传递的完整规范，请使用
>>> env.output_spec["full_done_spec"]
此属性是可变的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.done_spec Categorical( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
- property done_spec_unbatched: TensorSpec¶
返回环境的完成规范，如同它没有批处理维度一样。
- double() T¶
将所有浮点参数和缓冲区转换为
double数据类型。注意
此方法就地修改模块。
- 返回:
self
- 返回类型:
Module
- empty_cache()¶
擦除所有缓存值。
对于常规环境，键列表（奖励、完成等）是缓存的，但在某些情况下，它们在代码执行期间可能会改变（例如，添加 transform 时）。
- eval() T¶
将模块设置为评估模式。
这仅对某些模块有效。有关特定模块在训练/评估模式下的行为详情，即它们是否受影响，请参阅相应模块的文档，例如
Dropout、BatchNorm等。这等同于
self.train(False)。请参阅 局部禁用梯度计算，了解 .eval() 与可能与其混淆的几种类似机制之间的比较。
- 返回:
self
- 返回类型:
Module
- extra_repr() str¶
返回模块的额外表示。
要打印自定义的额外信息，您应该在自己的模块中重新实现此方法。单行和多行字符串均可接受。
- fake_tensordict() TensorDictBase¶
返回一个伪张量字典，其键值对在形状、设备和数据类型上与环境 rollout 期间预期的一致。
- float() T¶
将所有浮点参数和缓冲区转换为
float数据类型。注意
此方法就地修改模块。
- 返回:
self
- 返回类型:
Module
- forward(*args, **kwargs)¶
定义每次调用时执行的计算。
应由所有子类覆盖。
注意
虽然 forward 传递的实现需要在该函数内部定义，但之后应该调用
Module实例而不是此函数，因为前者会负责运行注册的 hook，而后者会静默地忽略它们。
- property full_action_spec: Composite¶
完整动作规范。
full_action_spec是一个Composite`实例，包含所有动作条目。示例
>>> from torchrl.envs import BraxEnv >>> for envname in BraxEnv.available_envs: ... break >>> env = BraxEnv(envname) >>> env.full_action_spec Composite( action: BoundedContinuous( shape=torch.Size([8]), space=ContinuousBox( low=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([]))
property full_done_spec: Composite¶
完整完成规范。
示例
>>> import gymnasium >>> from torchrl.envs import GymWrapper >>> env = GymWrapper(gymnasium.make("Pendulum-v1")) >>> env.full_done_spec Composite( done: Categorical( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), truncated: Categorical( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), device=cpu, shape=torch.Size([]))
-
full_done_spec是一个Composite`实例，包含所有完成条目。它可用于生成结构上模仿运行时获得的数据的伪数据。 返回环境的完成规范，如同它没有批处理维度一样。
- property full_observation_spec_unbatched: Composite¶
返回环境的观察规范，如同它没有批处理维度一样。
property full_reward_spec: Composite¶
示例
>>> import gymnasium >>> from torchrl.envs import GymWrapper, TransformedEnv, RenameTransform >>> base_env = GymWrapper(gymnasium.make("Pendulum-v1")) >>> env = TransformedEnv(base_env, RenameTransform("reward", ("nested", "reward"))) >>> env.full_reward_spec Composite( nested: Composite( reward: UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=None, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- 完整奖励规范。
full_reward_spec是一个Composite`实例，包含所有奖励条目。
- property full_reward_spec_unbatched: Composite¶
返回环境的奖励规范，如同它没有批处理维度一样。
property full_state_spec: Composite¶
示例
>>> from torchrl.envs import BraxEnv >>> for envname in BraxEnv.available_envs: ... break >>> env = BraxEnv(envname) >>> env.full_state_spec Composite( state: Composite( pipeline_state: Composite( q: UnboundedContinuous( shape=torch.Size([15]), space=None, device=cpu, dtype=torch.float32, domain=continuous), [...], device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- 完整状态规范。
full_state_spec是一个Composite`实例，包含所有状态条目（即，非动作的输入数据）。
- property full_state_spec_unbatched: Composite¶
返回环境的状态规范，如同它没有批处理维度一样。
get_buffer(target: str) Tensor¶
- 参数:
如果
target指定的缓冲区存在，则返回它，否则抛出错误。- 返回:
有关此方法功能的更详细解释以及如何正确指定
target，请参阅get_submodule的文档字符串。- 返回类型:
target – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 ``get_submodule``。）
- 引发:
由
target引用的缓冲区
- torch.Tensor
AttributeError – 如果目标字符串引用了无效路径或解析为非缓冲区的对象。
get_extra_state() Any¶
返回要包含在模块 state_dict 中的任何额外状态。
- 返回:
如果需要存储额外状态，请为您的模块实现此方法以及相应的
set_extra_state()。构建模块的 state_dict() 时会调用此函数。- 返回类型:
请注意，额外状态应该是可 picklable 的，以确保 state_dict 的序列化正常工作。我们仅为序列化张量提供向后兼容性保证；如果其他对象的序列化 pickle 形式发生变化，可能会破坏向后兼容性。
- 要存储在模块 state_dict 中的任何额外状态
object
- torch.nn.Parameter
AttributeError – 如果目标字符串引用了无效路径或解析为非 ``nn.Parameter`` 的对象。
get_submodule(target: str) Module¶
A( (net_b): Module( (net_c): Module( (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2)) ) (linear): Linear(in_features=100, out_features=200, bias=True) ) )如果
target指定的子模块存在，则返回它，否则抛出错误。例如，假设您有一个
nn.ModuleA，它看起来像这样：（该图显示了一个
nn.ModuleA。A包含一个嵌套子模块net_b，net_b本身有两个子模块net_c和linear。然后net_c包含一个子模块conv。）- 参数:
要检查是否存在
linear子模块，我们可以调用get_submodule("net_b.linear")。要检查是否存在conv子模块，我们可以调用get_submodule("net_b.net_c.conv")。- 返回:
get_submodule的运行时受target中模块嵌套程度的限制。查询named_modules也能达到相同的效果，但其复杂度为 O(N)（N 为传递性模块的数量）。因此，对于检查是否存在某个子模块的简单场景，应始终使用get_submodule。- 返回类型:
- 引发:
由
target引用的子模块
- torch.nn.Module
AttributeError – 如果目标字符串引用了无效路径或解析为非 ``nn.Module`` 的对象。
注意
此方法就地修改模块。
- 返回:
self
- 返回类型:
Module
- half() T¶
将所有浮点参数和缓冲区转换为
half数据类型。property input_spec: TensorSpec¶
输入规范。
包含所有输入到环境的数据规范的复合规范。
它包含
“full_action_spec”：输入动作的规范
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.input_spec Composite( full_state_spec: None, full_action_spec: Composite( action: BoundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- “full_state_spec”：所有其他环境输入的规范
此属性被锁定且应为只读。相反，要设置其中包含的规范，请使用相应的属性。
- property input_spec_unbatched: Composite¶
返回环境的输入规范，如同它没有批处理维度一样。
ipu(device: Optional[Union[int, device]] = None) T¶
注意
此方法就地修改模块。
- 参数:
device (整型, 可选) – 如果指定，所有参数将复制到该设备。
- 返回:
self
- 返回类型:
Module
- 将所有模型参数和缓冲区移至 IPU。
这也会使相关的参数和缓冲区成为不同的对象。因此，如果模块在优化时驻留在 IPU 上，则应在构建优化器之前调用此方法。
property is_spec_locked¶
- 返回:
获取环境规范是否被锁定。
- 返回类型:
此属性可以直接修改。
如果规范被锁定则为 True，否则为 False。
bool.
- 另请参阅
锁定环境规范
load_state_dict(*args, **kwargs)[source]¶
警告
如果
assign为True，则优化器必须在调用load_state_dict之后创建，除非get_swap_module_params_on_conversion()为True。- 参数:
state_dict (dict) – 包含参数和持久缓冲区的字典。
strict (bool, 可选) – 是否严格要求
state_dict中的键与本模块的state_dict()函数返回的键匹配。默认值:Trueassign (bool, 可选) – 当设为
False时，保留当前模块中张量的属性；当设为True时，保留状态字典中张量的属性。唯一的例外是requires_grad字段。默认值: ``False``
- 返回:
- missing_keys 是一个字符串列表，包含本模块预期但缺失的
在提供的
state_dict中的键。
- unexpected_keys 是一个字符串列表，包含本模块不预期
但在提供的
state_dict中存在的键。
- 返回类型:
带有
missing_keys和unexpected_keys字段的NamedTuple
注意
如果参数或缓冲区注册为
None且其对应的键存在于state_dict中，则load_state_dict()将引发RuntimeError。
- maybe_reset(tensordict: TensorDictBase) TensorDictBase¶
检查输入 tensordict 的 done 键，并在必要时重置已完成的环境。
- 参数:
tensordict (TensorDictBase) – 来自
step_mdp()输出的 tensordict。- 返回:
一个 tensordict，对于未重置的环境，其内容与输入相同；对于已重置的环境，则包含新的重置数据。
- modules() Iterator[Module]¶
返回网络中所有模块的迭代器。
- 生成:
Module – 网络中的一个模块
注意
重复的模块只返回一次。在以下示例中，
l只会返回一次。示例
>>> l = nn.Linear(2, 2) >>> net = nn.Sequential(l, l) >>> for idx, m in enumerate(net.modules()): ... print(idx, '->', m) 0 -> Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) ) 1 -> Linear(in_features=2, out_features=2, bias=True)
- mtia(device: Optional[Union[int, device]] = None) T¶
将所有模型参数和缓冲区移动到 MTIA。
这也会使得关联的参数和缓冲区成为不同的对象。因此，如果模块在优化时将驻留在 MTIA 上，则应在构建优化器之前调用此方法。
注意
此方法就地修改模块。
- 参数:
device (整型, 可选) – 如果指定，所有参数将复制到该设备。
- 返回:
self
- 返回类型:
Module
- named_buffers(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) Iterator[Tuple[str, Tensor]]¶
返回模块缓冲区的迭代器，产生缓冲区的名称及其本身。
- 参数:
prefix (str) – 要添加到所有缓冲区名称前的字符串前缀。
recurse (bool, 可选) – 如果为 True，则产生此模块及其所有子模块的缓冲区。否则，仅产生此模块的直接成员缓冲区。默认值为 True。
remove_duplicate (bool, 可选) – 是否移除结果中的重复缓冲区。默认值为 True。
- 生成:
(str, torch.Tensor) – 包含名称和缓冲区的元组。
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for name, buf in self.named_buffers(): >>> if name in ['running_var']: >>> print(buf.size())
- named_children() Iterator[Tuple[str, Module]]¶
返回直接子模块的迭代器，产生模块的名称及其本身。
- 生成:
(str, Module) – 包含名称和子模块的元组。
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for name, module in model.named_children(): >>> if name in ['conv4', 'conv5']: >>> print(module)
- named_modules(memo: Optional[Set[Module]] = None, prefix: str = '', remove_duplicate: bool = True)¶
返回网络中所有模块的迭代器，产生模块的名称及其本身。
- 参数:
memo – 一个备忘录，用于存储已添加到结果中的模块集合。
prefix – 将添加到模块名称前的字符串前缀。
remove_duplicate – 是否移除结果中的重复模块实例。
- 生成:
(str, Module) – 名称和模块的元组。
注意
重复的模块只返回一次。在以下示例中，
l只会返回一次。示例
>>> l = nn.Linear(2, 2) >>> net = nn.Sequential(l, l) >>> for idx, m in enumerate(net.named_modules()): ... print(idx, '->', m) 0 -> ('', Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) )) 1 -> ('0', Linear(in_features=2, out_features=2, bias=True))
- named_parameters(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) Iterator[Tuple[str, Parameter]]¶
返回模块参数的迭代器，产生参数的名称及其本身。
- 参数:
prefix (str) – 要添加到所有参数名称前的字符串前缀。
recurse (bool) – 如果为 True，则产生此模块及其所有子模块的参数。否则，仅产生此模块的直接成员参数。
remove_duplicate (bool, 可选) – 是否移除结果中的重复参数。默认值为 True。
- 生成:
(str, Parameter) – 包含名称和参数的元组。
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for name, param in self.named_parameters(): >>> if name in ['bias']: >>> print(param.size())
- property observation_keys: list[tensordict._nestedkey.NestedKey]¶
环境的观测键。
默认情况下，只有一个名为 “observation” 的键。
键按数据树中的深度排序。
- property observation_spec: Composite¶
观测规范。
必须是一个
torchrl.data.Composite实例。规范中列出的键在 reset 和 step 后可直接访问。在 TorchRL 中，即使它们严格来说不是“观测”，环境输出的所有信息、状态、转换结果等都存储在
observation_spec中。因此，
"observation_spec"应被视为一个通用的数据容器，用于存储非 done 或 reward 数据的环境输出。示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.observation_spec Composite( observation: BoundedContinuous( shape=torch.Size([3]), space=ContinuousBox( low=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([]))
- property output_spec: TensorSpec¶
输出规范。
包含环境输出的所有数据规范的组合规范。
输入规范。
“full_reward_spec”: 奖励规范
“full_done_spec”: 完成规范
“full_observation_spec”: 所有其他环境输出的规范
“full_action_spec”：输入动作的规范
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.output_spec Composite( full_reward_spec: Composite( reward: UnboundedContinuous( shape=torch.Size([1]), space=None, device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([])), full_observation_spec: Composite( observation: BoundedContinuous( shape=torch.Size([3]), space=ContinuousBox( low=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([])), full_done_spec: Composite( done: Categorical( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- parameters(recurse: bool = True) Iterator[Parameter]¶
返回模块参数的迭代器。
这通常传递给优化器。
- 参数:
recurse (bool) – 如果为 True，则产生此模块及其所有子模块的参数。否则，仅产生此模块的直接成员参数。
- 生成:
Parameter – 模块参数。
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for param in model.parameters(): >>> print(type(param), param.size()) <class 'torch.Tensor'> (20L,) <class 'torch.Tensor'> (20L, 1L, 5L, 5L)
- rand_action(tensordict: TensorDictBase | None = None)¶
根据 action_spec 属性执行随机动作。
- 参数:
tensordict (TensorDictBase, 可选) – 结果动作应写入的 tensordict。
- 返回:
一个 tensordict 对象，其 “action” 条目已更新为 action-spec 中的随机样本。
- rand_step(tensordict: TensorDictBase | None = None) TensorDictBase¶
根据 action_spec 属性在环境中执行随机步骤。
- 参数:
tensordict (TensorDictBase, 可选) – 结果信息应写入的 tensordict。
- 返回:
一个 tensordict 对象，包含在环境中随机步骤后的新观测。动作将使用 “action” 键存储。
- register_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor], Union[None, Tuple[Tensor, ...], Tensor]]) RemovableHandle¶
在模块上注册一个反向钩子。
此函数已被弃用，推荐使用
register_full_backward_hook()，并且此函数的行为将在未来版本中改变。- 返回:
一个句柄，可以通过调用
handle.remove()来移除添加的钩子。- 返回类型:
torch.utils.hooks.RemovableHandle
- register_buffer(name: str, tensor: Optional[Tensor], persistent: bool = True) None¶
向模块添加一个缓冲区。
这通常用于注册不应被视为模型参数的缓冲区。例如，BatchNorm 的
running_mean不是参数，但它是模块状态的一部分。缓冲区默认是持久的，并将与参数一起保存。通过将persistent设置为False可以改变此行为。持久缓冲区和非持久缓冲区之间的唯一区别在于后者不会成为本模块的state_dict的一部分。缓冲区可以使用给定的名称作为属性进行访问。
- 参数:
name (str) – 缓冲区的名称。可以使用给定的名称从此模块访问缓冲区。
tensor (Tensor 或 None) – 要注册的缓冲区。如果为
None，则对缓冲区进行的操作（例如cuda）将被忽略。如果为None，缓冲区将**不**包含在模块的state_dict中。persistent (bool) – 缓冲区是否是本模块
state_dict的一部分。
示例
>>> # xdoctest: +SKIP("undefined vars") >>> self.register_buffer('running_mean', torch.zeros(num_features))
- register_forward_hook(hook: Union[Callable[[T, Tuple[Any, ...], Any], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any], Any], Optional[Any]]], *, prepend: bool = False, with_kwargs: bool = False, always_call: bool = False) RemovableHandle¶
在模块上注册一个前向钩子。
每次
forward()计算输出后，都会调用该钩子。如果
with_kwargs为False或未指定，输入仅包含传递给模块的位置参数。关键字参数不会传递给钩子，只会传递给forward。钩子可以修改输出。它可以原地修改输入，但不会对 forward 产生影响，因为此方法在forward()调用后被调用。钩子应具有以下签名：hook(module, args, output) -> None or modified output
如果
with_kwargs为True，则前向钩子将接收传递给 forward 函数的kwargs，并且预期返回可能已修改的输出。钩子应具有以下签名：hook(module, args, kwargs, output) -> None or modified output
- 参数:
hook (Callable) – 要注册的用户定义钩子。
prepend (bool) – 如果为
True，则提供的hook将在此torch.nn.modules.Module上的所有现有forward钩子之前触发。否则，提供的hook将在此torch.nn.modules.Module上的所有现有forward钩子之后触发。注意，使用register_module_forward_hook()注册的全局forward钩子将在通过此方法注册的所有钩子之前触发。默认值:Falsewith_kwargs (bool) – 如果为
True，将向hook传递传递给 forward 函数的 kwargs。默认值:Falsealways_call (bool) – 如果为
True，无论调用模块时是否引发异常，都将运行hook。默认值:False
- 返回:
一个句柄，可以通过调用
handle.remove()来移除添加的钩子。- 返回类型:
torch.utils.hooks.RemovableHandle
- register_forward_pre_hook(hook: Union[Callable[[T, Tuple[Any, ...]], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any]], Optional[Tuple[Any, Dict[str, Any]]]]], *, prepend: bool = False, with_kwargs: bool = False) RemovableHandle¶
在模块上注册一个前向预钩子。
该钩子将在每次调用
forward()方法之前被执行。如果
with_kwargs为 False 或未指定，输入只包含传递给模块的位置参数。关键字参数不会传递给钩子，只会传递给forward方法。钩子可以修改输入。用户可以在钩子中返回一个元组或单个修改后的值。如果返回单个值，我们将将其包装成一个元组（除非该值本身已是元组）。钩子应具有以下签名：hook(module, args) -> None or modified input
如果
with_kwargs为 True，前向预钩子将被传递给前向函数提供的关键字参数。如果钩子修改了输入，则应同时返回位置参数和关键字参数。钩子应具有以下签名：hook(module, args, kwargs) -> None or a tuple of modified input and kwargs
- 参数:
hook (Callable) – 要注册的用户定义钩子。
prepend (布尔类型) – 如果为 True，提供的
hook将在此torch.nn.modules.Module上的所有现有forward_pre钩子之前触发。否则，提供的hook将在此torch.nn.modules.Module上的所有现有forward_pre钩子之后触发。请注意，通过register_module_forward_pre_hook()注册的全局forward_pre钩子将在通过此方法注册的所有钩子之前触发。默认值：Falsewith_kwargs (布尔类型) – 如果为 True，
hook将被传递前向函数提供的关键字参数。默认值：False
- 返回:
一个句柄，可以通过调用
handle.remove()来移除添加的钩子。- 返回类型:
torch.utils.hooks.RemovableHandle
- register_full_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) RemovableHandle¶
在模块上注册一个反向钩子。
该钩子将在每次计算模块的梯度时被调用，即当且仅当计算模块输出的梯度时，钩子才会执行。钩子应具有以下签名：
hook(module, grad_input, grad_output) -> tuple(Tensor) or None
grad_input和grad_output是元组，分别包含与输入和输出相关的梯度。钩子不应修改其参数，但可以选择返回一个与输入相关的新梯度，该梯度将代替grad_input用于后续计算。grad_input只对应于作为位置参数提供的输入，所有关键字参数都会被忽略。grad_output中的条目对于所有非 Tensor 参数都将是None。出于技术原因，当将此钩子应用于模块时，其前向函数将接收传递给模块的每个 Tensor 的视图。类似地，调用者将接收模块前向函数返回的每个 Tensor 的视图。
警告
使用反向传播钩子时，不允许原地修改输入或输出，否则将引发错误。
- 参数:
hook (可调用对象) – 要注册的用户定义的钩子。
prepend (布尔类型) – 如果为 True，提供的
hook将在此torch.nn.modules.Module上的所有现有backward钩子之前触发。否则，提供的hook将在此torch.nn.modules.Module上的所有现有backward钩子之后触发。请注意，通过register_module_full_backward_hook()注册的全局backward钩子将在通过此方法注册的所有钩子之前触发。
- 返回:
一个句柄，可以通过调用
handle.remove()来移除添加的钩子。- 返回类型:
torch.utils.hooks.RemovableHandle
- register_full_backward_pre_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) RemovableHandle¶
在模块上注册一个反向传播预钩子。
该钩子将在每次计算模块的梯度时被调用。钩子应具有以下签名：
hook(module, grad_output) -> tuple[Tensor] or None
grad_output是一个元组。钩子不应修改其参数，但可以选择返回一个与输出相关的新梯度，该梯度将代替grad_output用于后续计算。grad_output中的条目对于所有非 Tensor 参数都将是None。出于技术原因，当将此钩子应用于模块时，其前向函数将接收传递给模块的每个 Tensor 的视图。类似地，调用者将接收模块前向函数返回的每个 Tensor 的视图。
警告
使用反向传播钩子时，不允许原地修改输入，否则将引发错误。
- 参数:
hook (可调用对象) – 要注册的用户定义的钩子。
prepend (布尔类型) – 如果为 True，提供的
hook将在此torch.nn.modules.Module上的所有现有backward_pre钩子之前触发。否则，提供的hook将在此torch.nn.modules.Module上的所有现有backward_pre钩子之后触发。请注意，通过register_module_full_backward_pre_hook()注册的全局backward_pre钩子将在通过此方法注册的所有钩子之前触发。
- 返回:
一个句柄，可以通过调用
handle.remove()来移除添加的钩子。- 返回类型:
torch.utils.hooks.RemovableHandle
- classmethod register_gym(id: str, *, entry_point: Callable | None = None, transform: Transform | None = None, info_keys: list[NestedKey] | None = None, backend: str = None, to_numpy: bool = False, reward_threshold: float | None = None, nondeterministic: bool = False, max_episode_steps: int | None = None, order_enforce: bool = True, autoreset: bool = False, disable_env_checker: bool = False, apply_api_compatibility: bool = False, **kwargs)¶
在 gym(nasium) 中注册一个环境。
此方法旨在考虑以下应用范围：
将 TorchRL 优先的环境集成到使用 Gym 的框架中；
将其他环境（例如 DeepMind Control, Brax, Jumanji 等）集成到使用 Gym 的框架中。
- 参数:
id (字符串类型) – 环境的名称。应遵循 gym 命名约定。
- 关键字参数:
entry_point (可调用对象, 可选) – 构建环境的入口点。
如果没有传递，则将使用父类作为入口点。通常，这用于注册不一定继承自所用基类的环境。
>>> from torchrl.envs import DMControlEnv >>> DMControlEnv.register_gym("DMC-cheetah-v0", env_name="cheetah", task="run") >>> # equivalently >>> EnvBase.register_gym("DMC-cheetah-v0", entry_point=DMControlEnv, env_name="cheetah", task="run")
transform (torchrl.envs.Transform) – 要与环境一起使用的变换（或
torchrl.envs.Compose实例中的变换列表）。此参数可以在调用make()时传递（参见下例）。info_keys (列表[NestedKey], 可选) – 如果提供，这些键将用于构建 info 字典，并会从观察键中排除。
此参数可以在调用
make()时传递（参见下例）。警告
可能出现的情况是，使用
info_keys会使得规范（spec）变空，因为内容已移至 info 字典。Gym 不喜欢规范中的空Dict，因此应使用RemoveEmptySpecs移除此空内容。backend (字符串类型, 可选) – 后端。可以是 “gym” 或 “gymnasium” 或任何其他与
set_gym_backend兼容的后端。to_numpy (布尔类型, 可选) – 如果为
True，调用 step 和 reset 的结果将被映射到 numpy 数组。默认为False（结果是 tensor）。此参数可以在调用make()时传递（参见下例）。reward_threshold (
浮点类型, optional) – [Gym 关键字参数] 被认为已学会一个环境的奖励阈值。nondeterministic (布尔类型, 可选) – [Gym 关键字参数] 如果环境是非确定性的（即使知道初始种子和所有动作）。默认为
False。max_episode_steps (整数类型, 可选) – [Gym 关键字参数] 截断前的最大情节步数。由 Time Limit 包装器使用。
order_enforce (布尔类型, 可选) – [Gym 版本 >= 0.14] 是否应应用顺序强制包装器，以确保用户按正确顺序运行函数。默认为
True。autoreset (布尔类型, 可选) – [Gym 版本 >= 0.14] 是否应添加自动重置包装器，以便无需调用 reset。默认为
False。disable_env_checker – [Gym 版本 >= 0.14] 是否应对环境禁用环境检查器。默认为
False。apply_api_compatibility – [Gym 版本 >= 0.26] 是否应用 StepAPICompatibility 包装器。默认为
False。\*\*kwargs – 传递给环境构造函数的任意关键字参数。
注意
TorchRL 的环境没有“info”字典的概念，因为
TensorDict提供了大多数训练设置中所有被认为必要的存储需求。不过，您可以使用info_keys参数来细粒度地控制哪些被视为观察，哪些应被视为 info。示例
>>> # Register the "cheetah" env from DMControl with the "run" task >>> from torchrl.envs import DMControlEnv >>> import torch >>> DMControlEnv.register_gym("DMC-cheetah-v0", to_numpy=False, backend="gym", env_name="cheetah", task_name="run") >>> import gym >>> envgym = gym.make("DMC-cheetah-v0") >>> envgym.seed(0) >>> torch.manual_seed(0) >>> envgym.reset() ({'position': tensor([-0.0855, 0.0215, -0.0881, -0.0412, -0.1101, 0.0080, 0.0254, 0.0424], dtype=torch.float64), 'velocity': tensor([ 1.9609e-02, -1.9776e-04, -1.6347e-03, 3.3842e-02, 2.5338e-02, 3.3064e-02, 1.0381e-04, 7.6656e-05, 1.0204e-02], dtype=torch.float64)}, {}) >>> envgym.step(envgym.action_space.sample()) ({'position': tensor([-0.0833, 0.0275, -0.0612, -0.0770, -0.1256, 0.0082, 0.0186, 0.0476], dtype=torch.float64), 'velocity': tensor([ 0.2221, 0.2256, 0.5930, 2.6937, -3.5865, -1.5479, 0.0187, -0.6825, 0.5224], dtype=torch.float64)}, tensor([0.0018], dtype=torch.float64), tensor([False]), tensor([False]), {}) >>> # same environment with observation stacked >>> from torchrl.envs import CatTensors >>> envgym = gym.make("DMC-cheetah-v0", transform=CatTensors(in_keys=["position", "velocity"], out_key="observation")) >>> envgym.reset() ({'observation': tensor([-0.1005, 0.0335, -0.0268, 0.0133, -0.0627, 0.0074, -0.0488, -0.0353, -0.0075, -0.0069, 0.0098, -0.0058, 0.0033, -0.0157, -0.0004, -0.0381, -0.0452], dtype=torch.float64)}, {}) >>> # same environment with numpy observations >>> envgym = gym.make("DMC-cheetah-v0", transform=CatTensors(in_keys=["position", "velocity"], out_key="observation"), to_numpy=True) >>> envgym.reset() ({'observation': array([-0.11355747, 0.04257728, 0.00408397, 0.04155852, -0.0389733 , -0.01409826, -0.0978704 , -0.08808327, 0.03970837, 0.00535434, -0.02353762, 0.05116226, 0.02788907, 0.06848346, 0.05154399, 0.0371798 , 0.05128025])}, {}) >>> # If gymnasium is installed, we can register the environment there too. >>> DMControlEnv.register_gym("DMC-cheetah-v0", to_numpy=False, backend="gymnasium", env_name="cheetah", task_name="run") >>> import gymnasium >>> envgym = gymnasium.make("DMC-cheetah-v0") >>> envgym.seed(0) >>> torch.manual_seed(0) >>> envgym.reset() ({'position': tensor([-0.0855, 0.0215, -0.0881, -0.0412, -0.1101, 0.0080, 0.0254, 0.0424], dtype=torch.float64), 'velocity': tensor([ 1.9609e-02, -1.9776e-04, -1.6347e-03, 3.3842e-02, 2.5338e-02, 3.3064e-02, 1.0381e-04, 7.6656e-05, 1.0204e-02], dtype=torch.float64)}, {})
注意
此功能也适用于无状态环境（例如
BraxEnv）。>>> import gymnasium >>> import torch >>> from tensordict import TensorDict >>> from torchrl.envs import BraxEnv, SelectTransform >>> >>> # get action for dydactic purposes >>> env = BraxEnv("ant", batch_size=[2]) >>> env.set_seed(0) >>> torch.manual_seed(0) >>> td = env.rollout(10) >>> >>> actions = td.get("action") >>> >>> # register env >>> env.register_gym("Brax-Ant-v0", env_name="ant", batch_size=[2], info_keys=["state"]) >>> gym_env = gymnasium.make("Brax-Ant-v0") >>> gym_env.seed(0) >>> torch.manual_seed(0) >>> >>> gym_env.reset() >>> obs = [] >>> for i in range(10): ... obs, reward, terminated, truncated, info = gym_env.step(td[..., i].get("action"))
- register_load_state_dict_post_hook(hook)¶
注册一个后钩子，该钩子将在模块的
load_state_dict()方法被调用后运行。- 它应具有以下签名：
hook(module, incompatible_keys) -> None
module参数是注册此钩子的当前模块，而incompatible_keys参数是一个NamedTuple，包含属性missing_keys和unexpected_keys。missing_keys是一个包含缺失键的list（列表），unexpected_keys是一个包含意外键的list（列表）。给定的
incompatible_keys如果需要，可以原地修改。请注意，调用
load_state_dict()并设置strict=True时执行的检查会受到钩子对missing_keys或unexpected_keys所做修改的影响，如预期。向任一键集合添加条目都会在strict=True时导致抛出错误，而清空所有缺失和意外键则会避免错误。- 返回:
一个句柄，可以通过调用
handle.remove()来移除添加的钩子。- 返回类型:
torch.utils.hooks.RemovableHandle
- register_load_state_dict_pre_hook(hook)¶
注册一个预钩子，该钩子将在模块的
load_state_dict()方法被调用前运行。- 它应具有以下签名：
hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950
- 参数:
hook (可调用对象) – 在加载状态字典之前将被调用的可调用钩子。
- register_module(name: str, module: Optional[Module]) None¶
add_module()的别名。
- register_parameter(name: str, param: Optional[Parameter]) None¶
向模块添加一个参数。
可以使用给定名称作为属性来访问该参数。
- 参数:
name (字符串类型) – 参数的名称。可以使用给定名称从该模块访问该参数。
param (Parameter 或 None) – 要添加到模块的参数。如果为
None，则在参数上运行的操作（例如cuda）将被忽略。如果为None，该参数**不会**包含在模块的state_dict中。
- register_state_dict_post_hook(hook)¶
为
state_dict()方法注册一个后钩子。- 它应具有以下签名：
hook(module, state_dict, prefix, local_metadata) -> None
注册的钩子可以原地修改
state_dict。
- register_state_dict_pre_hook(hook)¶
注册一个用于
state_dict()方法的预钩子（pre-hook）。- 它应具有以下签名：
hook(module, prefix, keep_vars) -> None
注册的钩子可以在调用
state_dict之前用于执行预处理。
- requires_grad_(requires_grad: bool = True) T¶
更改 autograd 是否应在此模块中的参数上记录操作。
此方法会原地设置参数的
requires_grad属性。此方法有助于在微调时冻结模块的一部分，或单独训练模型的某些部分（例如，GAN 训练）。
请参阅 局部禁用梯度计算，了解 .requires_grad_() 和与其可能混淆的几个类似机制的比较。
- 参数:
requires_grad (bool) – autograd 是否应在此模块中的参数上记录操作。默认值：
True。- 返回:
self
- 返回类型:
Module
- reset(tensordict: TensorDictBase | None = None, **kwargs) TensorDictBase¶
重置环境。
与 step 和 _step 类似，只有私有方法
_reset应该被 EnvBase 子类覆盖。- 参数:
tensordict (TensorDictBase, 可选的) – 用于包含生成的新观测值的 tensordict。在某些情况下，此输入也可用于向 reset 函数传递参数。
kwargs (可选的) – 要传递给原生 reset 函数的其他参数。
- 返回:
一个 tensordict（如果提供了输入 tensordict，则是该 tensordict），会用生成的观测值进行原地修改。
注意
reset 不应被
EnvBase子类覆盖。要修改的方法是_reset()。
- property reset_keys: list[tensordict._nestedkey.NestedKey]¶
返回 reset 键的列表。
Reset 键是表示部分 reset 的键，用于批处理、多任务或多智能体设置。它们的结构是
(*prefix, "_reset")，其中prefix是一个（可能为空的）字符串元组，指向 tensordict 中可以找到 done 状态的位置。键按数据树中的深度排序。
- property reward_key¶
环境的奖励键。
默认情况下，这将是 “reward”。
如果环境中存在多个奖励键，此函数将引发异常。
- property reward_keys: list[tensordict._nestedkey.NestedKey]¶
环境的奖励键列表。
默认情况下，将只有一个名为 “reward” 的键。
键按数据树中的深度排序。
- property reward_spec: TensorSpec¶
reward规格。reward_spec始终存储为复合规格。如果 reward 规格作为简单规格提供，将返回此规格。
>>> env.reward_spec = Unbounded(1) >>> env.reward_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果 reward 规格作为复合规格提供且仅包含一个叶节点，此函数将仅返回该叶节点。
>>> env.reward_spec = Composite({"nested": {"reward": Unbounded(1)}}) >>> env.reward_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果 reward 规格作为复合规格提供且包含多个叶节点，此函数将返回整个规格。
>>> env.reward_spec = Composite({"nested": {"reward": Unbounded(1), "another_reward": Categorical(1)}}) >>> env.reward_spec Composite( nested: Composite( reward: UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), another_reward: Categorical( shape=torch.Size([]), space=DiscreteBox(n=1), device=cpu, dtype=torch.int64, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
要检索传递的完整 spec，请使用
>>> env.output_spec["full_reward_spec"]
此属性是可变的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.reward_spec UnboundedContinuous( shape=torch.Size([1]), space=None, device=cpu, dtype=torch.float32, domain=continuous)
- property reward_spec_unbatched: TensorSpec¶
full_reward_spec是一个Composite`实例，包含所有奖励条目。
- rollout(max_steps: int, policy: Callable[[TensorDictBase], TensorDictBase] | None = None, callback: Callable[[TensorDictBase, ...], Any] | None = None, *, auto_reset: bool = True, auto_cast_to_device: bool = False, break_when_any_done: bool | None = None, break_when_all_done: bool | None = None, return_contiguous: bool | None = False, tensordict: TensorDictBase | None = None, set_truncated: bool = False, out=None, trust_policy: bool =False) TensorDictBase¶
在环境中执行一次 rollout。
一旦包含的任一环境达到任一 done 状态，函数将立即返回。
- 参数:
max_steps (int) – 要执行的最大步数。如果环境在达到 max_steps 之前达到 done 状态，实际步数可能会更少。
policy (callable, 可选的) – 用于计算所需动作的可调用对象。如果未提供策略，将使用
env.rand_step()调用动作。策略可以是任何可调用对象，它可以读取 tensordict 或__按照__env.observation_spec.keys()排序的整个观测值条目序列。默认为 None。callback (Callable[[TensorDict], Any], 可选的) – 在每次迭代中调用并传入给定 TensorDict 的函数。默认为
None。不会收集callback的输出，如果数据需要在调用rollout之后继续使用，用户需负责在 callback 调用中保存任何结果。
- 关键字参数:
auto_reset (bool, 可选的) – 如果为
True，包含的环境将在开始 rollout 之前重置。如果为False，rollout 将从先前的状态继续，这需要传递包含先前 rollout 状态的tensordict参数。默认值为True。auto_cast_to_device (bool, 可选的) – 如果为
True，tensordict 的设备将在使用策略之前自动转换为策略的设备。默认值为False。break_when_any_done (bool) – 如果为
True，则当包含的任一环境达到任一 done 状态时中断。如果为False，则已完成的环境会自动重置。默认值为True。break_when_all_done (bool, 可选的) – 如果为
True，则当所有包含的环境都达到任一 done 状态时中断。如果为False，则当至少一个环境达到任一 done 状态时中断。默认值为False。return_contiguous (bool) – 如果为 False，将返回一个 LazyStackedTensorDict。如果环境没有动态规格，默认值为 True，否则为 False。
tensordict (TensorDict, 可选的) – 如果
auto_reset为 False，必须提供一个初始 tensordict。Rollout 将检查该 tensordict 是否有 done 标志，并在这些维度上重置环境（如果需要）。如果tensordict是 reset 的输出，通常不会发生这种情况，但如果tensordict是先前 rollout 的最后一步，则可能发生。如果需要向reset方法传递元数据（例如无状态环境的 batch-size 或设备），在auto_reset=True时也可以提供一个tensordict。set_truncated (bool, 可选的) – 如果为
True，在 rollout 完成后，"truncated"和"done"键将被设置为True。如果在done_spec中找不到"truncated"，则引发异常。Truncated 键可以通过env.add_truncated_keys设置。默认值为False。trust_policy (bool, 可选的) – 如果为
True，则非 TensorDictModule 策略将被视为与 collector 兼容。对于 CudaGraphModules，默认为True，否则为False。
- 返回:
包含生成轨迹的 TensorDict 对象。
返回的数据的 tensordict 的最后一个维度（位于
env.ndim索引处）将标记为 “time” 维度名称。rollout非常方便显示环境的数据结构。示例
>>> # Using rollout without a policy >>> from torchrl.envs.libs.gym import GymEnv >>> from torchrl.envs.transforms import TransformedEnv, StepCounter >>> env = TransformedEnv(GymEnv("Pendulum-v1"), StepCounter(max_steps=20)) >>> rollout = env.rollout(max_steps=1000) >>> print(rollout) TensorDict( fields={ action: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([20, 3]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([20]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([20, 3]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([20]), device=cpu, is_shared=False) >>> print(rollout.names) ['time'] >>> # with envs that contain more dimensions >>> from torchrl.envs import SerialEnv >>> env = SerialEnv(3, lambda: TransformedEnv(GymEnv("Pendulum-v1"), StepCounter(max_steps=20))) >>> rollout = env.rollout(max_steps=1000) >>> print(rollout) TensorDict( fields={ action: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([3, 20, 3]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 20]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([3, 20, 3]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 20]), device=cpu, is_shared=False) >>> print(rollout.names) [None, 'time']
使用策略（常规的
Module或TensorDictModule）也非常容易示例
>>> from torch import nn >>> env = GymEnv("CartPole-v1", categorical_action_encoding=True) >>> class ArgMaxModule(nn.Module): ... def forward(self, values): ... return values.argmax(-1) >>> n_obs = env.observation_spec["observation"].shape[-1] >>> n_act = env.action_spec.n >>> # A deterministic policy >>> policy = nn.Sequential( ... nn.Linear(n_obs, n_act), ... ArgMaxModule()) >>> env.rollout(max_steps=10, policy=policy) TensorDict( fields={ action: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.int64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False) >>> # Under the hood, rollout will wrap the policy in a TensorDictModule >>> # To speed things up we can do that ourselves >>> from tensordict.nn import TensorDictModule >>> policy = TensorDictModule(policy, in_keys=list(env.observation_spec.keys()), out_keys=["action"]) >>> env.rollout(max_steps=10, policy=policy) TensorDict( fields={ action: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.int64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False)
在某些情况下，无法获得 contiguous tensordict，因为它们无法堆叠。这可能发生在每一步返回的数据具有不同形状时，或者同时执行不同环境时。在这种情况下，
return_contiguous=False将使返回的 tensordict 成为 tensordict 的惰性堆叠。- 非 contiguous rollout 的示例
>>> rollout = env.rollout(4, return_contiguous=False) >>> print(rollout) LazyStackedTensorDict( fields={ action: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: LazyStackedTensorDict( fields={ done: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([3, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 4]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([3, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 4]), device=cpu, is_shared=False) >>> print(rollout.names) [None, 'time']
Rollout 可以在循环中用于模拟数据收集。为此，您需要在对从先前 rollout 获得的最后一个 tensordict 调用
step_mdp()后，将其作为输入传递。- 数据收集 rollout 的示例
>>> from torchrl.envs import GymEnv, step_mdp >>> env = GymEnv("CartPole-v1") >>> epochs = 10 >>> input_td = env.reset() >>> for i in range(epochs): ... rollout_td = env.rollout( ... max_steps=100, ... break_when_any_done=False, ... auto_reset=False, ... tensordict=input_td, ... ) ... input_td = step_mdp( ... rollout_td[..., -1], ... )
- set_extra_state(state: Any) None¶
设置加载的 state_dict 中包含的额外状态。
此函数由
load_state_dict()调用，用于处理在 state_dict 中找到的任何额外状态。如果需要在模块的 state_dict 中存储额外状态，请为您的模块实现此函数和相应的get_extra_state()函数。- 参数:
state (dict) – 来自 state_dict 的额外状态
- set_seed(*args, **kwargs)[源]¶
设置环境的种子并返回要使用的下一个种子（如果只有一个环境存在，则为输入的种子）。
- 参数:
seed (int) – 要设置的种子。种子仅在环境中局部设置。要处理全局种子，请参阅
manual_seed()。static_seed (bool, 可选的) – 如果为
True，则种子不递增。默认为 False
- 返回:
即，如果与此环境同时创建另一个环境，应使用的种子。
- 返回类型:
表示“下一个种子”的整数
- set_spec_lock_(mode: bool = True) EnvBase¶
锁定或解锁环境的 specs。
- 参数:
mode (bool) – 是否锁定 (True) 或解锁 (False) specs。默认为 True。
- 返回:
环境实例本身。
- 返回类型:
如果规范被锁定则为 True，否则为 False。
bool.
- set_submodule(target: str, module: Module) None¶
如果存在由
target指定的子模块，则进行设置，否则抛出错误。get_submodule(target: str) Module¶
A( (net_b): Module( (net_c): Module( (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2)) ) (linear): Linear(in_features=100, out_features=200, bias=True) ) )（图示显示了一个
nn.ModuleA。A有一个嵌套子模块net_b，该子模块本身有两个子模块net_c和linear。然后net_c有一个子模块conv。）要用新的子模块
Linear覆盖Conv2d，您可以调用set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。- 参数:
要检查是否存在
linear子模块，我们可以调用get_submodule("net_b.linear")。要检查是否存在conv子模块，我们可以调用get_submodule("net_b.net_c.conv")。module – 要设置子模块的目标模块。
- 引发:
ValueError – 如果目标字符串为空
由
target引用的子模块
- property shape¶
等效于
batch_size。
- state_dict(*args, **kwargs)[源]¶
返回一个字典，其中包含对模块整个状态的引用。
参数和持久缓冲区（例如运行平均值）都包含在内。键是相应的参数和缓冲区名称。设置为
None的参数和缓冲区不包含在内。注意
返回的对象是一个浅拷贝。它包含对模块参数和缓冲区的引用。
警告
当前，
state_dict()也按顺序接受destination、prefix和keep_vars的位置参数。但是，此用法已被弃用，未来版本将强制使用关键字参数。警告
请避免使用参数
destination，因为它不是为最终用户设计的。- 参数:
destination (dict, 可选的) – 如果提供，模块的状态将更新到该字典中，并返回同一对象。否则，将创建一个
OrderedDict并返回。默认值：None。prefix (str, 可选的) – 添加到参数和缓冲区名称前以构成 state_dict 中的键的前缀。默认值：
''。keep_vars (bool, 可选的) – 默认情况下，state dict 中返回的
Tensor与 autograd 分离。如果设置为True，将不会执行分离操作。默认值：False。
- 返回:
一个包含模块整个状态的字典
- 返回类型:
dict
示例
>>> # xdoctest: +SKIP("undefined vars") >>> module.state_dict().keys() ['bias', 'weight']
- property state_keys: list[tensordict._nestedkey.NestedKey]¶
环境的状态键。
默认情况下，将只有一个名为 “state” 的键。
键按数据树中的深度排序。
- property state_spec: Composite¶
状态规格。
必须是
torchrl.data.Composite实例。此处列出的键应与动作一起作为输入提供给环境。在 TorchRL 中，即使它们并非严格意义上的“state”，所有非动作的环境输入都存储在
state_spec中。因此，
"state_spec"应被视为用于非动作数据的环境输入的通用数据容器。示例
>>> from torchrl.envs import BraxEnv >>> for envname in BraxEnv.available_envs: ... break >>> env = BraxEnv(envname) >>> env.state_spec Composite( state: Composite( pipeline_state: Composite( q: UnboundedContinuous( shape=torch.Size([15]), space=None, device=cpu, dtype=torch.float32, domain=continuous), [...], device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- property state_spec_unbatched: TensorSpec¶
full_state_spec是一个Composite`实例，包含所有状态条目（即，非动作的输入数据）。
- step(tensordict: TensorDictBase) TensorDictBase¶
在环境中执行一个步骤。
Step 方法接受一个参数 tensordict，该参数通常带有一个 'action' 键，用于指示要采取的动作。Step 方法会调用一个 out-place 私有方法 _step，该方法需要由 EnvBase 子类进行重写。
- 参数:
tensordict (TensorDictBase) – 包含要采取的动作的 Tensordict。如果输入的 tensordict 包含一个
"next"条目，则其中包含的值将优先于新计算出的值。这提供了一种覆盖底层计算的机制。- 返回:
输入的 tensordict，就地修改为包含结果观测、完成状态和奖励（如果需要，还包含其他内容）。
- step_and_maybe_reset(*args, **kwargs)[source]¶
在环境中运行一个步骤，并在需要时（部分）重置环境。
- 参数:
tensordict (TensorDictBase) –
step()方法的输入数据结构。
此方法允许轻松编写非停止的 rollout 函数。
示例
>>> from torchrl.envs import ParallelEnv, GymEnv >>> def rollout(env, n): ... data_ = env.reset() ... result = [] ... for i in range(n): ... data, data_ = env.step_and_maybe_reset(data_) ... result.append(data) ... return torch.stack(result) >>> env = ParallelEnv(2, lambda: GymEnv("CartPole-v1")) >>> print(rollout(env, 2)) TensorDict( fields={ done: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([2, 2, 4]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([2, 2]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([2, 2, 4]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([2, 2]), device=cpu, is_shared=False)
- step_mdp(next_tensordict: TensorDictBase) TensorDictBase¶
使用提供的 next_tensordict 将环境状态向前推进一个步骤。
此方法通过根据 next_tensordict 定义的从当前状态到下一个状态的过渡来更新环境状态。生成的新 tensordict 包含更新的观测结果和任何其他相关的状态信息，其键根据环境的规范进行管理。
在内部，此方法利用一个预计算的
_StepMDP实例来高效处理状态、观测、动作、奖励和完成（done）键的转换。_StepMDP类通过预计算要包含和排除的键来优化此过程，从而减少重复调用期间的运行时开销。创建_StepMDP实例时设置 exclude_action=False，这意味着动作键会保留在根 tensordict 中。- 参数:
next_tensordict (TensorDictBase) – 包含环境在下一个时间步的状态的 tensordict。此 tensordict 应包含观测、动作、奖励和完成（done）标志的键，这些键由环境的规范定义。
- 返回:
一个新的 tensordict，表示环境向前推进一个步骤后的状态。
- 返回类型:
TensorDictBase
注意
此方法确保环境的键规范根据提供的 next_tensordict 进行验证，如果发现不一致之处，则发出警告。
注意
此方法旨在与具有一致键规范的环境高效协同工作，利用 _StepMDP 类来最小化开销。
示例
>>> from torchrl.envs import GymEnv >>> env = GymEnv("Pendulum-1") >>> data = env.reset() >>> for i in range(10): ... # compute action ... env.rand_action(data) ... # Perform action ... next_data = env.step(reset_data) ... data = env.step_mdp(next_data)
- to(device: Union[device, str, int]])[source]¶
移动和/或转换参数和缓冲区。
此方法可以按如下方式调用：
- to(device=None, dtype=None, non_blocking=False)[source]
- to(dtype, non_blocking=False)[source]
- to(tensor, non_blocking=False)[source]
- to(memory_format=torch.channels_last)[source]
其签名类似于
torch.Tensor.to()，但只接受浮点型或复数型dtype。此外，此方法仅将浮点型或复数型的参数和缓冲区转换为指定的dtype（如果给定）。整数型的参数和缓冲区将被移动到指定的device（如果给定），但其 dtype 保持不变。当设置了non_blocking时，如果可能，它会尝试相对于主机异步转换/移动，例如将具有固定内存的 CPU Tensor 移动到 CUDA 设备。参见下方示例。
注意
此方法就地修改模块。
- 参数:
device (
torch.device) – 此模块中参数和缓冲区的目标设备dtype (
torch.dtype) – 此模块中参数和缓冲区的目标浮点型或复数型 dtypetensor (torch.Tensor) – 其 dtype 和 device 是此模块中所有参数和缓冲区的目标 dtype 和 device 的 Tensor
memory_format (
torch.memory_format) – 此模块中 4D 参数和缓冲区的目标内存格式（仅关键字参数）
- 返回:
self
- 返回类型:
Module
示例
>>> # xdoctest: +IGNORE_WANT("non-deterministic") >>> linear = nn.Linear(2, 2) >>> linear.weight Parameter containing: tensor([[ 0.1913, -0.3420], [-0.5113, -0.2325]]) >>> linear.to(torch.double) Linear(in_features=2, out_features=2, bias=True) >>> linear.weight Parameter containing: tensor([[ 0.1913, -0.3420], [-0.5113, -0.2325]], dtype=torch.float64) >>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1) >>> gpu1 = torch.device("cuda:1") >>> linear.to(gpu1, dtype=torch.half, non_blocking=True) Linear(in_features=2, out_features=2, bias=True) >>> linear.weight Parameter containing: tensor([[ 0.1914, -0.3420], [-0.5112, -0.2324]], dtype=torch.float16, device='cuda:1') >>> cpu = torch.device("cpu") >>> linear.to(cpu) Linear(in_features=2, out_features=2, bias=True) >>> linear.weight Parameter containing: tensor([[ 0.1914, -0.3420], [-0.5112, -0.2324]], dtype=torch.float16) >>> linear = nn.Linear(2, 2, bias=None).to(torch.cdouble) >>> linear.weight Parameter containing: tensor([[ 0.3741+0.j, 0.2382+0.j], [ 0.5593+0.j, -0.4443+0.j]], dtype=torch.complex128) >>> linear(torch.ones(3, 2, dtype=torch.cdouble)) tensor([[0.6122+0.j, 0.1150+0.j], [0.6122+0.j, 0.1150+0.j], [0.6122+0.j, 0.1150+0.j]], dtype=torch.complex128)
- to_empty(*, device: Optional[Union[int, str, device]], recurse: bool = True) T¶
将参数和缓冲区移动到指定设备，而不复制存储。
- 参数:
device (
torch.device) – 此模块中参数和缓冲区的目标设备。recurse (bool) – 子模块的参数和缓冲区是否应递归移动到指定设备。
- 返回:
self
- 返回类型:
Module
- train(mode: bool = True) T¶
将模块设置为训练模式。
此设置仅对某些模块有效。有关特定模块在训练/评估模式下的行为详细信息，即它们是否受影响（例如
Dropout、BatchNorm等），请参阅其文档。- 参数:
mode (bool) – 是否设置为训练模式（
True）或评估模式（False）。默认值：True。- 返回:
self
- 返回类型:
Module
- type(dst_type: Union[dtype, str]]) T¶
将所有参数和缓冲区转换为
dst_type。注意
此方法就地修改模块。
- 参数:
dst_type (type or string) – 目标类型
- 返回:
self
- 返回类型:
Module
- update_kwargs(kwargs: Union[dict, List[dict]]]) None¶
根据字典或字典列表更新每个环境的 kwargs。
- 参数:
kwargs (dict or list of dict) – 用于环境的新 kwargs
- xpu(device: Optional[Union[int, device]] = None) T¶
将所有模型参数和缓冲区移动到 XPU。
这也会使关联的参数和缓冲区成为不同的对象。因此，如果模块将在 XPU 上进行优化，则应在构建优化器之前调用此方法。
注意
此方法就地修改模块。
- 参数:
device (整型, 可选) – 如果指定，所有参数将复制到该设备。
- 返回:
self
- 返回类型:
Module
- zero_grad(set_to_none: bool = True) None¶
重置所有模型参数的梯度。
有关更多上下文，请参阅
torch.optim.Optimizer下的类似函数。- 参数:
set_to_none (bool) – 不设置为零，而是将梯度设置为 None。有关详细信息，请参阅
torch.optim.Optimizer.zero_grad()。
