EnvBase¶
- class torchrl.envs.EnvBase(*args, **kwargs)[source]¶
抽象环境父类。
- 关键字参数:
device (torch.device) – 环境的设备。无设备的环境是允许的 (device=None)。如果不为
None，所有规范都将在该设备上转换，并且预计所有输入和输出都将在该设备上。默认为None。batch_size (torch.Size 或 等效, 可选) – 环境的批次大小。对应于环境读取和写入的所有输入和输出张量字典的领先维度。默认为空批次大小。
run_type_checks (bool, 可选) – 如果
True，将在每次重置和每次步骤时进行类型检查。默认为False。allow_done_after_reset (bool, 可选) – 如果
True，则环境可以在调用reset()后完成。默认为False。
- 变量:
done_spec (CompositeSpec) – 等效于
full_done_spec，因为所有done_specs至少包含一个"done"和一个"terminated"条目action_spec (TensorSpec) – 动作的规范。如果预期只有一个动作张量，则链接到叶子动作的规范。否则链接到
full_action_spec。observation_spec (CompositeSpec) – 等效于
full_observation_spec。reward_spec (TensorSpec) – 奖励的规范。如果预期只有一个奖励张量，则链接到叶子奖励的规范。否则链接到
full_reward_spec。state_spec (CompositeSpec) – 等效于
full_state_spec。full_done_spec (CompositeSpec) – 一个复合规范，这样
full_done_spec.zero()会返回一个张量字典，其中只包含编码环境完成状态的叶子。full_action_spec (CompositeSpec) – 一个复合规范，这样
full_action_spec.zero()会返回一个张量字典，其中只包含编码环境动作的叶子。full_observation_spec (CompositeSpec) – 一个复合规范，这样
full_observation_spec.zero()会返回一个张量字典，其中只包含编码环境观察的叶子。full_reward_spec (CompositeSpec) – 一个复合规范，这样
full_reward_spec.zero()会返回一个张量字典，其中只包含编码环境奖励的叶子。full_state_spec (CompositeSpec) – 一个复合规范，这样
full_state_spec.zero()会返回一个张量字典，其中只包含编码环境输入（不包括动作）的叶子。batch_size (torch.Size) – 环境的批次大小。
device (torch.device) – 环境的输入/输出所处的设备。可以为
None。
示例
>>> from torchrl.envs import EnvBase >>> class CounterEnv(EnvBase): ... def __init__(self, batch_size=(), device=None, **kwargs): ... self.observation_spec = CompositeSpec( ... count=UnboundedContinuousTensorSpec(batch_size, device=device, dtype=torch.int64)) ... self.action_spec = UnboundedContinuousTensorSpec(batch_size, device=device, dtype=torch.int8) ... # done spec and reward spec are set automatically ... def _step(self, tensordict): ... >>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.batch_size # how many envs are run at once torch.Size([]) >>> env.input_spec CompositeSpec( full_state_spec: None, full_action_spec: CompositeSpec( action: BoundedTensorSpec( 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([])) >>> env.action_spec BoundedTensorSpec( 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) >>> env.observation_spec CompositeSpec( observation: BoundedTensorSpec( 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([])) >>> env.reward_spec UnboundedContinuousTensorSpec( shape=torch.Size([1]), space=None, device=cpu, dtype=torch.float32, domain=continuous) >>> env.done_spec DiscreteTensorSpec( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete) >>> # the output_spec contains all the expected outputs >>> env.output_spec CompositeSpec( full_reward_spec: CompositeSpec( reward: UnboundedContinuousTensorSpec( shape=torch.Size([1]), space=None, device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([])), full_observation_spec: CompositeSpec( observation: BoundedTensorSpec( 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: CompositeSpec( done: DiscreteTensorSpec( 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([]))
注意
了解更多关于动态规范和环境的信息，请点击 这里。
- property action_key: NestedKey¶
环境的动作键。
默认情况下，它将是“action”。
如果环境中存在多个动作键，则此函数将引发异常。
- property action_keys: List[NestedKey]¶
环境的动作键。
默认情况下，只有一个名为“action”的键。
键按数据树中的深度排序。
- property action_spec: TensorSpec¶
The
actionspec.The
action_spec始终存储为组合规范。如果动作规范被提供为简单规范，则将返回它。
>>> env.action_spec = UnboundedContinuousTensorSpec(1) >>> env.action_spec UnboundedContinuousTensorSpec( 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 = CompositeSpec({"nested": {"action": UnboundedContinuousTensorSpec(1)}}) >>> env.action_spec UnboundedContinuousTensorSpec( 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 = CompositeSpec({"nested": {"action": UnboundedContinuousTensorSpec(1), "another_action": DiscreteTensorSpec(1)}}) >>> env.action_spec CompositeSpec( nested: CompositeSpec( action: UnboundedContinuousTensorSpec( 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: DiscreteTensorSpec( 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 BoundedTensorSpec( 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)
- add_module(name: str, module: Optional[Module]) None¶
将子模块添加到当前模块。
可以使用给定的名称作为属性访问该模块。
- 参数：
name (str) – 子模块的名称。可以使用给定的名称从该模块访问子模块
module (Module) – 要添加到模块的子模块。
- append_transform(transform: 'Transform' | Callable[[TensorDictBase], TensorDictBase]) None[source]¶
返回一个经过转换的环境，其中应用了传递的可调用对象/转换。
- 参数：
transform (Transform 或 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) )
- 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)
- compile(*args, **kwargs)¶
使用
torch.compile()编译此模块的前向传递。此模块的 __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”。
如果环境中有多个完成键，此函数将引发异常。
- property done_keys: List[NestedKey]¶
环境的完成键。
默认情况下，只有一个名为“done”的键。
键按数据树中的深度排序。
- property done_keys_groups¶
完成键的列表，按重置键分组。
这是一个列表的列表。外部列表的长度为重置键，内部列表包含完成键（例如，done 和 truncated），当它不存在时，可以读取它们来确定重置。
- property done_spec: TensorSpec¶
The
donespec.The
done_specis always stored as a composite spec.If the done spec is provided as a simple spec, this will be returned.
>>> env.done_spec = DiscreteTensorSpec(2, dtype=torch.bool) >>> env.done_spec DiscreteTensorSpec( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
If the done spec is provided as a composite spec and contains only one leaf, this function will return just the leaf.
>>> env.done_spec = CompositeSpec({"nested": {"done": DiscreteTensorSpec(2, dtype=torch.bool)}}) >>> env.done_spec DiscreteTensorSpec( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
If the done spec is provided as a composite spec and has more than one leaf, this function will return the whole spec.
>>> env.done_spec = CompositeSpec({"nested": {"done": DiscreteTensorSpec(2, dtype=torch.bool), "another_done": DiscreteTensorSpec(2, dtype=torch.bool)}}) >>> env.done_spec CompositeSpec( nested: CompositeSpec( done: DiscreteTensorSpec( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), another_done: DiscreteTensorSpec( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
To always retrieve the full spec passed, use
>>> env.output_spec["full_done_spec"]
此属性是可变的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.done_spec DiscreteTensorSpec( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
- double() T¶
将所有浮点参数和缓冲区转换为
double数据类型。注意
此方法就地修改模块。
- 返回：
self
- 返回类型：
Module
- eval() T¶
将模块设置为评估模式。
这仅对某些模块有效。有关特定模块在训练/评估模式下的行为细节，如果它们受到影响，请参阅它们的文档，例如
Dropout,BatchNorm等。这等效于
self.train(False).有关 .eval() 与几种类似机制（可能与它混淆）之间的比较，请参见 Locally disabling gradient computation。
- 返回：
self
- 返回类型：
Module
- extra_repr() str¶
设置模块的额外表示。
要打印自定义的额外信息，您应该在自己的模块中重新实现此方法。单行字符串和多行字符串都是可以接受的。
- float() T¶
将所有浮点参数和缓冲区转换为
float数据类型。注意
此方法就地修改模块。
- 返回：
self
- 返回类型：
Module
- forward(tensordict: TensorDictBase) TensorDictBase[source]¶
定义每次调用时执行的计算。
所有子类都应该覆盖它。
注意
虽然前向传递的配方需要在此函数中定义，但应该之后调用
Module实例，而不是它，因为前者负责运行注册的挂钩，而后者则静默地忽略它们。
- property full_action_spec: CompositeSpec¶
完整的动作规范。
full_action_spec是一个CompositeSpec`实例，包含所有动作条目。示例
>>> from torchrl.envs import BraxEnv >>> for envname in BraxEnv.available_envs: ... break >>> env = BraxEnv(envname) >>> env.full_action_spec
- CompositeSpec(
- action: BoundedTensorSpec(
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: CompositeSpec¶
完整的完成规范。
full_done_spec是一个CompositeSpec`实例，包含所有完成条目。它可用于生成结构与运行时获得的结构相似的假数据。示例
>>> import gymnasium >>> from torchrl.envs import GymWrapper >>> env = GymWrapper(gymnasium.make("Pendulum-v1")) >>> env.full_done_spec CompositeSpec( done: DiscreteTensorSpec( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), truncated: DiscreteTensorSpec( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), device=cpu, shape=torch.Size([]))
- property full_reward_spec: CompositeSpec¶
完整的奖励规范。
full_reward_spec是一个CompositeSpec`实例，包含所有奖励条目。示例
>>> 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 CompositeSpec( nested: CompositeSpec( reward: UnboundedContinuousTensorSpec( 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: CompositeSpec¶
完整的状态规范。
full_state_spec是一个CompositeSpec`实例，包含所有状态条目（即不是动作的输入数据）。示例
>>> from torchrl.envs import BraxEnv >>> for envname in BraxEnv.available_envs: ... break >>> env = BraxEnv(envname) >>> env.full_state_spec CompositeSpec( state: CompositeSpec( pipeline_state: CompositeSpec( q: UnboundedContinuousTensorSpec( 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引用的缓冲区- 返回类型：
- Raises:
AttributeError – 如果目标字符串引用无效路径或解析为非缓冲区的内容
- get_extra_state() Any¶
返回要包含在模块的 state_dict 中的任何额外状态。
如果您需要存储额外状态，请为您的模块实现此函数和相应的
set_extra_state()。此函数在构建模块的 state_dict() 时调用。请注意，额外状态应可被pickle以便确保 state_dict 的序列化工作。我们只提供对序列化张量的向后兼容性保证；如果其他对象的序列化pickle形式发生变化，则可能会破坏向后兼容性。
- 返回：
存储在模块的 state_dict 中的任何额外状态
- 返回类型：
对象
- get_parameter(target: str) Parameter¶
如果存在，则返回由
target给定的参数，否则抛出错误。有关此方法功能的更详细解释以及如何正确指定
target，请参阅get_submodule的文档字符串。- 参数：
target – 要查找的参数的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅
get_submodule。）- 返回：
由
target引用的参数- 返回类型：
torch.nn.Parameter
- Raises:
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_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引用的子模块- 返回类型：
- Raises:
AttributeError – 如果目标字符串引用无效路径或解析为不是
nn.Module的内容
- half() T¶
将所有浮点参数和缓冲区转换为
half数据类型。注意
此方法就地修改模块。
- 返回：
self
- 返回类型：
Module
- property input_spec: TensorSpec¶
输入规范。
包含所有环境数据输入规范的复合规范。
它包含
“full_action_spec”：输入动作的规范
“full_state_spec”：所有其他环境输入的规范
此属性被锁定，应为只读。相反，要设置其中包含的规范，请使用相应的属性。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.input_spec CompositeSpec( full_state_spec: None, full_action_spec: CompositeSpec( action: BoundedTensorSpec( 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
- 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时，状态字典中张量的属性将被保留。唯一的例外是requires_grad字段Default: ``False`
- 返回：
- missing_keys 是一个包含预期键的 str 列表
由该模块，但缺少提供的
state_dict。
- unexpected_keys 是一个包含未预期的键的 str 列表
由该模块，但存在于提供的
state_dict中。
- 返回类型：
NamedTuple包含missing_keys和unexpected_keys字段
注意
如果参数或缓冲区注册为
None并且其对应的键存在于state_dict中，load_state_dict()将引发RuntimeError。
- maybe_reset(tensordict: TensorDictBase) TensorDictBase[source]¶
检查输入 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 (int, optional) – 如果指定，所有参数都将被复制到该设备
- 返回：
self
- 返回类型：
Module
- named_buffers(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) Iterator[Tuple[str, Tensor]]¶
返回模块缓冲区的迭代器，同时产生缓冲区的名称以及缓冲区本身。
- 参数：
prefix (str) – 要附加到所有缓冲区名称的前缀。
recurse (bool, optional) – 如果为 True，则产生此模块和所有子模块的缓冲区。否则，只产生作为此模块的直接成员的缓冲区。默认为 True。
remove_duplicate (bool, optional) – 是否在结果中删除重复的缓冲区。默认为 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, optional) – 是否在结果中删除重复的参数。默认为 True。
- 生成：
(str, Parameter) – 包含名称和参数的元组
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for name, param in self.named_parameters(): >>> if name in ['bias']: >>> print(param.size())
- property observation_spec: CompositeSpec¶
观察规范。
必须是
torchrl.data.CompositeSpec实例。规范中列出的键在重置和步骤后可以直接访问。在 TorchRL 中，尽管它们从严格意义上来说不是“观察”，但环境输出的所有信息、状态、变换结果等都存储在
observation_spec中。因此，
"observation_spec"应被视为环境输出的通用数据容器，这些输出不是完成或奖励数据。示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.observation_spec CompositeSpec( observation: BoundedTensorSpec( 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”: 所有其他环境输出的规范
此属性被锁定，应为只读。相反，要设置其中包含的规范，请使用相应的属性。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.output_spec CompositeSpec( full_reward_spec: CompositeSpec( reward: UnboundedContinuousTensorSpec( shape=torch.Size([1]), space=None, device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([])), full_observation_spec: CompositeSpec( observation: BoundedTensorSpec( 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: CompositeSpec( done: DiscreteTensorSpec( 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: Optional[TensorDictBase] = None)[source]¶
根据 action_spec 属性执行随机动作。
- 参数：
tensordict (TensorDictBase, optional) – 应写入结果动作的 tensordict。
- 返回：
一个 tensordict 对象，其中“action”条目已使用 action-spec 中的随机样本更新。
- rand_step(tensordict: Optional[TensorDictBase] = None) TensorDictBase[source]¶
根据 action_spec 属性，在环境中执行随机步骤。
- 参数：
tensordict (TensorDictBase, optional) – 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 or 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，则在该torch.nn.modules.Module上所有现有的forward钩子之前调用提供的hook。否则，在该torch.nn.modules.Module上所有现有的forward钩子之后调用提供的hook。请注意，使用register_module_forward_hook()注册的全局forward钩子将在所有使用此方法注册的钩子之前调用。默认值：Falsewith_kwargs (bool) – 如果
True，hook将会传入 forward 函数的关键字参数。默认值：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为假或未指定，则输入仅包含传递给模块的位置参数。关键字参数不会传递给钩子，只传递给forward。钩子可以修改输入。用户可以在钩子中返回元组或单个修改后的值。如果返回单个值（除非该值已经是元组），我们将把该值包装成一个元组。钩子应该具有以下签名hook(module, args) -> None or modified input
如果
with_kwargs为真，则前向预处理钩子将传入 forward 函数的关键字参数。如果钩子修改了输入，则应返回 args 和 kwargs。钩子应该具有以下签名hook(module, args, kwargs) -> None or a tuple of modified input and kwargs
- 参数：
hook (Callable) – 要注册的用户定义钩子。
prepend (bool) – 如果为真，提供的
hook将在该torch.nn.modules.Module上所有现有的forward_pre钩子之前触发。否则，提供的hook将在该torch.nn.modules.Module上所有现有的forward_pre钩子之后触发。请注意，使用register_module_forward_pre_hook()注册的全局forward_pre钩子将在通过此方法注册的所有钩子之前触发。默认值：Falsewith_kwargs (bool) – 如果为真，
hook将传入 forward 函数的关键字参数。默认值：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_input和grad_output中的条目对于所有非张量参数将为None。出于技术原因，当此钩子应用于模块时，其 forward 函数将接收传递给模块的每个张量的视图。类似地，调用者将接收模块 forward 函数返回的每个张量的视图。
警告
在使用反向钩子时，不允许对输入或输出进行就地修改，这会导致错误。
- 参数：
hook (Callable) – 要注册的用户定义的钩子。
prepend (bool) – 如果为真，提供的
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中的条目对于所有非张量参数将为None。出于技术原因，当此钩子应用于模块时，其 forward 函数将接收传递给模块的每个张量的视图。类似地，调用者将接收模块 forward 函数返回的每个张量的视图。
警告
在使用反向钩子时，不允许对输入进行就地修改，否则会引发错误。
- 参数：
hook (Callable) – 要注册的用户定义的钩子。
prepend (bool) – 如果为真，则提供的
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)[source]¶
在 gym(nasium) 中注册一个环境。
此方法的设计考虑了以下范围
将一个 TorchRL-first 环境整合到使用 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) – 要与 env 一起使用的转换（或
torchrl.envs.Compose实例中的转换列表）。此参数可以在调用make()时传递（见下面的示例）。info_keys (List[NestedKey], optional) –
如果提供，这些键将用于构建信息字典，并将从观察键中排除。此参数可以在调用
make()时传递（见下面的示例）。警告
使用
info_keys可能会导致规范为空，因为内容已移至信息字典。Gym 不喜欢规范中的空Dict，因此应使用RemoveEmptySpecs删除此空内容。backend (str, optional) – 后端。可以是 “gym” 或 “gymnasium”，或与
set_gym_backend兼容的任何其他后端。to_numpy (bool, optional) – 如果为
True，则对 step 和 reset 的调用的结果将映射到 numpy 数组。默认为False（结果为张量）。此参数可以在调用make()时传递（见下面的示例）。reward_threshold (float, optional) – [Gym kwarg] 认为已学习环境的奖励阈值。
nondeterministic (bool, optional) – [Gym kwarg 如果环境是非确定性的（即使了解初始种子和所有动作）。默认为
False。max_episode_steps (int, optional) – [Gym kwarg] 截断前的最大情节步数。由时间限制包装器使用。
order_enforce (bool, optional) – [Gym >= 0.14] 是否应应用顺序强制执行包装器以确保用户按正确顺序运行函数。默认为
True。autoreset (bool, optional) – [Gym >= 0.14] 是否应添加自动重置包装器，以便不需要调用重置。默认为
False。disable_env_checker – [Gym >= 0.14] 是否应为环境禁用环境检查器。默认为
False。apply_api_compatibility – [Gym >= 0.26] 是否应用 StepAPICompatibility 包装器。默认为
False。**kwargs – 传递给环境构造函数的任意关键字参数。
注意
TorchRL 的环境没有
"info"字典的概念，因为TensorDict提供了大多数训练设置中认为必要的存储要求。不过，您可以使用info_keys参数对什么是观察内容以及什么是信息进行细粒度控制。示例
>>> # 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是一个包含丢失键的liststr，而unexpected_keys是一个包含意外键的liststr。如果需要，可以就地修改给定的 incompatible_keys。
注意，当使用
strict=True调用load_state_dict()时执行的检查会受到挂钩对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 (Callable) – 在加载状态字典之前将调用的可调用挂钩。
- register_module(name: str, module: Optional[Module]) None¶
别名
add_module()。
- register_parameter(name: str, param: Optional[Parameter]) None¶
将参数添加到模块。
可以使用给定的名称将该参数作为属性访问。
- 参数：
name (str) – 参数的名称。可以使用给定的名称从该模块访问参数
param (Parameter or 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¶
更改是否应记录此模块中参数上的操作。
此方法就地设置参数的
requires_grad属性。此方法对于冻结模块的一部分以进行微调或单独训练模型的某些部分（例如，GAN 训练）很有帮助。
有关 .requires_grad_() 与可能与之混淆的几种类似机制之间的比较，请参阅 在本地禁用梯度计算。
- 参数：
requires_grad (bool) – 是否应记录此模块中参数上的操作。默认值：
True。- 返回：
self
- 返回类型：
Module
- reset(tensordict: Optional[TensorDictBase] = None, **kwargs) TensorDictBase[source]¶
重置环境。
对于 step 和 _step，只有私有方法
_reset应该由 EnvBase 子类覆盖。- 参数：
tensordict (TensorDictBase, optional) – 用于包含生成的新的观察结果的 tensordict。在某些情况下，此输入也可以用于将参数传递给 reset 函数。
kwargs (optional) – 要传递给本机 reset 函数的其他参数。
- 返回：
就地修改的 tensordict（或任何输入 tensordict），其中包含生成的观察结果。
- property reset_keys: List[NestedKey]¶
返回重置键的列表。
重置键是指示部分重置的键，在批量、多任务或多智能体设置中。它们被构建为
(*prefix, "_reset")，其中prefix是一个（可能是空的）字符串元组，指向可以在其中找到完成状态的 tensordict 位置。键按数据树中的深度排序。
- property reward_key¶
环境的奖励键。
默认情况下，这将为“reward”。
如果环境中存在多个奖励键，则此函数将引发异常。
- property reward_keys: List[NestedKey]¶
环境的奖励键。
默认情况下，将只有一个名为“reward”的键。
键按数据树中的深度排序。
- property reward_spec: TensorSpec¶
的
reward规范。规范始终存储为复合规范。
如果奖励规范作为简单规范提供，则将返回该规范。
>>> env.reward_spec = UnboundedContinuousTensorSpec(1) >>> env.reward_spec UnboundedContinuousTensorSpec( 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.reward_spec = CompositeSpec({"nested": {"reward": UnboundedContinuousTensorSpec(1)}}) >>> env.reward_spec UnboundedContinuousTensorSpec( 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.reward_spec = CompositeSpec({"nested": {"reward": UnboundedContinuousTensorSpec(1), "another_reward": DiscreteTensorSpec(1)}}) >>> env.reward_spec CompositeSpec( nested: CompositeSpec( reward: UnboundedContinuousTensorSpec( 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: DiscreteTensorSpec( 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 UnboundedContinuousTensorSpec( shape=torch.Size([1]), space=None, device=cpu, dtype=torch.float32, domain=continuous)
- rollout(max_steps: int, policy: Optional[Callable[[TensorDictBase], TensorDictBase]] = None, callback: Optional[Callable[[TensorDictBase, ...], Any]] = None, auto_reset: bool = True, auto_cast_to_device: bool = False, break_when_any_done: bool = True, return_contiguous: bool = True, tensordict: Optional[TensorDictBase] = None, set_truncated: bool = False, out=None)[source]¶
在环境中执行 rollout。
该函数将在包含的环境之一返回 done=True 时停止。
- 参数：
max_steps (int) – 要执行的最大步数。如果环境在执行完 max_steps 之前达到 done 状态，实际步数可能会更小。
policy (callable, optional) – 用于计算所需动作的可调用对象。如果未提供策略，则将使用
env.rand_step()调用动作。策略可以是任何可调用对象，它可以读取 tensordict 或按env.observation_spec.keys()的顺序排序的观察条目序列。callback (Callable[[TensorDict], Any], optional) – 在每次迭代时使用给定的 TensorDict 调用的函数。默认值为
None。callback的输出不会被收集，用户有责任在回调调用中保存任何结果，如果需要将数据保留在对rollout的调用之外。auto_reset (bool, optional) – 如果为
True，则在启动 rollout 时，如果环境处于 done 状态，则自动重置环境。默认值为True。auto_cast_to_device (bool, optional) – 如果为
True，则在使用策略之前，tensordict 的设备会自动转换为策略设备。默认值为False。break_when_any_done (bool) – 如果任何 done 状态为 True，则中断。如果为 False，则对处于 done 状态的子环境调用 reset()。默认值为 True。
return_contiguous (bool) – 如果为 False，则返回 LazyStackedTensorDict。默认值为 True。
tensordict (TensorDict, optional) – 如果
auto_reset为 False，则必须提供初始 tensordict。Rollout 将检查此 tensordict 是否具有 done 标志，并在这些维度（如果需要）重置环境。如果tensordict是 reset 的输出，则通常不会发生这种情况，但如果tensordict是先前 rollout 的最后一步，则可能会发生这种情况。如果auto_reset=True，也可以提供tensordict，如果需要将元数据传递给reset方法，例如批大小或无状态环境的设备。set_truncated (bool, optional) – 如果为
True，则在 rollout 完成后，"truncated"和"done"键将设置为True。如果在done_spec中未找到"truncated"，则会引发异常。截断键可以通过env.add_truncated_keys设置。默认值为False。
- 返回：
包含结果轨迹的 TensorDict 对象。
返回的数据将在 tensordict 的最后一维（在
env.ndim索引处）上标记为“时间”维度名称。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)
在某些情况下，无法获得连续的 tensordict，因为它们无法堆叠。当每一步返回的数据可能具有不同的形状，或者当将不同的环境一起执行时，就会发生这种情况。在这种情况下，
return_contiguous=False将导致返回的 tensordict 成为 tensordict 的延迟堆叠。- 非连续 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 可用于循环中模拟数据收集。为此，您需要在对它调用
step_mdp()之后，将来自先前 rollout 的最后一个 tensordict 作为输入传递。- 数据收集 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: Optional[int] = None, static_seed: bool = False) Optional[int][source]¶
设置环境的种子并返回要使用的下一个种子（如果存在单个环境，则为输入种子）。
- 参数：
seed (int) – 要设置的种子。种子仅在环境中本地设置。若要处理全局种子，请参见
manual_seed()。static_seed (bool, optional) – 如果为
True，则不会增加种子。默认值为 False。
- 返回：
例如，如果与该环境同时创建，则应用于另一个环境的种子。
- 返回类型：
表示“下一个种子”的整数。
- 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 – 要设置子模块的模块。
- Raises:
ValueError – 如果目标字符串为空。
AttributeError – 如果目标字符串引用无效路径或解析为不是
nn.Module的内容
- property shape¶
等效于
batch_size。
- property specs: CompositeSpec¶
返回一个包含所有环境的 Composite 容器。
此功能允许您创建环境，将所有规范检索到单个数据容器中，然后从工作区中删除环境。
- state_dict(*args, destination=None, prefix='', keep_vars=False)¶
返回一个字典，其中包含对模块的整个状态的引用。
包含参数和持久缓冲区（例如运行平均值）。键是相应的参数和缓冲区名称。设置为
None的参数和缓冲区不包括在内。注意
返回的对象是浅层副本。它包含对模块参数和缓冲区的引用。
警告
目前，
state_dict()还接受destination、prefix和keep_vars的位置参数。但是，此功能正在弃用，并且将在将来的版本中强制使用关键字参数。警告
请避免使用参数
destination，因为它并非为最终用户设计。- 参数：
destination (dict, optional) – 如果提供，模块的状态将更新到字典中，并返回相同对象。否则，将创建一个
OrderedDict并返回。默认：None。prefix (str, optional) – 添加到参数和缓冲区名称的，用于在 state_dict 中组合键的前缀。默认：
''。keep_vars (bool, optional) – 默认情况下，state_dict 中返回的
Tensor与自动梯度分离。如果将其设置为True，则不会执行分离。默认：False。
- 返回：
包含模块整个状态的字典。
- 返回类型：
dict
示例
>>> # xdoctest: +SKIP("undefined vars") >>> module.state_dict().keys() ['bias', 'weight']
- property state_keys: List[NestedKey]¶
环境的状态键。
默认情况下，将只有一个名为“state”的键。
键按数据树中的深度排序。
- property state_spec: CompositeSpec¶
状态规范。
必须是
torchrl.data.CompositeSpec实例。这里列出的键应作为输入，与操作一起提供给环境。在 TorchRL 中，即使它们不是严格意义上的“状态”，所有输入到环境中且不是操作的数据都存储在
state_spec中。因此，应将
"state_spec"视为环境输入的通用数据容器，这些输入不是操作数据。示例
>>> from torchrl.envs import BraxEnv >>> for envname in BraxEnv.available_envs: ... break >>> env = BraxEnv(envname) >>> env.state_spec CompositeSpec( state: CompositeSpec( pipeline_state: CompositeSpec( q: UnboundedContinuousTensorSpec( 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([]))
- step(tensordict: TensorDictBase) TensorDictBase[source]¶
在环境中执行一步。
Step 接受一个参数 tensordict，它通常包含一个“action”键，指示要执行的操作。Step 将调用一个非位置的私有方法 _step，该方法是 EnvBase 子类需要重写的。
- 参数：
tensordict (TensorDictBase) – 包含要执行的操作的 Tensordict。如果输入 tensordict 包含一个
"next"条目，则其中包含的值将优先于新计算的值。这提供了一种机制来覆盖底层计算。- 返回：
已修改的输入 tensordict，其中包含了得到的观察结果、完成状态和奖励（如果需要还包含其他内容）。
- step_and_maybe_reset(tensordict: TensorDictBase) Tuple[TensorDictBase, TensorDictBase][source]¶
在环境中执行一步，并在需要时（部分）重置它。
- 参数：
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)
- to(device: Union[device, str, int]) EnvBase[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（如果提供），但数据类型保持不变。当non_blocking设置时，它尝试异步地转换/移动到主机（如果可能），例如，将具有固定内存的 CPU 张量移动到 CUDA 设备。以下是一些示例。
注意
此方法就地修改模块。
- 参数：
设备 (
torch.device) – 此模块中参数和缓冲区的目标设备数据类型 (
torch.dtype) – 此模块中参数和缓冲区的目标浮点或复数数据类型张量 (torch.Tensor) – 数据类型和设备与此模块中所有参数和缓冲区目标数据类型和设备相同的张量
内存格式 (
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[device, str, int]], recurse: bool = True) T¶
将参数和缓冲区移动到指定的设备，但不复制存储。
- 参数：
设备 (
torch.device) – 此模块中参数和缓冲区的目标设备。递归 (bool) – 是否应将子模块的参数和缓冲区递归地移动到指定的设备。
- 返回：
self
- 返回类型：
Module
- train(mode: bool = True) T¶
将模块设置为训练模式。
这仅对某些模块有效。有关特定模块在训练/评估模式下的行为细节，如果它们受到影响，请参阅它们的文档，例如
Dropout,BatchNorm等。- 参数：
模式 (bool) – 是否设置为训练模式 (
True) 或评估模式 (False)。默认值：True。- 返回：
self
- 返回类型：
Module
- type(dst_type: Union[dtype, str]) T¶
将所有参数和缓冲区转换为
dst_type。注意
此方法就地修改模块。
- 参数：
dst_type (type 或 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()。
