EfficientZeroModel

class lzero.model.efficientzero_model.DynamicsNetwork(observation_shape: SequenceType, action_encoding_dim: int = 2, num_res_blocks: int = 1, num_channels: int = 64, reward_head_channels: int = 64, fc_reward_layers: SequenceType = [32], output_support_size: int = 601, flatten_output_size_for_reward_head: int = 64, downsample: bool = False, lstm_hidden_size: int = 512, last_linear_layer_init_zero: bool = True, activation: Module | None = ReLU(inplace=True), norm_type: str | None = 'BN')

基类：Module

T_destination = ~T_destination

__init__(observation_shape: SequenceType, action_encoding_dim: int = 2, num_res_blocks: int = 1, num_channels: int = 64, reward_head_channels: int = 64, fc_reward_layers: SequenceType = [32], output_support_size: int = 601, flatten_output_size_for_reward_head: int = 64, downsample: bool = False, lstm_hidden_size: int = 512, last_linear_layer_init_zero: bool = True, activation: Module | None = ReLU(inplace=True), norm_type: str | None = 'BN')

概述：

EfficientZero 算法中动态网络的定义，用于通过给定的当前潜在状态和动作来预测下一个潜在状态值前缀和奖励隐藏状态。

参数:

• observation_shape (-) – 输入观测值的形状，例如，(12, 96, 96)。

• action_encoding_dim (-) – 动作编码的维度。

• num_res_blocks (-) – EfficientZero 模型中 res 块的数量。

• num_channels (-) – 潜在状态的通道。

• reward_head_channels (-) – 奖励渠道的头部。

• fc_reward_layers (-) – 奖励头（MLP头）的隐藏层数量。

• output_support_size (-) – 分类奖励输出的尺寸。

• flatten_output_size_for_reward_head (-) – 奖励头的输出展平大小，即奖励头的输入大小。

• downsample (-) – 是否对输入的观测值进行下采样，默认设置为 False。

• lstm_hidden_size (-) – 动力网络中LSTM的隐藏层大小。

• last_linear_layer_init_zero (-) – 是否为奖励mlp的最后一层使用零初始化，默认设置为True。

• activation (-) – 网络中使用的激活函数，通常使用就地操作来加速，例如 ReLU(inplace=True)。

• norm_type (-) – 网络中的归一化类型。默认设置为 ‘BN’。

_apply(fn, recurse=True)

_backward_hooks: Dict[int, Callable]

_backward_pre_hooks: Dict[int, Callable]

_buffers: Dict[str, Tensor | None]

_call_impl(*args, **kwargs)

_compiled_call_impl: Callable | None = None

_forward_hooks: Dict[int, Callable]

_forward_hooks_always_called: Dict[int, bool]

_forward_hooks_with_kwargs: Dict[int, bool]

_forward_pre_hooks: Dict[int, Callable]

_forward_pre_hooks_with_kwargs: Dict[int, bool]

_get_backward_hooks()

返回用于调用函数中的后向钩子。

它返回两个列表，一个包含完整的反向钩子，另一个包含非完整的反向钩子。

_get_backward_pre_hooks()

_get_name()

_is_full_backward_hook: bool | None

_load_from_state_dict(state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs)

仅将参数和缓冲区从 state_dict 复制到此模块，而不复制到其子模块。

这会在 load_state_dict() 中的每个子模块上调用。输入 state_dict 中为此模块保存的元数据作为 local_metadata 提供。对于没有元数据的 state dict，local_metadata 为空。子类可以使用 local_metadata.get(“version”, None) 处的版本号实现类特定的向后兼容加载。此外，local_metadata 还可以包含键 assign_to_params_buffers，该键指示是否应将键分配给 state_dict 中相应的张量。

备注

state_dict 与输入到 load_state_dict() 的 state_dict 不是同一个对象。因此可以对其进行修改。

参数:

• state_dict (dict) – 包含参数和持久缓冲区的字典。

• prefix (str) – 本模块中用于参数和缓冲区的前缀

• local_metadata (dict) – 包含此模块元数据的字典。请参阅

• strict (bool) – 是否严格强制 state_dict 中带有 prefix 的键与该模块中的参数和缓冲区的名称匹配

• missing_keys (list of str) – 如果 strict=True，将缺失的键添加到此列表中

• unexpected_keys (list of str) – 如果 strict=True，将意外的键添加到此列表中

• error_msgs (list of str) – 错误信息应添加到此列表中，并将在 load_state_dict() 中一起报告。

_load_state_dict_post_hooks: Dict[int, Callable]

_load_state_dict_pre_hooks: Dict[int, Callable]

_maybe_warn_non_full_backward_hook(inputs, result, grad_fn)

_modules: Dict[str, 'Module' | None]

_named_members(get_members_fn, prefix='', recurse=True, remove_duplicate: bool = True)

帮助生成模块的各种名称 + 成员。

_non_persistent_buffers_set: Set[str]

_parameters: Dict[str, Parameter | None]

_register_load_state_dict_pre_hook(hook, with_module=False)

详情请参阅 register_load_state_dict_pre_hook()。

一个微妙的区别是，如果 with_module 设置为 False，那么钩子将不会把 module 作为第一个参数，而 register_load_state_dict_pre_hook() 总是把 module 作为第一个参数。

参数:

• hook (Callable) – 在加载状态字典之前将被调用的可调用钩子。

• with_module (bool, optional) – 是否将模块实例作为第一个参数传递给钩子。

_register_state_dict_hook(hook)

为 state_dict() 方法注册一个后置钩子。

它应该有以下签名:

hook(module, state_dict, prefix, local_metadata) -> None 或 state_dict

注册的钩子可以就地修改 state_dict 或返回一个新的。如果返回一个新的 state_dict，则只有当它是从 state_dict() 调用的根模块时，才会被尊重。

_replicate_for_data_parallel()

_save_to_state_dict(destination, prefix, keep_vars)

将模块状态保存到 destination 字典中。

destination 字典将包含模块的状态，但不包括其子模块。这在 state_dict() 中的每个子模块上都会被调用。

在极少数情况下，子类可以通过使用自定义逻辑覆盖此方法来实现特定于类的行为。

参数:

• destination (dict) – 一个用于存储状态的字典

• prefix (str) – 本模块中用于参数和缓冲区的前缀

_slow_forward(*input, **kwargs)

_state_dict_hooks: Dict[int, Callable]

_state_dict_pre_hooks: Dict[int, Callable]

_version: int = 1

这为 load_state_dict() 提供了更好的 BC 支持。在 state_dict() 中，版本号将作为返回的状态字典属性 _metadata 中保存，并因此被序列化。_metadata 是一个字典，其键遵循状态字典的命名约定。请参阅 _load_from_state_dict 以了解如何在加载时使用此信息。

如果在模块中添加/删除了新的参数/缓冲区，则应增加此编号，并且模块的 _load_from_state_dict 方法可以比较版本号，并在状态字典来自更改之前的情况下进行适当的更改。

_wrapped_call_impl(*args, **kwargs)

add_module(name: str, module: Module | None) → None

将一个子模块添加到当前模块。

可以通过给定的名称将模块作为属性访问。

参数:

• name (str) – 子模块的名称。可以使用给定的名称从此模块访问子模块。

• module (Module) – 要添加到模块中的子模块。

apply(fn: Callable[[Module], None]) → T

递归地将 fn 应用于每个子模块（由 .children() 返回）以及自身。

典型用途包括初始化模型的参数（另见 nn-init-doc）。

参数:

fn (Module -> None) – 要应用于每个子模块的函数

返回:

自己

返回类型:

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)
)

bfloat16() → T

将所有浮点参数和缓冲区转换为 bfloat16 数据类型。

备注

此方法就地修改模块。

返回:

自己

返回类型:

Module

buffers(recurse: bool = True) → Iterator[Tensor]

返回一个遍历模块缓冲区的迭代器。

参数:

recurse (bool) – 如果为真，则生成此模块及其所有子模块的缓冲区。否则，仅生成此模块的直接成员缓冲区。

生成器:

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)

call_super_init: bool = False

children() → Iterator[Module]

返回一个遍历直接子模块的迭代器。

生成器:

模块 – 子模块

compile(*args, **kwargs)

使用 torch.compile() 编译此模块的 forward。

此模块的 __call__ 方法被编译，所有参数都按原样传递给 torch.compile()。

有关此函数的参数详情，请参阅 torch.compile()。

cpu() → T

将所有模型参数和缓冲区移动到CPU。

备注

此方法就地修改模块。

返回:

自己

返回类型:

Module

cuda(device: int | device | None = None) → T

将所有模型参数和缓冲区移动到GPU。

这也会使关联的参数和缓冲区成为不同的对象。因此，如果模块将在GPU上进行优化时存在，则应在构造优化器之前调用它。

备注

此方法就地修改模块。

参数:

device (int, optional) – 如果指定，所有参数将被复制到该设备

返回:

自己

返回类型:

Module

double() → T

将所有浮点型参数和缓冲区转换为 double 数据类型。

备注

此方法就地修改模块。

返回:

自己

返回类型:

Module

dump_patches: bool = False

eval() → T

将模块设置为评估模式。

这仅对某些模块有影响。如果受到影响，请参阅特定模块的文档以了解其在训练/评估模式下的行为详情，例如 Dropout, BatchNorm 等。

这等同于 self.train(False)。

请参阅 locally-disable-grad-doc 以比较 .eval() 和几个可能与之混淆的类似机制。

返回:

自己

返回类型:

Module

extra_repr() → str

设置模块的额外表示。

要打印自定义的额外信息，您应该在您自己的模块中重新实现此方法。单行和多行字符串都是可接受的。

float() → T

将所有浮点型参数和缓冲区转换为 float 数据类型。

备注

此方法就地修改模块。

返回:

自己

返回类型:

Module

forward(state_action_encoding: Tensor, reward_hidden_state: Tuple[Tensor, Tensor]) → Tuple[Tensor, Tuple, Tensor]

概述：

动态网络的前向计算。根据当前的状态动作编码和奖励隐藏状态，预测下一个潜在状态、下一个奖励隐藏状态和值前缀。

参数:

• state_action_encoding (-) – 状态-动作编码，即潜在状态和动作编码的连接，形状为 (batch_size, num_channels, height, width)。

• reward_hidden_state (-) – 关于奖励的LSTM的输入隐藏状态。

返回:

The next latent state, with shape (batch_size, num_channels, height, width). - next_reward_hidden_state (torch.Tensor): The input hidden state of LSTM about reward. - value_prefix (torch.Tensor): The predicted prefix sum of value for input state.

返回类型:

• next_latent_state (torch.Tensor)

get_buffer(target: str) → Tensor

如果 target 指定的缓冲区存在，则返回该缓冲区，否则抛出错误。

有关此方法功能的更详细说明以及如何正确指定 target，请参阅 get_submodule 的文档字符串。

参数:

target – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参见 get_submodule。）

返回:

target 引用的缓冲区

返回类型:

torch.Tensor

抛出:

AttributeError – 如果目标字符串引用了一个无效的路径或解析为不是缓冲区的东西

get_dynamic_mean() → float

get_extra_state() → Any

返回要包含在模块的 state_dict 中的任何额外状态。

如果需要存储额外状态，请在你的模块中实现此功能以及相应的 set_extra_state()。此函数在构建模块的 state_dict() 时被调用。

请注意，额外的状态应该是可pickle的，以确保state_dict的序列化工作。我们仅对序列化张量提供向后兼容性保证；如果其他对象的序列化pickle形式发生变化，它们可能会破坏向后兼容性。

返回:

模块的 state_dict 中存储的任何额外状态

返回类型:

object

get_parameter(target: str) → Parameter

如果存在，则返回由 target 给出的参数，否则抛出错误。

有关此方法功能的更详细说明以及如何正确指定 target，请参阅 get_submodule 的文档字符串。

参数:

target – 要查找的参数的全限定字符串名称。（关于如何指定全限定字符串，请参见 get_submodule。）

返回:

target 引用的参数

返回类型:

torch.nn.Parameter

抛出:

AttributeError – 如果目标字符串引用了一个无效的路径或解析为不是 nn.Parameter 的内容

get_reward_mean() → Tuple[ndarray, float]

get_submodule(target: str) → Module

如果存在，返回由 target 指定的子模块，否则抛出错误。

例如，假设你有一个 nn.Module A ，它看起来像这样：

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.Module A。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) 的，其中 N 是传递模块的数量。因此，对于检查某个子模块是否存在的简单检查，应始终使用 get_submodule。

参数:

target – 要查找的子模块的完全限定字符串名称。（请参见上面的示例，了解如何指定完全限定的字符串。）

返回:

由 target 引用的子模块

返回类型:

torch.nn.Module

抛出:

AttributeError – 如果目标字符串引用了一个无效的路径或解析为不是 nn.Module 的内容

half() → T

将所有浮点型参数和缓冲区转换为 half 数据类型。

备注

此方法就地修改模块。

返回:

自己

返回类型:

Module

ipu(device: int | device | None = None) → T

将所有模型参数和缓冲区移动到 IPU。

这也会使关联的参数和缓冲区成为不同的对象。因此，如果模块将在IPU上进行优化，则应在构建优化器之前调用此方法。

备注

此方法就地修改模块。

参数:

device (int, optional) – 如果指定，所有参数将被复制到该设备

返回:

自己

返回类型:

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() 函数返回的键匹配。默认值：True

• assign (bool, optional) – 当 False 时，当前模块中张量的属性会被保留，而当 True 时，状态字典中张量的属性会被保留。唯一的例外是 Parameter 的 requires_grad 字段，该字段的值会从模块中保留。默认值：False

返回:

• missing_keys 是一个包含任何预期键的 str 列表

  此模块中存在但未在提供的 state_dict 中出现的。

• unexpected_keys 是一个包含未预料到的键的 str 列表。

  此模块预期但未在提供的 state_dict 中出现。

返回类型:

带有 missing_keys 和 unexpected_keys 字段的 NamedTuple

备注

如果一个参数或缓冲区被注册为 None ，并且其对应的键存在于 state_dict 中，load_state_dict() 将引发一个 RuntimeError 。

modules() → Iterator[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: int | device | None = None) → T

将所有模型参数和缓冲区移动到MTIA。

这也会使关联的参数和缓冲区成为不同的对象。因此，如果模块将在MTIA上进行优化，则应在构造优化器之前调用它。

备注

此方法就地修改模块。

参数:

device (int, optional) – 如果指定，所有参数将被复制到该设备

返回:

自己

返回类型:

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: Set[Module] | None = 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) – 如果为真，则生成此模块及其所有子模块的参数。否则，仅生成此模块的直接成员参数。

• 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())

parameters(recurse: bool = True) → Iterator[Parameter]

返回一个遍历模块参数的迭代器。

这通常传递给一个优化器。

参数:

recurse (bool) – 如果为真，则生成此模块及其所有子模块的参数。否则，仅生成此模块的直接成员参数。

生成器:

参数 – 模块参数

示例:

>>> # 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)

register_backward_hook(hook: Callable[[Module, Tuple[Tensor, ...] | Tensor, Tuple[Tensor, ...] | Tensor], None | Tuple[Tensor, ...] | Tensor]) → RemovableHandle

在模块上注册一个反向钩子。

此函数已被 register_full_backward_hook() 取代，并且此函数的行为将在未来版本中发生变化。

返回:

一个可以通过调用 handle.remove() 来移除添加的钩子的句柄

返回类型:

torch.utils.hooks.RemovableHandle

register_buffer(name: str, tensor: Tensor | None, 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: Callable[[T, Tuple[Any, ...], Any], Any | None] | Callable[[T, Tuple[Any, ...], Dict[str, Any], Any], Any | None], *, prepend: bool = False, with_kwargs: bool = False, always_call: bool = False) → RemovableHandle

在模块上注册一个前向钩子。

钩子将在每次 forward() 计算输出后被调用。

如果 with_kwargs 是 False 或未指定，输入仅包含传递给模块的位置参数。关键字参数不会传递给钩子，只会传递给 forward 。钩子可以修改输出。它可以就地修改输入，但这不会影响前向传播，因为这是在调用 forward() 之后调用的。钩子应具有以下签名:

hook(module, args, output) -> None or modified output

如果 with_kwargs 是 True，前向钩子将被传递给前向函数的 kwargs，并期望返回可能被修改的输出。钩子应具有以下签名:

hook(module, args, kwargs, output) -> None or modified output

参数:

• hook (Callable) – 要注册的用户定义钩子。

• prepend (bool) – 如果 True，提供的 hook 将在该 torch.nn.modules.Module 上的所有现有 forward 钩子之前触发。否则，提供的 hook 将在该 torch.nn.modules.Module 上的所有现有 forward 钩子之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward 钩子将在通过此方法注册的所有钩子之前触发。默认值：False

• with_kwargs (bool) – 如果 True，hook 将会传递给 forward 函数的 kwargs。默认值：False

• always_call (bool) – 如果 True ，无论在调用模块时是否引发异常，都将运行 hook 。默认值： False

返回:

一个可以通过调用 handle.remove() 来移除添加的钩子的句柄

返回类型:

torch.utils.hooks.RemovableHandle

register_forward_pre_hook(hook: Callable[[T, Tuple[Any, ...]], Any | None] | Callable[[T, Tuple[Any, ...], Dict[str, Any]], Tuple[Any, Dict[str, Any]] | None], *, prepend: bool = False, with_kwargs: bool = False) → RemovableHandle

在模块上注册一个前向预钩子。

钩子将在每次调用 forward() 之前被调用。

如果 with_kwargs 为假或未指定，输入仅包含传递给模块的位置参数。关键字参数不会传递给钩子，只会传递给 forward。钩子可以修改输入。用户可以在钩子中返回一个元组或单个修改后的值。如果返回单个值（除非该值已经是元组），我们将把该值包装成一个元组。钩子应具有以下签名:

hook(module, args) -> None or modified input

如果 with_kwargs 为真，前向预钩子将传递给前向函数的 kwargs。如果钩子修改了输入，则应返回 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 钩子将在所有通过此方法注册的钩子之前触发。默认值：False

• with_kwargs (bool) – 如果为真，hook 将被传递给 forward 函数的 kwargs。默认值：False

返回:

一个可以通过调用 handle.remove() 来移除添加的钩子的句柄

返回类型:

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook: Callable[[Module, Tuple[Tensor, ...] | Tensor, Tuple[Tensor, ...] | Tensor], None | Tuple[Tensor, ...] | Tensor], prepend: bool = False) → RemovableHandle

在模块上注册一个反向钩子。

每次计算与模块相关的梯度时，钩子都会被调用，即当且仅当计算与模块输出相关的梯度时，钩子才会执行。钩子应具有以下签名:

hook(module, grad_input, grad_output) -> tuple(Tensor) or None

The grad_input 和 grad_output 是包含相对于输入和输出的梯度的元组。钩子不应修改其参数，但可以选择返回一个新的相对于输入的梯度，该梯度将用于替代 grad_input 在后续计算中。grad_input 将仅对应于作为位置参数给出的输入，所有 kwarg 参数都将被忽略。grad_input 和 grad_output 中的条目将为 None 用于所有非 Tensor 参数。

出于技术原因，当此钩子应用于模块时，其前向函数将接收传递给模块的每个张量的视图。同样，调用者将接收模块前向函数返回的每个张量的视图。

警告

在使用反向钩子时，不允许就地修改输入或输出，否则将引发错误。

参数:

• 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, Tuple[Tensor, ...] | Tensor], None | Tuple[Tensor, ...] | Tensor], prepend: bool = False) → RemovableHandle

在模块上注册一个反向预钩子。

每次计算模块的梯度时，都会调用该钩子。钩子应具有以下签名:

hook(module, grad_output) -> tuple[Tensor] or None

The grad_output 是一个元组。钩子不应修改其参数，但它可以选择返回一个新的相对于输出的梯度，该梯度将用于替代 grad_output 在后续计算中。grad_output 中的条目对于所有非 Tensor 参数将为 None。

出于技术原因，当此钩子应用于模块时，其前向函数将接收传递给模块的每个张量的视图。同样，调用者将接收模块前向函数返回的每个张量的视图。

警告

在使用反向钩子时，不允许就地修改输入，否则将引发错误。

参数:

• 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

register_load_state_dict_post_hook(hook)

注册一个在模块的 load_state_dict() 方法调用后运行的后置钩子。

它应该有以下签名:

hook(module, incompatible_keys) -> None

module 参数是当前注册此钩子的模块，而 incompatible_keys 参数是一个由属性 missing_keys 和 unexpected_keys 组成的 NamedTuple。missing_keys 是一个包含缺失键的 str 的 list，而 unexpected_keys 是一个包含意外键的 str 的 list。

如果需要，可以就地修改给定的 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: Module | None) → None

别名 add_module()。

register_parameter(name: str, param: Parameter | None) → 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训练）。

请参阅 locally-disable-grad-doc 以比较 .requires_grad_() 和几个可能与之混淆的类似机制。

参数:

requires_grad (bool) – 是否应在此模块的参数上记录自动求导操作。默认值：True。

返回:

自己

返回类型:

Module

set_extra_state(state: Any) → None

设置包含在加载的 state_dict 中的额外状态。

此函数从 load_state_dict() 调用，以处理在 state_dict 中找到的任何额外状态。如果你的模块需要在 state_dict 中存储额外状态，请实现此函数以及相应的 get_extra_state()。

参数:

state (dict) – 来自 state_dict 的额外状态

set_submodule(target: str, module: Module) → None

如果存在由 target 指定的子模块，则设置该子模块，否则抛出错误。

例如，假设你有一个 nn.Module A ，它看起来像这样：

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.Module A。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 – 如果目标字符串为空

• AttributeError – 如果目标字符串引用了一个无效的路径或解析为不是 nn.Module 的内容

share_memory() → T

参见 torch.Tensor.share_memory_()。

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) – 默认情况下，状态字典中返回的 Tensor 是与自动求导分离的。如果设置为 True，则不会执行分离操作。默认值：False。

返回:

包含模块整个状态的字典

返回类型:

dict

示例:

>>> # xdoctest: +SKIP("undefined vars")
>>> module.state_dict().keys()
['bias', 'weight']

to(*args, **kwargs)

移动和/或转换参数和缓冲区。

这可以被称为

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 ，如果给出，但数据类型保持不变。当 non_blocking 被设置时，它会尝试尽可能地异步转换/移动，例如，将具有固定内存的CPU张量移动到CUDA设备。

请参见以下示例。

备注

此方法就地修改模块。

参数:

• device (torch.device) – 此模块中参数和缓冲区的所需设备

• dtype (torch.dtype) – 此模块中参数和缓冲区的所需浮点数或复数数据类型

• tensor (torch.Tensor) – 张量的dtype和设备是此模块中所有参数和缓冲区的期望dtype和设备

• memory_format (torch.memory_format) – 此模块中4D参数和缓冲区的所需内存格式（仅关键字参数）

返回:

自己

返回类型:

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: int | str | device | None, recurse: bool = True) → T

将参数和缓冲区移动到指定设备，而不复制存储。

参数:

• device (torch.device) – 此模块中参数和缓冲区的所需设备。

• recurse (bool) – 子模块的参数和缓冲区是否应递归地移动到指定设备。

返回:

自己

返回类型:

Module

train(mode: bool = True) → T

设置模块为训练模式。

这仅对某些模块有影响。如果受到影响，请参阅特定模块的文档以了解其在训练/评估模式下的行为详情，例如 Dropout, BatchNorm 等。

参数:

mode (bool) – 是否设置训练模式（True）或评估模式（False）。默认值：True。

返回:

自己

返回类型:

Module

training: bool

type(dst_type: dtype | str) → T

将所有参数和缓冲区转换为 dst_type。

备注

此方法就地修改模块。

参数:

dst_type (type or string) – 所需类型

返回:

自己

返回类型:

Module

xpu(device: int | device | None = None) → T

将所有模型参数和缓冲区移动到XPU。

这也会使关联的参数和缓冲区成为不同的对象。因此，如果模块将在 XPU 上进行优化，则应在构建优化器之前调用此方法。

备注

此方法就地修改模块。

参数:

device (int, optional) – 如果指定，所有参数将被复制到该设备

返回:

自己

返回类型:

Module

zero_grad(set_to_none: bool = True) → None

重置所有模型参数的梯度。

更多上下文请参见 torch.optim.Optimizer 下的类似函数。

参数:

set_to_none (bool) – 而不是设置为零，将梯度设置为 None。详情请参阅 torch.optim.Optimizer.zero_grad()。