ChessEnv¶
- class torchrl.envs.ChessEnv(*args, **kwargs)[source]¶
遵循 TorchRL API 的国际象棋环境。
此环境使用 chess 库模拟国际象棋游戏。它支持多种状态表示，并且可以配置为包含不同类型的观察，例如 SAN、FEN、PGN 和合法移动。
需要：chess 库。更多信息请见此处。
- 参数:
stateful (bool) – 是否跟踪棋盘的内部状态。如果为 False，状态将存储在观察中，并在每次调用时传回环境。默认值：
True。include_san (bool) –
是否在观察中包含 SAN（标准代数记谱法）。默认值：
False。注意
对应于 rollout[“action”] 的 “san” 条目将在 rollout[“next”, “san”] 中找到，而根目录 rollout[“san”] 中的值将对应于同一索引操作之前的 san 值。
include_fen (bool) – 是否在观察中包含 FEN（福赛斯-爱德华兹记谱法）。默认值：
False。include_pgn (bool) – 是否在观察中包含 PGN（可移植游戏记谱法）。默认值：
False。include_legal_moves (bool) – 是否在观察中包含合法移动。默认值：
False。include_hash (bool) – 是否在环境中包含哈希变换。默认值：
False。mask_actions (bool) – 如果为
True，则会将ActionMask变换附加到环境中，以确保动作被正确掩码。默认值：True。pixels (bool) – 是否包含基于像素的棋盘观察。默认值：
False。
注意
动作规范是一个
Categorical，其动作数量等于所有可能的 SAN 移动数量。动作空间被构造为所有可能的 SAN 移动上的分类分布，其中合法移动是此空间的子集。环境使用掩码来确保只选择合法移动。示例
>>> import torch >>> from torchrl.envs import ChessEnv >>> _ = torch.manual_seed(0) >>> env = ChessEnv(include_fen=True, include_san=True, include_pgn=True, include_legal_moves=True) >>> print(env) TransformedEnv( env=ChessEnv(), transform=ActionMask(keys=['action', 'action_mask'])) >>> r = env.reset() >>> print(env.rand_step(r)) TensorDict( fields={ action: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False), action_mask: Tensor(shape=torch.Size([29275]), device=cpu, dtype=torch.bool, is_shared=False), done: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.bool, is_shared=False), fen: NonTensorData(data=rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1, batch_size=torch.Size([]), device=None), legal_moves: Tensor(shape=torch.Size([219]), device=cpu, dtype=torch.int64, is_shared=False), next: TensorDict( fields={ action_mask: Tensor(shape=torch.Size([29275]), device=cpu, dtype=torch.bool, is_shared=False), done: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.bool, is_shared=False), fen: NonTensorData(data=rnbqkbnr/pppppppp/8/8/5P2/8/PPPPP1PP/RNBQKBNR b KQkq - 0 1, batch_size=torch.Size([]), device=None), legal_moves: Tensor(shape=torch.Size([219]), device=cpu, dtype=torch.int64, is_shared=False), pgn: NonTensorData(data=[Event "?"] [Site "?"] [Date "????.??.??"] [Round "?"] [White "?"] [Black "?"] [Result "*"]
1. f4 *, batch_size=torch.Size([]), device=None), reward: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, is_shared=False), san: NonTensorData(data=f4, batch_size=torch.Size([]), device=None), terminated: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.bool, is_shared=False), turn: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.bool, is_shared=False)},
batch_size=torch.Size([]), device=None, is_shared=False),
pgn: NonTensorData(data=[Event “?”] [Site “?”] [Date “????.??.??”] [Round “?”] [White “?”] [Black “?”] [Result “*”]
*, batch_size=torch.Size([]), device=None), san: NonTensorData(data=<start>, batch_size=torch.Size([]), device=None), terminated: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.bool, is_shared=False), turn: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.bool, is_shared=False)},
batch_size=torch.Size([]), device=None, is_shared=False)
>>> print(env.rollout(1000)) TensorDict( fields={ action: Tensor(shape=torch.Size([96]), device=cpu, dtype=torch.int64, is_shared=False), action_mask: Tensor(shape=torch.Size([96, 29275]), device=cpu, dtype=torch.bool, is_shared=False), done: Tensor(shape=torch.Size([96, 1]), device=cpu, dtype=torch.bool, is_shared=False), fen: NonTensorStack( ['rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQ..., batch_size=torch.Size([96]), device=None), legal_moves: Tensor(shape=torch.Size([96, 219]), device=cpu, dtype=torch.int64, is_shared=False), next: TensorDict( fields={ action_mask: Tensor(shape=torch.Size([96, 29275]), device=cpu, dtype=torch.bool, is_shared=False), done: Tensor(shape=torch.Size([96, 1]), device=cpu, dtype=torch.bool, is_shared=False), fen: NonTensorStack( ['rnbqkbnr/pppppppp/8/8/8/5N2/PPPPPPPP/RNBQKB1R b ..., batch_size=torch.Size([96]), device=None), legal_moves: Tensor(shape=torch.Size([96, 219]), device=cpu, dtype=torch.int64, is_shared=False), pgn: NonTensorStack( ['[Event "?"]\n[Site "?"]\n[Date "????.??.??"]\n[R..., batch_size=torch.Size([96]), device=None), reward: Tensor(shape=torch.Size([96, 1]), device=cpu, dtype=torch.float32, is_shared=False), san: NonTensorStack( ['Nf3', 'Na6', 'c4', 'f6', 'h4', 'Rb8', 'Na3', 'Ra..., batch_size=torch.Size([96]), device=None), terminated: Tensor(shape=torch.Size([96, 1]), device=cpu, dtype=torch.bool, is_shared=False), turn: Tensor(shape=torch.Size([96]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([96]), device=None, is_shared=False), pgn: NonTensorStack( ['[Event "?"]\n[Site "?"]\n[Date "????.??.??"]\n[R..., batch_size=torch.Size([96]), device=None), san: NonTensorStack( ['<start>', 'Nf3', 'Na6', 'c4', 'f6', 'h4', 'Rb8',..., batch_size=torch.Size([96]), device=None), terminated: Tensor(shape=torch.Size([96, 1]), device=cpu, dtype=torch.bool, is_shared=False), turn: Tensor(shape=torch.Size([96]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([96]), device=None, is_shared=False)
- property action_key: NestedKey¶
环境的动作键。
默认情况下，这将是“action”。
如果环境中存在多个动作键，此函数将引发异常。
- property action_keys: list[tensordict._nestedkey.NestedKey]¶
环境的动作键列表。
默认情况下，只会有一个名为“action”的键。
键按数据树中的深度排序。
- property action_spec: TensorSpec¶
动作规范。
action_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)
如果动作规范作为复合规范提供且只包含一个叶节点，此函数将仅返回该叶节点。
>>> 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)
如果动作规范作为复合规范提供且包含多个叶节点，此函数将返回整个规范。
>>> 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([]))
要检索传入的完整规范，请使用
>>> 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¶
返回环境的动作规范，如同它没有批处理维度一样。
- add_module(name: str, module: Optional[Module]) None¶
向当前模块添加子模块。
可以使用给定的名称作为属性访问该模块。
- 参数:
name (str) – 子模块的名称。可以通过此模块使用给定的名称访问子模块
module (Module) – 要添加到模块的子模块。
- all_actions(tensordict: TensorDictBase | None = None) TensorDictBase¶
从动作规范生成所有可能的动作。
这只适用于具有完全离散动作的环境。
- 参数:
tensordict (TensorDictBase, optional) – 如果给定，则使用此 tensordict 调用
reset()。- 返回:
一个 tensordict 对象，其“action”条目已更新为一批所有可能的动作。这些动作在第一个维度上堆叠在一起。
- append_transform(transform: Transform | Callable[[TensorDictBase], TensorDictBase]) EnvBase¶
返回一个变换后的环境，其中应用了传入的可调用对象/变换。
- 参数:
transform (Transform or Callable[[TensorDictBase], TensorDictBase]) – 要应用于环境的变换。
示例
>>> 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 期间收集的数据更新环境关于动作、观察、奖励和完成信号的规范。
- 参数:
policy (Callable[[TensorDictBase], TensorDictBase]) – 一个可调用策略，它接受 TensorDictBase 作为输入，并返回 TensorDictBase 作为输出。此策略用于执行 rollout 并确定规范。
- 关键字参数:
tensordict (TensorDictBase, optional) – 一个可选的 TensorDictBase 实例，用作 rollout 的初始状态。如果未提供，将调用环境的 reset 方法来获取初始状态。
action_key (NestedKey or List[NestedKey], optional) – 用于在 TensorDictBase 中标识动作的键。默认为“action”。
done_key (NestedKey or List[NestedKey], optional) – 用于在 TensorDictBase 中标识完成信号的键。默认为
None，此时将尝试使用 [“done”, “terminated”, “truncated”] 作为潜在键。observation_key (NestedKey or List[NestedKey], optional) – 用于在 TensorDictBase 中标识观察的键。默认为“observation”。
reward_key (NestedKey or List[NestedKey], optional) – 用于在 TensorDictBase 中标识奖励的键。默认为“reward”。
- 返回:
具有更新规范的环境实例。
- 返回类型:
- 引发:
RuntimeError – 如果输出规范中存在未在提供的键中考虑到的键。
- 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 (bool) – 如果为 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[source]¶
动作空间的基数。
默认情况下，这只是
env.action_space.cardinality的一个封装。当动作规范是可变的，此方法很有用
动作数量可能未定义，例如
Categorical(n=-1)；动作基数可能取决于动作掩码；
形状可以是动态的，例如
Unbound(shape=(-1))。
在这些情况下，应该重写
cardinality()，- 参数:
tensordict (TensorDictBase, optional) – 一个包含计算基数所需数据的 tensordict。
- 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 (bool, optional) – 如果为
True，则随机 rollout 将以 return_contiguous=True 调用。这在某些情况下（例如，输入/输出形状异构）会失败。默认为None（由动态规范的存在决定）。check_dtype (bool, optional) – 如果为 False，将跳过 dtype 检查。默认为 True。
种子 (int, optional) – 为了重现性，可以设置一个种子。该种子将在 PyTorch 中临时设置，然后随机数生成器 (RNG) 状态将恢复到之前的值。对于环境 (env)，我们会设置种子，但由于恢复随机数生成器状态并不是大多数环境的特性，我们将其留给用户自行完成。默认为
None。tensordict (TensorDict, optional) – 用于重置的可选 tensordict 实例。
注意：此函数会重置环境种子。应将其“离线”使用，以检查环境是否已充分构建，但它可能会影响实验的种子设置，因此应避免在训练脚本中使用。
- compile(*args, **kwargs)¶
使用
torch.compile()编译此模块的 forward 方法。此模块的 __call__ 方法被编译，并且所有参数按原样传递给
torch.compile()。有关此函数参数的详细信息，请参阅
torch.compile()。
- cpu() T¶
将所有模型参数和缓冲区移动到 CPU。
注意
此方法就地修改模块。
- 返回:
self
- 返回类型:
Module
- cuda(device: Optional[Union[int, device]] = None) T¶
将所有模型参数和缓冲区移动到 GPU。
这也会使相关的参数和缓冲区成为不同的对象。因此，如果模块将在 GPU 上进行优化，则应在构建优化器之前调用此方法。
注意
此方法就地修改模块。
- 参数:
device (int, optional) – 如果指定，所有参数将被复制到该设备。
- 返回:
self
- 返回类型:
Module
- property done_key¶
环境的 done 键。
默认情况下，此键为“done”。
如果环境中存在多个 done 键，此函数将引发异常。
- property done_keys: list[tensordict._nestedkey.NestedKey]¶
环境的 done 键列表。
默认情况下，只会有一个名为“done”的键。
键按数据树中的深度排序。
- property done_keys_groups¶
按 reset 键分组的 done 键列表。
这是一个列表的列表。外层列表的长度与 reset 键的数量相同，内层列表包含可以读取的 done 键（例如 done 和 truncated），用于在 reset 键不存在时确定是否进行重置。
- property done_spec: TensorSpec¶
done规范。done_spec始终存储为复合规范 (composite spec)。如果 done 规范提供的是简单规范 (simple 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)
如果 done 规范提供的是复合规范 (composite spec) 且只包含一个叶节点 (leaf)，则此函数将只返回该叶节点。
>>> 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)
如果 done 规范提供的是复合规范 (composite spec) 且包含多个叶节点 (leaf)，则此函数将返回整个规范。
>>> 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¶
返回环境的 done 规范，就像它没有批处理维度一样。
- double() T¶
将所有浮点参数和缓冲区转换为
double数据类型。注意
此方法就地修改模块。
- 返回:
self
- 返回类型:
Module
- empty_cache()¶
清除所有缓存值。
对于常规环境 (env)，键列表（如 reward, done 等）会被缓存，但在某些情况下，它们可能在代码执行期间发生变化（例如，添加 transform 时）。
- eval() T¶
将模块设置为评估模式。
这仅对某些模块有影响。有关特定模块在训练/评估模式下的行为详情，即它们是否受影响，请参阅其文档，例如
Dropout、BatchNorm等。这等同于
self.train(False)。有关 .eval() 和几个可能与之混淆的类似机制的比较，请参阅 本地禁用梯度计算。
- 返回:
self
- 返回类型:
Module
- extra_repr() str¶
返回模块的额外表示。
要打印自定义的额外信息，应在自己的模块中重新实现此方法。单行和多行字符串均可接受。
- fake_tensordict() TensorDictBase¶
返回一个伪 (fake) tensordict，其键值对在形状、设备和数据类型上与环境 rollout 期间预期的结果一致。
- float() T¶
将所有浮点参数和缓冲区转换为
float数据类型。注意
此方法就地修改模块。
- 返回:
self
- 返回类型:
Module
- forward(*args, **kwargs)¶
定义每次调用时执行的计算。
应被所有子类重写。
注意
尽管前向传播 (forward pass) 的逻辑需要在本函数中定义，但之后应该调用
Module实例而不是直接调用本函数，因为前者会处理已注册的钩子 (hooks)，而后者会默默忽略它们。
- property full_action_spec: Composite¶
完整的动作规范 (action spec)。
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¶
完整的 done 规范 (done spec)。
full_done_spec是一个Composite`实例，包含所有 done 条目。它可用于生成具有模拟运行时获得的结构体的伪 (fake) 数据。示例
>>> 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([]))
- property full_reward_spec: Composite¶
完整的奖励规范 (reward spec)。
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([]))
- property full_state_spec: Composite¶
完整的状态规范 (state spec)。
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([]))
- get_buffer(target: str) Tensor¶
如果存在由
target指定的缓冲区，则返回该缓冲区，否则抛出错误。有关此方法的更详细功能说明以及如何正确指定
target，请参阅get_submodule的文档字符串。- 参数:
target – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅
get_submodule。）- 返回:
由
target引用的缓冲区- 返回类型:
- 引发:
AttributeError – 如果目标字符串引用了无效路径或解析到的对象不是缓冲区。
- get_extra_state() Any¶
返回要包含在模块 state_dict 中的任何额外状态。
如果需要存储额外状态，请为您的模块实现此方法和相应的
set_extra_state()方法。构建模块的 state_dict() 时会调用此函数。请注意，额外状态应该是可 pickle 化的，以确保 state_dict 的序列化正常工作。我们只提供对序列化 Tensor 的向后兼容性保证；如果其他对象的 pickle 序列化形式发生变化，可能会破坏向后兼容性。
- 返回:
要存储在模块 state_dict 中的任何额外状态
- 返回类型:
object
- get_legal_moves(tensordict=None, uci=False)[source]¶
列出当前局面 (position) 的合法移动。
要选择其中一个动作，可以将“action”键设置为该移动在此列表中的索引。
- 参数:
tensordict (TensorDict, optional) – 包含局面 (position) 的 fen 字符串的 Tensordict。如果不是 stateful (有状态) 的，则必需。如果是 stateful (有状态) 的，则忽略此参数，转而使用环境的当前状态。
uci (bool, optional) – 如果为
False，移动以 SAN 格式给出。如果为True，移动以 UCI 格式给出。默认为False。
- get_parameter(target: str) Parameter¶
如果存在由
target指定的参数，则返回该参数，否则抛出错误。有关此方法的更详细功能说明以及如何正确指定
target，请参阅get_submodule的文档字符串。- 参数:
target – 要查找的参数的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅
get_submodule。）- 返回:
由
target引用的参数- 返回类型:
torch.nn.Parameter
- 引发:
AttributeError – 如果目标字符串引用了无效路径或解析到的对象不是
nn.Parameter。
- get_submodule(target: str) Module¶
如果存在由
target指定的子模块，则返回该子模块，否则抛出错误。例如，假设您有一个如下所示的
nn.ModuleA：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_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)。因此，对于检查是否存在某个子模块的简单操作，应始终使用get_submodule。- 参数:
target – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上文示例。）
- 返回:
由
target引用的子模块- 返回类型:
- 引发:
AttributeError – 如果目标字符串引用了无效路径或解析到的对象不是
nn.Module。
- half() T¶
将所有浮点参数和缓冲区转换为
half数据类型。注意
此方法就地修改模块。
- 返回:
self
- 返回类型:
Module
- property input_spec: TensorSpec¶
输入规范 (Input spec)。
包含所有输入到环境的数据规范的复合规范。
它包含
“full_action_spec”：输入动作的规范
“full_state_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([]))
- ipu(device: Optional[Union[int, device]] = None) T¶
将所有模型参数和缓冲区移动到 IPU。
这也会使相关的参数和缓冲区成为不同的对象。因此，如果模块将在 IPU 上进行优化，则应在构建优化器之前调用此方法。
注意
此方法就地修改模块。
- 参数:
device (int, optional) – 如果指定，所有参数将被复制到该设备。
- 返回:
self
- 返回类型:
Module
- property is_spec_locked¶
获取环境规范是否被锁定。
此属性可以直接修改。
- 返回:
如果规范被锁定则为 True，否则为 False。
- 返回类型:
bool
另请参阅
- load_state_dict(state_dict: Mapping[str, Any], strict: bool = True, assign: bool = False)¶
将参数和缓冲区从
state_dict复制到本模块及其后代模块。如果
strict为True，则state_dict中的键必须与此模块的state_dict()函数返回的键完全匹配。警告
如果
assign为True，则必须在调用load_state_dict之后创建优化器，除非get_swap_module_params_on_conversion()为True。- 参数:
state_dict (dict) – 包含参数和持久缓冲区的字典。
strict (bool, optional) – 是否严格强制要求
state_dict中的键与此模块的state_dict()函数返回的键匹配。默认值：Trueassign (bool, optional) – 当设置为
False时，保留当前模块中张量的属性；而设置为True时，保留 state dict 中张量的属性。唯一的例外是的requires_grad字段。默认值：``False`
- 返回:
- missing_keys 是一个包含所有预期键的字符串列表。
但该模块需要而提供的
state_dict中缺失的键。
- unexpected_keys 是一个字符串列表，包含不被
该模块需要但存在于提供的
state_dict中的键。
- 返回类型:
带有
missing_keys和unexpected_keys字段的NamedTuple
注意
如果参数或 buffer 被注册为
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¶
将所有模型参数和 buffer 移动到 MTIA。
这也会使相关的参数和 buffer 成为不同的对象。因此，如果模块将在 MTIA 上优化，应在构建优化器之前调用此方法。
注意
此方法就地修改模块。
- 参数:
device (int, optional) – 如果指定，所有参数将被复制到该设备。
- 返回:
self
- 返回类型:
Module
- named_buffers(prefix: str = '', recurse: bool =True, remove_duplicate: bool =True) Iterator[Tuple[str, Tensor]]¶
返回模块 buffer 的迭代器，同时产生 buffer 的名称和 buffer 本身。
- 参数:
prefix (str) – 要添加到所有 buffer 名称前面的前缀。
recurse (bool, optional) – 如果为 True，则生成此模块及其所有子模块的 buffer。否则，仅生成此模块的直接成员的 buffer。默认为 True。
remove_duplicate (bool, optional) – 是否移除结果中的重复 buffer。默认为 True。
- 生成:
(str, torch.Tensor) – 包含名称和 buffer 的元组
示例
>>> # 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, optional) – 是否移除结果中重复的参数。默认为 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¶
观察 spec。
必须是
torchrl.data.Composite的实例。spec 中列出的键在 reset 和 step 后可以直接访问。在 TorchRL 中，即使它们严格来说不是“观察”，所有信息 (info)、状态 (states)、转换结果 (results of transforms) 等来自环境的输出都存储在
observation_spec中。因此，
"observation_spec"应被视为一个通用数据容器，用于存储非完成或奖励数据的环境输出。示例
>>> 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¶
输出 spec。
包含环境输出所有数据的复合 spec。
它包含
“full_reward_spec”：奖励的 spec
“full_done_spec”：完成的 spec
“full_observation_spec”：所有其他环境输出的 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, optional) – 应该写入结果动作的 tensordict。
- 返回:
一个 tensordict 对象，其“action”条目已更新为从 action-spec 中随机采样的数据。
- rand_step(tensordict: TensorDictBase | None = None) TensorDictBase¶
根据 action_spec 属性在环境中执行随机 step。
- 参数:
tensordict (TensorDictBase, optional) – 应该写入结果信息的 tensordict。
- 返回:
一个 tensordict 对象，其中包含在环境中随机 step 后产生的新观察。动作将存储在“action”键下。
- register_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor], Union[None, Tuple[Tensor, ...], Tensor]]) RemovableHandle¶
在模块上注册一个反向 hook。
此函数已弃用，建议使用
register_full_backward_hook()。此函数的行为将在未来版本中改变。- 返回:
一个句柄 (handle)，可以通过调用
handle.remove()来移除添加的 hook。- 返回类型:
torch.utils.hooks.RemovableHandle
- register_buffer(name: str, tensor: Optional[Tensor], persistent: bool =True) None¶
向模块添加一个 buffer。
这通常用于注册不应被视为模型参数的 buffer。例如，BatchNorm 的
running_mean不是参数，但它是模块状态的一部分。默认情况下，buffer 是持久的，并且会与参数一起保存。通过将persistent设置为False可以更改此行为。持久 buffer 和非持久 buffer 之间的唯一区别在于后者不会成为此模块的state_dict的一部分。Buffer 可以通过给定的名称作为属性访问。
- 参数:
name (str) – buffer 的名称。可以使用给定的名称从该模块访问 buffer。
tensor (Tensor or None) – 要注册的 buffer。如果为
None，则在 buffer 上运行的操作（例如cuda）将被忽略。如果为None，则该 buffer 不会包含在模块的state_dict中。persistent (bool) – buffer 是否为此模块的
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¶
在模块上注册一个前向 hook。
每次
forward()计算出输出后，都会调用该 hook。如果
with_kwargs为False或未指定，则输入仅包含传递给模块的位置参数。关键字参数不会传递给 hook，只会传递给forward。hook 可以修改输出。它可以就地修改输入，但不会影响 forward，因为 hook 是在forward()调用之后调用的。该 hook 应具有以下签名：hook(module, args, output) -> None or modified output
如果
with_kwargs为True，则前向 hook 将会接收传递给 forward 函数的kwargs，并期望返回可能已被修改的输出。该 hook 应具有以下签名：hook(module, args, kwargs, output) -> None or modified output
- 参数:
hook (Callable) – 要注册的用户自定义 hook。
prepend (bool) – 如果为
True，则提供的hook将在此torch.nn.modules.Module上所有现有forwardhook 之前触发。否则，提供的hook将在此torch.nn.modules.Module上所有现有forwardhook 之后触发。请注意，使用register_module_forward_hook()注册的全局forwardhook 将在此方法注册的所有 hook 之前触发。默认为False。with_kwargs (bool) – 如果为
True，则hook将接收传递给 forward 函数的 kwargs。默认为False。always_call (bool) – 如果为
True，无论调用模块时是否发生异常，hook都将运行。默认为False。
- 返回:
一个句柄 (handle)，可以通过调用
handle.remove()来移除添加的 hook。- 返回类型:
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¶
在模块上注册一个前向预处理 hook。
每次调用
forward()之前，都会调用该 hook。如果
with_kwargs为 false 或未指定，则输入仅包含传递给模块的位置参数。关键字参数不会传递给 hook，只会传递给forward。hook 可以修改输入。用户可以在 hook 中返回一个元组或一个单独的修改后的值。如果返回的是单个值（除非该值已经是元组），我们会将其包装成一个元组。该 hook 应具有以下签名：hook(module, args) -> None or modified input
如果
with_kwargs为 true，则前向预处理 hook 将会接收传递给 forward 函数的 kwargs。如果 hook 修改了输入，则应返回 args 和 kwargs。该 hook 应具有以下签名：hook(module, args, kwargs) -> None or a tuple of modified input and kwargs
- 参数:
hook (Callable) – 要注册的用户自定义 hook。
prepend (bool) – 如果为 true，则提供的
hook将在此torch.nn.modules.Module上所有现有forward_prehook 之前触发。否则，提供的hook将在此torch.nn.modules.Module上所有现有forward_prehook 之后触发。请注意，使用register_module_forward_pre_hook()注册的全局forward_prehook 将在此方法注册的所有 hook 之前触发。默认为False。with_kwargs (bool) – 如果为 true，则
hook将接收传递给 forward 函数的 kwargs。默认为False。
- 返回:
一个句柄 (handle)，可以通过调用
handle.remove()来移除添加的 hook。- 返回类型:
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。
每次计算模块的梯度时都会调用此钩子，即只有在计算模块输出的梯度时，此钩子才会执行。钩子应具有以下签名：
hook(module, grad_input, grad_output) -> tuple(Tensor) or None
grad_input和grad_output是元组，分别包含与输入和输出相关的梯度。钩子不应修改其参数，但可以选择返回与输入相关的新梯度，该梯度将在后续计算中替代grad_input使用。grad_input只对应作为位置参数提供的输入，所有关键字参数都会被忽略。grad_input和grad_output中的非 Tensor 参数对应项将为None。出于技术原因，当此钩子应用于模块时，其 forward 函数将接收传递给该模块的每个 Tensor 的视图。类似地，调用者也将接收该模块的 forward 函数返回的每个 Tensor 的视图。
警告
使用反向钩子时，不允许就地修改输入或输出，否则将引发错误。
- 参数:
hook (Callable) – 要注册的用户定义钩子。
prepend (bool) – 如果为 True，则提供的
hook将在此torch.nn.modules.Module上所有现有的backward钩子 *之前* 触发。否则，提供的hook将在此torch.nn.modules.Module上所有现有的backward钩子 *之后* 触发。请注意，使用register_module_full_backward_hook()注册的全局backward钩子将在通过此方法注册的所有钩子 *之前* 触发。
- 返回:
一个句柄 (handle)，可以通过调用
handle.remove()来移除添加的 hook。- 返回类型:
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。出于技术原因，当此钩子应用于模块时，其 forward 函数将接收传递给该模块的每个 Tensor 的视图。类似地，调用者也将接收该模块的 forward 函数返回的每个 Tensor 的视图。
警告
使用反向钩子时，不允许就地修改输入，否则将引发错误。
- 参数:
hook (Callable) – 要注册的用户定义钩子。
prepend (bool) – 如果为 True，则提供的
hook将在此torch.nn.modules.Module上所有现有的backward_pre钩子 *之前* 触发。否则，提供的hook将在此torch.nn.modules.Module上所有现有的backward_pre钩子 *之后* 触发。请注意，使用register_module_full_backward_pre_hook()注册的全局backward_pre钩子将在通过此方法注册的所有钩子 *之前* 触发。
- 返回:
一个句柄 (handle)，可以通过调用
handle.remove()来移除添加的 hook。- 返回类型:
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 (str) – 环境的名称。应遵循 gym 命名约定。
- 关键字参数:
entry_point (callable, optional) –
用于构建环境的入口点。如果未传入，则父类将用作入口点。通常，这用于注册一个不一定继承自所使用基础类的环境。
>>> 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 (List[NestedKey], optional) –
如果提供，这些键将用于构建 info 字典，并从 observation 键中排除。此参数可在调用
make()期间传递（见下例）。警告
使用
info_keys可能会导致 spec 变为空，因为内容已移至 info 字典。Gym 不喜欢 specs 中的空Dict，因此应使用RemoveEmptySpecs移除此空内容。backend (str, optional) – 后端。可以是 “gym” 或 “gymnasium”，或任何其他与
set_gym_backend兼容的后端。to_numpy (bool, optional) – 如果为
True，则对 step 和 reset 的调用结果将被映射到 numpy 数组。默认为False(结果是 tensors)。此参数可在调用make()期间传递（见下例）。reward_threshold (
float, optional) – [Gym 关键字参数] 学习环境时考虑的奖励阈值。nondeterministic (bool, optional) – [Gym 关键字参数] 如果环境是非确定性的（即使知道初始种子和所有动作）。默认为
False。max_episode_steps (int, optional) – [Gym 关键字参数] 截断前的最大 episodes 步数。由 Time Limit wrapper 使用。
order_enforce (bool, optional) – [Gym >= 0.14] 是否应应用 order enforcer wrapper 以确保用户按正确顺序运行函数。默认为
True。autoreset (bool, optional) – [Gym >= 0.14] 是否应添加 autoreset wrapper，以便不需要调用 reset。默认为
False。disable_env_checker – [Gym >= 0.14] 是否应禁用环境检查器。默认为
False。apply_api_compatibility – [Gym >= 0.26] 是否应用 StepAPICompatibility wrapper。默认为
False。**kwargs – 传递给环境构造函数的任意关键字参数。
注意
TorchRL 的环境没有
"info"字典的概念，因为TensorDict提供了大多数训练设置所需的全部存储要求。不过，您仍然可以使用info_keys参数来精细控制哪些被视为 observation，哪些应被视为 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是一个包含缺失键的strlist，而unexpected_keys是一个包含意外键的strlist。如果需要，可以就地修改给定的 incompatible_keys。
请注意，如预期一样，当调用
load_state_dict()并设置strict=True时执行的检查会受到钩子对missing_keys或unexpected_keys所做修改的影响。向任一键集中添加内容将在strict=True时引发错误，而清除缺失键和意外键将避免错误。- 返回:
一个句柄 (handle)，可以通过调用
handle.remove()来移除添加的 hook。- 返回类型:
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 (Callable) – 在加载 state dict 之前将被调用的 Callable 钩子。
- register_module(name: str, module: Optional[Module]) None¶
add_module()的别名。
- register_parameter(name: str, param: Optional[Parameter]) None¶
向模块添加一个参数。
可以使用给定的名称作为属性来访问该参数。
- 参数:
name (str) – 参数的名称。可以使用此模块中的给定名称访问该参数
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()方法注册一个前置钩子。- 它应具有以下签名：
hook(module, prefix, keep_vars) -> None
注册的钩子可用于在进行
state_dict调用之前执行预处理。
- requires_grad_(requires_grad: bool = True) T¶
更改 autograd 是否应记录此模块中参数的操作。
此方法会就地设置参数的
requires_grad属性。此方法有助于冻结模块的部分用于微调，或单独训练模型的某些部分（例如，GAN 训练）。
有关 .requires_grad_() 与可能与其混淆的几种类似机制之间的比较，请参阅[本地禁用梯度计算](https://pytorch.ac.cn/docs/stable/notes/autograd.html#locally-disable-grad-doc)。
- 参数:
requires_grad (bool) – autograd 是否应记录此模块中参数的操作。默认值：
True。- 返回:
self
- 返回类型:
Module
- reset(tensordict: TensorDictBase | None = None, **kwargs) TensorDictBase¶
重置环境。
与 step 和 _step 一样，只有私有方法
_reset应由 EnvBase 子类重写。- 参数:
tensordict (TensorDictBase, optional) – 用于包含结果新 observation 的 tensordict。在某些情况下，此输入也可用于向 reset 函数传递参数。
kwargs (optional) – 要传递给原生 reset 函数的其他参数。
- 返回:
返回一个 tensordict（如果提供了输入 tensordict，则为该输入 tensordict），其中包含就地修改后的结果 observations。
注意
reset 不应被
EnvBase子类重写。要修改的方法是_reset()。
- property reset_keys: list[tensordict._nestedkey.NestedKey]¶
返回 reset 键的列表。
Reset 键是在批量、多任务或多代理设置中指示部分重置的键。它们的结构为
(*prefix, "_reset")，其中prefix是一个（可能为空的）字符串元组，指向 tensordict 中可以找到完成状态的位置。键按数据树中的深度排序。
- property reward_key¶
环境的奖励键。
默认情况下，这将是 “reward”。
如果环境中存在多个奖励键，此函数将引发异常。
- property reward_keys: list[tensordict._nestedkey.NestedKey]¶
环境的奖励键。
默认情况下，将只有一个名为 “reward” 的键。
键按数据树中的深度排序。
- property reward_spec: TensorSpec¶
rewardspec。reward_spec总是以复合 spec 存储。如果奖励 spec 提供为简单 spec，则将返回此 spec。
>>> 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)
如果奖励 spec 提供为复合 spec 且仅包含一个叶节点，此函数将仅返回该叶节点。
>>> 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)
如果奖励 spec 提供为复合 spec 且包含多个叶节点，此函数将返回整个 spec。
>>> 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([]))
要检索传入的完整规范，请使用
>>> 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¶
返回环境的奖励规范 (reward spec)，就像它没有批处理维度一样。
- 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）。
一旦包含的任何环境达到任何完成状态，函数将立即返回。
- 参数:
max_steps (int) – 要执行的最大步数。如果环境在达到 max_steps 之前达到完成状态，实际步数可能会小于 max_steps。
policy (callable, 可选) – 用于计算期望动作的可调用对象。如果未提供策略，将使用
env.rand_step()调用动作。策略可以是任何可调用对象，它读取张量字典（TensorDict）或观察项的整个序列，__按照env.observation_spec.keys()的顺序排序__。默认为 None。callback (Callable[[TensorDict], Any], 可选) – 在每次迭代时使用给定的张量字典（TensorDict）调用的函数。默认为
None。callback的输出不会被收集，如果数据需要在rollout调用之外保留，则用户有责任在 callback 调用内部保存任何结果。
- 关键字参数:
auto_reset (bool, 可选) – 如果为
True，将在开始轨迹采集之前重置包含的环境。如果为False，则轨迹采集将从先前的状态继续，这要求传入带有先前轨迹采集结果的tensordict参数。默认为True。auto_cast_to_device (bool, 可选) – 如果为
True，在使用策略之前，张量字典的设备类型会自动转换为策略的设备类型。默认为False。break_when_any_done (bool) – 如果为
True，当包含的任何环境达到任何完成状态时中断。如果为False，则已完成的环境会自动重置。默认为True。break_when_all_done (bool, 可选) – 如果为
True，如果所有包含的环境都达到任何完成状态则中断。如果为False，如果至少有一个环境达到任何完成状态则中断。默认为False。return_contiguous (bool) – 如果为 False，将返回一个 LazyStackedTensorDict。如果环境没有动态规范（dynamic specs），默认为 True，否则默认为 False。
tensordict (TensorDict, 可选) – 如果
auto_reset为 False，则必须提供初始张量字典。Rollout 将检查此张量字典是否包含完成标志，并根据需要重置这些维度的环境。如果tensordict是重置操作的输出，通常不会发生这种情况，但如果tensordict是先前轨迹采集的最后一步，则可能会发生。即使auto_reset=True，如果需要将元数据（如无状态环境的批大小或设备）传递给reset方法，也可以提供tensordict。set_truncated (bool, 可选) – 如果为
True，在轨迹采集完成后，"truncated"和"done"键将被设置为True。如果在done_spec中未找到"truncated"，则会引发异常。可以通过env.add_truncated_keys设置 truncated 键。默认为False。trust_policy (bool, 可选) – 如果为
True，非 TensorDictModule 策略将被假定为与收集器兼容并受到信任。对于 CudaGraphModules，默认为True，否则为False。
- 返回:
包含结果轨迹的张量字典（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)
在某些情况下，由于无法堆叠，无法获得连续的张量字典。这可能发生在每一步返回的数据形状不同，或者同时执行不同的环境时。在这种情况下，
return_contiguous=False将导致返回的张量字典成为张量字典的惰性堆叠（lazy stack）。- 非连续轨迹采集示例
>>> 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']
Rollouts 可以用于循环中以模拟数据收集。为此，您需要将前一个 rollout 调用
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(seed: int | None = None, static_seed: bool = False) int | None¶
设置环境的随机种子，并返回要使用的下一个种子（如果只有一个环境，则为输入的种子）。
- 参数:
seed (int) – 要设置的种子。种子仅在环境本地设置。要处理全局种子，请参阅
manual_seed()。static_seed (bool, 可选) – 如果为
True，则种子不自增。默认为 False。
- 返回:
即，如果与此环境同时创建另一个环境，应使用该种子。
- 返回类型:
表示“下一个种子”的整数。
- set_spec_lock_(mode: bool = True) EnvBase¶
锁定或解锁环境的规范（specs）。
- 参数:
mode (bool) – 是否锁定 (True) 或解锁 (False) 规范。默认为 True。
- 返回:
环境实例本身。
- 返回类型:
另请参阅
- set_submodule(target: str, module: Module) None¶
设置由
target指定的子模块（如果存在），否则抛出错误。例如，假设您有一个如下所示的
nn.ModuleA：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))。- 参数:
target – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上文示例。）
module – 要设置的子模块。
- 引发:
ValueError – 如果 target 字符串为空。
AttributeError – 如果目标字符串引用了无效路径或解析到的对象不是
nn.Module。
- property shape¶
等同于
batch_size。
- state_dict(*args, destination=None, prefix='', keep_vars=False)¶
返回一个字典，其中包含对模块整体状态的引用。
参数和持久缓冲区（例如，运行平均值）都包含在内。键对应于参数和缓冲区的名称。设置为
None的参数和缓冲区不包含在内。注意
返回的对象是浅拷贝。它包含对模块参数和缓冲区的引用。
警告
当前
state_dict()也按顺序接受destination、prefix和keep_vars的位置参数。但是，这已被弃用，未来的版本将强制使用关键字参数。警告
请避免使用参数
destination，因为它不适用于最终用户。- 参数:
destination (dict, 可选) – 如果提供，模块的状态将被更新到此字典中，并返回相同的对象。否则，将创建一个
OrderedDict并返回。默认值：None。prefix (str, 可选) – 添加到参数和缓冲区名称前的字符串，用于在 state_dict 中组成键。默认值：
''。keep_vars (bool, 可选) – 默认情况下，state dict 中返回的
Tensors 与 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¶
状态规范（State spec）。
必须是
torchrl.data.Composite实例。此处列出的键应与动作一起作为输入提供给环境。在 TorchRL 中，即使它们并非严格意义上的“状态”，所有非动作的环境输入都存储在
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¶
返回环境的状态规范 (state spec)，就像它没有批处理维度一样。
- step(tensordict: TensorDictBase) TensorDictBase¶
在环境中执行一步。
Step 接受一个参数 tensordict，其中通常包含一个“action”键，指示要采取的动作。Step 将调用一个非原地的私有方法 _step，这是 EnvBase 子类需要重写的方法。
- 参数:
tensordict (TensorDictBase) – 包含要采取动作的张量字典。如果输入的 tensordict 包含一个
"next"条目，则其中包含的值将优先于新计算的值。这提供了一种覆盖底层计算的机制。- 返回:
输入的 tensordict，在其原位被修改，包含结果观察值、完成状态和奖励（+如果需要，还包含其他信息）。
- step_and_maybe_reset(tensordict: TensorDictBase) tuple[tensordict.base.TensorDictBase, tensordict.base.TensorDictBase]¶
在环境中运行一步，并在需要时（部分）重置环境。
- 参数:
tensordict (TensorDictBase) –
step()方法的输入数据结构。
此方法允许轻松编写不停歇的轨迹采集函数。
示例
>>> 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 定义的下一状态来更新环境的状态。结果张量字典包含更新后的观察值和任何其他相关的状态信息，其键按照环境的规范进行管理。
在内部，此方法利用预计算的
_StepMDP实例来高效处理状态、观察值、动作、奖励和完成键的转换。_StepMDP类通过预计算要包含和排除的键来优化过程，减少重复调用时的运行时开销。_StepMDP实例使用 exclude_action=False 创建，这意味着动作键保留在根张量字典中。- 参数:
next_tensordict (TensorDictBase) – 包含环境在下一时间步状态的张量字典。此张量字典应包含观察值、动作、奖励和完成标志的键，这些键由环境的规范定义。
- 返回:
一个表示环境状态推进一步后的新张量字典。
- 返回类型:
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]) EnvBase¶
移动和/或转换参数和缓冲区。
可以按以下方式调用：
- to(device=None, dtype=None, non_blocking=False)
- to(dtype, non_blocking=False)
- to(tensor, non_blocking=False)
- to(memory_format=torch.channels_last)
它的签名类似于
torch.Tensor.to()，但只接受浮点或复数dtype。此外，此方法仅将浮点或复数参数和缓冲区转换为dtype（如果给定）。整数参数和缓冲区将被移动到device（如果给定），但 dtype 不变。当设置non_blocking时，如果可能，它会尝试相对于主机进行异步转换/移动，例如将具有固定内存 (pinned memory) 的 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
- xpu(device: Optional[Union[int, device]] = None) T¶
将所有模型参数和缓冲区移动到 XPU。
这也会使相关的参数和缓冲区成为不同的对象。因此，如果模块在 XPU 上运行时需要被优化，应在构建优化器之前调用此方法。
注意
此方法就地修改模块。
- 参数:
device (int, optional) – 如果指定，所有参数将被复制到该设备。
- 返回:
self
- 返回类型:
Module
- zero_grad(set_to_none: bool = True) None¶
重置所有模型参数的梯度。
更多上下文请参见
torch.optim.Optimizer下的类似函数。- 参数:
set_to_none (bool) – 将梯度设置为 None，而不是设置为零。详情请参阅
torch.optim.Optimizer.zero_grad()。
