ScriptModule¶

class torch.jit.ScriptModule[源代码][源代码]¶

C++ torch::jit::Module 的包装器，包含方法、属性和参数。

对 C++ torch::jit::Module 的包装。ScriptModule 包含方法、属性、参数和常量。这些可以通过与普通 nn.Module 相同的方式访问。

add_module(name, module)[源代码]¶

向当前模块添加一个子模块。

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

参数

name (str) – 子模块的名称。可以使用给定的名称从当前模块访问子模块
module (Module) – 要添加到模块的子模块。

apply(fn)[源代码]¶

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

典型用途包括初始化模型的参数（另请参阅 torch.nn.init）。

参数: 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()[源代码]¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

buffers(recurse=True)[源代码]¶

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

参数: recurse (bool) – 如果为 True，则产生此模块和所有子模块的缓冲区。否则，仅产生属于此模块直接成员的缓冲区。
产生: torch.Tensor – 模块缓冲区
返回类型: Iterator[Tensor]

示例

>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

children()[源代码]¶

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

产生: Module – 子模块
返回类型: Iterator[Module]

property code¶

返回 forward 方法内部图的漂亮打印表示（作为有效的 Python 语法）。

详见检查代码。

property code_with_constants¶

返回一个元组。

返回一个包含以下内容的元组：

[0] `forward` 方法内部图的漂亮打印表示（作为有效的 Python 语法）。详见 `code`。[1] 遵循 [0] 输出中 CONSTANT.cN 格式的 ConstMap。 [0] 输出中的索引是底层常量值的键。

详见检查代码。

compile(*args, **kwargs)[源代码]¶

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

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

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

cpu()[源代码]¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

cuda(device=None)[源代码]¶

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

这也使得相关的参数和缓冲区成为不同的对象。因此，如果模块在优化期间位于 GPU 上，则应在构建优化器之前调用此方法。

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

double()[源代码]¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

eval()[源代码]¶

将模块设置为评估模式。

这仅对某些模块有效。有关特定模块在训练/评估模式下的行为详情，即它们是否受影响（例如 Dropout、BatchNorm 等），请参阅其文档。

这等同于 self.train(False)。

有关 .eval() 与其他可能与之混淆的类似机制的比较，请参阅局部禁用梯度计算。

返回: 自身
返回类型: Module

extra_repr()[源代码]¶

返回模块的额外表示。

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

返回类型: str

float()[源代码]¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

get_buffer(target)[源代码]¶

返回由 target 给定的缓冲区（如果存在），否则抛出错误。

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

参数: target (str) – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的缓冲区
返回类型: torch.Tensor
抛出: AttributeError – 如果目标字符串引用了无效路径或解析到的内容不是缓冲区

get_extra_state()[源代码]¶

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

如果需要存储额外状态，请为您的模块实现此方法以及相应的 set_extra_state() 方法。构建模块的 state_dict() 时会调用此函数。

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

返回: 要存储在模块 state_dict 中的任何额外状态
返回类型: object

get_parameter(target)[源代码]¶

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

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

参数: target (str) – 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的 Parameter
返回类型: torch.nn.Parameter
抛出: AttributeError – 如果目标字符串引用了无效路径或解析到的内容不是 nn.Parameter 的实例

get_submodule(target)[源代码]¶

返回由 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_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 (str) – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上面示例。）
返回: 由 target 引用的子模块
返回类型: torch.nn.Module
抛出: AttributeError – 如果目标字符串构成的路径中的任何一点（子路径）解析到不存在的属性名称或不是 nn.Module 实例的对象。

property graph¶

返回 forward 方法内部图的字符串表示。

详见解释图。

half()[源代码]¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

property inlined_graph¶

返回 forward 方法内部图的字符串表示。

此图将经过预处理，内联所有函数和方法调用。详见解释图。

ipu(device=None)[源代码]¶

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

这也使得相关的参数和缓冲区成为不同的对象。因此，如果模块在优化期间位于 IPU 上，则应在构建优化器之前调用此方法。

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

load_state_dict(state_dict, strict=True, assign=False)[源代码]¶

将参数和缓冲区从 state_dict 复制到此模块及其后代。

如果 strict 为 True，则 state_dict 的键必须与此模块的 state_dict() 函数返回的键完全匹配。

警告

如果 assign 为 True，则除非 get_swap_module_params_on_conversion() 为 True，否则优化器必须在调用 load_state_dict 之后创建。

参数

state_dict (dict) – 包含参数和持久化缓冲区的字典。
strict (bool, optional) – 是否严格要求 state_dict 中的键与此模块的 state_dict() 函数返回的键匹配。默认值：True
assign (bool, optional) – 当设置为 False 时，当前模块中张量的属性将被保留；而设置为 True 时，则保留 state dict 中张量的属性。唯一的例外是默认值：``False`` 的 requires_grad 字段

返回

missing_keys 是一个字符串列表，包含此模块
预期但提供的 state_dict 中缺失的所有键。
unexpected_keys 是一个字符串列表，包含此模块未预期
但存在于提供的 state_dict 中的键。

返回类型

NamedTuple，包含 missing_keys 和 unexpected_keys 字段

注意

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

modules()[source]¶

返回网络中所有模块的迭代器。

产生: Module – 网络中的一个模块
返回类型: 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=None)[source]¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

named_buffers(prefix='', recurse=True, remove_duplicate=True)[source]¶

返回模块缓冲区的迭代器，同时生成缓冲区的名称以及缓冲区本身。

参数

prefix (str) – 前缀，将添加到所有缓冲区名称之前。
recurse (bool, optional) – 如果为 True，则生成此模块和所有子模块的缓冲区。否则，只生成此模块的直接成员缓冲区。默认为 True。
remove_duplicate (bool, optional) – 是否移除结果中重复的缓冲区。默认为 True。

产生

(str, torch.Tensor) – 包含名称和缓冲区的元组

返回类型

Iterator[tuple[str, torch.Tensor]]

示例

>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())

named_children()[source]¶

返回直接子模块的迭代器，同时生成模块的名称以及模块本身。

产生: (str, Module) – 包含名称和子模块的元组
返回类型: Iterator[tuple[str, ‘Module’]]

示例

>>> for name, module in model.named_children():
>>>     if name in ['conv4', 'conv5']:
>>>         print(module)

named_modules(memo=None, prefix='', remove_duplicate=True)[source]¶

返回网络中所有模块的迭代器，同时生成模块的名称以及模块本身。

参数

memo (Optional[set['Module']]) – 一个备忘录，用于存储已添加到结果中的模块集合
prefix (str) – 将添加到模块名称的前缀
remove_duplicate (bool) – 是否移除结果中重复的模块实例

产生

(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='', recurse=True, remove_duplicate=True)[source]¶

返回模块参数的迭代器，同时生成参数的名称以及参数本身。

参数

prefix (str) – 前缀，将添加到所有参数名称之前。
recurse (bool) – 如果为 True，则生成此模块和所有子模块的参数。否则，只生成此模块的直接成员参数。
remove_duplicate (bool, optional) – 是否移除结果中重复的参数。默认为 True。

产生

(str, Parameter) – 包含名称和参数的元组

返回类型

Iterator[tuple[str, torch.nn.parameter.Parameter]]

示例

>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())

parameters(recurse=True)[source]¶

返回模块参数的迭代器。

这通常会传递给优化器。

参数: recurse (bool) – 如果为 True，则生成此模块和所有子模块的参数。否则，只生成此模块的直接成员参数。
产生: Parameter – 模块参数
返回类型: Iterator[Parameter]

示例

>>> 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)[source]¶

在模块上注册一个后向 hook。

此函数已被弃用，推荐使用 register_full_backward_hook()，并且此函数的行为将在未来版本中更改。

返回: 一个句柄，可以通过调用 handle.remove() 来移除添加的 hook
返回类型: torch.utils.hooks.RemovableHandle

register_buffer(name, tensor, persistent=True)[source]¶

向模块添加一个缓冲区。

这通常用于注册不应被视为模型参数的缓冲区。例如，BatchNorm 的 running_mean 不是参数，而是模块状态的一部分。默认情况下，缓冲区是持久化的，并将与参数一起保存。可以通过将 persistent 设置为 False 来更改此行为。持久化缓冲区和非持久化缓冲区之间的唯一区别是，后者不会成为此模块 state_dict 的一部分。

可以使用给定的名称作为属性访问缓冲区。

参数

name (str) – 缓冲区的名称。可以使用给定名称从此模块访问缓冲区
tensor (Tensor or None) – 要注册的缓冲区。如果为 None，则在缓冲区上运行的操作（例如 cuda）将被忽略。如果为 None，则缓冲区将**不**包含在此模块的 state_dict 中。
persistent (bool) – 缓冲区是否为此模块 state_dict 的一部分。

示例

>>> self.register_buffer('running_mean', torch.zeros(num_features))

register_forward_hook(hook, *, prepend=False, with_kwargs=False, always_call=False)[source]¶

在模块上注册一个前向 hook。

每次 forward() 计算出输出后，都会调用此 hook。

如果 with_kwargs 为 False 或未指定，则输入仅包含传递给模块的位置参数。关键字参数不会传递给 hook，只会传递给 forward。Hook 可以修改输出。它可以就地修改输入，但对 forward 没有影响，因为它是在调用 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.Module 上的所有现有 forward hooks 之前触发。否则，提供的 hook 将在此 torch.nn.Module 上的所有现有 forward hooks 之后触发。请注意，通过 register_module_forward_hook() 注册的全局 forward hooks 将在此方法注册的所有 hooks 之前触发。默认值：False
with_kwargs (bool) – 如果为 True，则 hook 将接收传递给 forward 函数的 kwargs。默认值：False
always_call (bool) – 如果为 True，则无论在调用 Module 时是否引发异常，hook 都会运行。默认值：False

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_forward_pre_hook(hook, *, prepend=False, with_kwargs=False)[source]¶

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

每次调用 forward() 之前都会调用此 hook。

如果 with_kwargs 为 false 或未指定，则输入仅包含传递给模块的位置参数。关键字参数不会传递给 hooks，只会传递给 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.Module 上的所有现有 forward_pre hooks 之前触发。否则，提供的 hook 将在此 torch.nn.Module 上的所有现有 forward_pre hooks 之后触发。请注意，通过 register_module_forward_pre_hook() 注册的全局 forward_pre hooks 将在此方法注册的所有 hooks 之前触发。默认值：False
with_kwargs (bool) – 如果为 true，则 hook 将接收传递给 forward 函数的 kwargs。默认值：False

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook, prepend=False)[source]¶

在模块上注册一个后向 hook。

每次计算相对于模块的梯度时，都会调用此 hook，即，当且仅当计算了相对于模块输出的梯度时，hook 才会执行。Hook 应具有以下签名

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

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

出于技术原因，将此 hook 应用于 Module 时，其 forward 函数将接收传递给 Module 的每个 Tensor 的视图。类似地，调用者将接收 Module 的 forward 函数返回的每个 Tensor 的视图。

警告

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.Module 上的所有现有 backward hooks 之前触发。否则，提供的 hook 将在此 torch.nn.Module 上的所有现有 backward hooks 之后触发。请注意，通过 register_module_full_backward_hook() 注册的全局 backward hooks 将在此方法注册的所有 hooks 之前触发。

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)[source]¶

在模块上注册一个后向预 hook。

每次计算模块的梯度时都会调用此 hook。Hook 应具有以下签名

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

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

出于技术原因，将此 hook 应用于 Module 时，其 forward 函数将接收传递给 Module 的每个 Tensor 的视图。类似地，调用者将接收 Module 的 forward 函数返回的每个 Tensor 的视图。

警告

使用后向 hook 时，不允许就地修改输入，否则将引发错误。

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.Module 上的所有现有 backward_pre hooks 之前触发。否则，提供的 hook 将在此 torch.nn.Module 上的所有现有 backward_pre hooks 之后触发。请注意，通过 register_module_full_backward_pre_hook() 注册的全局 backward_pre hooks 将在此方法注册的所有 hooks 之前触发。

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)[source]¶

注册一个后置 hook，它将在模块的 load_state_dict() 被调用后运行。

它应具有以下签名：: hook(module, incompatible_keys) -> None

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

如果需要，可以原地修改给定的 incompatible_keys。

请注意，当调用 load_state_dict() 并设置 strict=True 时执行的检查会受到 Hook 对 missing_keys 或 unexpected_keys 所做的修改的影响，这符合预期。向任何一组键添加内容都会在 strict=True 时导致错误抛出，而清空缺失键和意外键则可以避免错误。

返回: 一个句柄，可以通过调用 handle.remove() 来移除添加的 hook
返回类型: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)[源码]¶

注册一个前置 Hook，在调用模块的 load_state_dict() 之前运行。

它应具有以下签名：: hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950

参数: hook (Callable) – 可调用 Hook，将在加载 state dict 之前调用。

register_module(name, module)[源码]¶

add_module() 的别名。

register_parameter(name, param)[源码]¶

向模块添加一个参数。

参数可以通过给定的名称作为属性访问。

参数

name (str) – 参数的名称。可以使用此模块通过给定的名称访问该参数
param (Parameter or None) – 要添加到模块的参数。如果为 None，则对参数进行的操作，例如 cuda，将被忽略。如果为 None，则该参数不包含在模块的 state_dict 中。

register_state_dict_post_hook(hook)[源码]¶

为 state_dict() 方法注册后置 Hook。

它应具有以下签名：: hook(module, state_dict, prefix, local_metadata) -> None

注册的 Hook 可以原地修改 state_dict。

register_state_dict_pre_hook(hook)[源码]¶

为 state_dict() 方法注册前置 Hook。

它应具有以下签名：: hook(module, prefix, keep_vars) -> None

注册的 Hook 可用于在调用 state_dict 之前执行预处理。

requires_grad_(requires_grad=True)[源码]¶

更改 autograd 是否应记录此模块中参数的操作。

此方法原地设置参数的 requires_grad 属性。

此方法有助于冻结模块的一部分以进行微调，或单独训练模型的一部分（例如，GAN 训练）。

有关 .requires_grad_() 和可能与之混淆的几种类似机制之间的比较，请参阅局部禁用梯度计算。

参数: requires_grad (bool) – autograd 是否应记录此模块中参数的操作。默认值：True。
返回: 自身
返回类型: Module

save(f, **kwargs)[源码]¶

使用文件类对象保存。

save(f, _extra_files={})

请参阅接受文件类对象的 torch.jit.save。此函数 torch.save() 将对象转换为字符串，将其视为路径。在涉及 'f' 参数功能时，请勿混淆这两个函数。

set_extra_state(state)[源码]¶

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

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

参数: state (dict) – 来自 state_dict 的额外状态。

set_submodule(target, module, strict=False)[源码]¶

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

注意

如果 strict 设置为 False (默认)，该方法将替换现有子模块或在父模块存在时创建新子模块。如果 strict 设置为 True，该方法将仅尝试替换现有子模块，如果子模块不存在则抛出错误。

例如，假设您有一个看起来像这样的 nn.Module A

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(3, 3, 3)
        )
        (linear): Linear(3, 3)
    )
)

(图表展示了一个 nn.Module A。A 有一个嵌套子模块 net_b，net_b 本身有两个子模块 net_c 和 linear。net_c 接着有一个子模块 conv。)

要用新的子模块 Linear 覆盖 Conv2d，您可以调用 set_submodule("net_b.net_c.conv", nn.Linear(1, 1))，其中 strict 可以是 True 或 False。

要向现有模块 net_b 添加一个新的子模块 Conv2d，您可以调用 set_submodule("net_b.conv", nn.Conv2d(1, 1, 1))。

在上面的例子中，如果您设置 strict=True 并调用 set_submodule("net_b.conv", nn.Conv2d(1, 1, 1), strict=True)，将引发 AttributeError，因为 net_b 没有名为 conv 的子模块。

参数

target (str) – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上面示例。）
module (Module) – 要设置子模块的模块。
strict (bool) – 如果为 False，该方法将替换现有子模块或在父模块存在时创建新子模块。如果为 True，该方法将仅尝试替换现有子模块，如果子模块尚不存在则抛出错误。

抛出

ValueError – 如果 target 字符串为空或如果 module 不是 nn.Module 的实例。
AttributeError – 如果沿 target 字符串形成的路径在任何时候（子）路径解析为不存在的属性名称或不是 nn.Module 实例的对象。

share_memory()[源码]¶

参阅 torch.Tensor.share_memory_()。

返回类型: T

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 从 autograd 中分离。如果将其设置为 True，将不执行分离。默认值：False。

返回

包含模块整体状态的字典

返回类型

dict

示例

>>> 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 (如果给出)，但 dtype 保持不变。当设置 non_blocking 时，如果可能，它会尝试相对于主机异步进行转换/移动，例如，将带有 pinned memory 的 CPU 张量移动到 CUDA 设备。

请参阅下面的示例。

注意

此方法会就地修改模块。

参数

device (torch.device) – 此模块中参数和缓冲区的期望设备
dtype (torch.dtype) – 此模块中参数和缓冲区的期望浮点或复数 dtype
tensor (torch.Tensor) – 其 dtype 和 device 是此模块中所有参数和缓冲区的期望 dtype 和 device 的张量
memory_format (torch.memory_format) – 此模块中 4D 参数和缓冲区的期望内存格式（仅关键字参数）

返回

自身

返回类型

Module

示例

>>> 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)
>>> 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, recurse=True)[源码]¶

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

参数

device (torch.device) – 此模块中参数和缓冲区的期望设备。
recurse (bool) – 是否应递归地将子模块的参数和缓冲区移动到指定设备。

返回

自身

返回类型

Module

train(mode=True)[源码]¶

将模块设置为训练模式。

这仅对某些模块有效。有关它们在训练/评估模式下的行为细节，即它们是否受影响，请参阅特定模块的文档，例如 Dropout、BatchNorm 等。

参数: mode (bool) – 是否设置训练模式 (True) 或评估模式 (False)。默认值：True。
返回: 自身
返回类型: Module

type(dst_type)[源码]¶

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

注意

此方法会就地修改模块。

参数: dst_type (type or string) – 期望的类型
返回: 自身
返回类型: Module

xpu(device=None)[源码]¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

zero_grad(set_to_none=True)[源码]¶

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

有关更多上下文，请参阅 torch.optim.Optimizer 下的类似函数。

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

ScriptModule¶

文档

教程

资源