评价此页

★ ★ ★ ★ ★

ScriptModule#

class torch.jit.ScriptModule[source]#

Wrapper for C++ torch::jit::Module with methods, attributes, and parameters.

A wrapper around C++ torch::jit::Module. ScriptModules contain methods, attributes, parameters, and constants. These can be accessed the same way as on a normal nn.Module.

add_module(name, module)[source]#

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

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

参数

name (str) – 子模块的名称。可以使用给定的名称从此模块访问子模块
module (Module) – child module to be added to the module.

apply(fn)[source]#

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

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

参数: fn (Module -> None) – 要应用于每个子模块的函数
返回: self
返回类型: 模块

示例

>>> @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()[source]#

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

注意

此方法就地修改模块。

返回: self
返回类型: 模块

buffers(recurse=True)[source]#

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

参数: recurse (bool) – if True, then yields buffers of this module and all submodules. Otherwise, yields only buffers that are direct members of this module.
生成: 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()[source]#

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

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

property code#

Return a pretty-printed representation (as valid Python syntax) of the internal graph for the forward method.

See Inspecting Code for details.

property code_with_constants#

Return a tuple.

Returns a tuple of

[0] a pretty-printed representation (as valid Python syntax) of the internal graph for the forward method. See code. [1] a ConstMap following the CONSTANT.cN format of the output in [0]. The indices in the [0] output are keys to the underlying constant’s values.

See Inspecting Code for details.

compile(*args, **kwargs)[source]#

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

This Module’s __call__ method is compiled and all arguments are passed as-is to torch.compile().

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

cpu()[source]#

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

注意

此方法就地修改模块。

返回: self
返回类型: 模块

cuda(device=None)[source]#

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

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

注意

此方法就地修改模块。

参数: device (int, optional) – 如果指定，所有参数都将复制到该设备
返回: self
返回类型: 模块

double()[source]#

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

注意

此方法就地修改模块。

返回: self
返回类型: 模块

eval()[source]#

将模块设置为评估模式。

This has an effect only on certain modules. See the documentation of particular modules for details of their behaviors in training/evaluation mode, i.e. whether they are affected, e.g. Dropout, BatchNorm, etc.

This is equivalent with self.train(False).

See Locally disabling gradient computation for a comparison between .eval() and several similar mechanisms that may be confused with it.

返回: self
返回类型: 模块

extra_repr()[source]#

返回模块的额外表示。

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

返回类型: str

float()[source]#

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

注意

此方法就地修改模块。

返回: self
返回类型: 模块

get_buffer(target)[source]#

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

See the docstring for get_submodule for a more detailed explanation of this method’s functionality as well as how to correctly specify target.

参数: target (str) – The fully-qualified string name of the buffer to look for. (See get_submodule for how to specify a fully-qualified string.)
返回: 由 target 引用的缓冲区
返回类型: torch.Tensor
引发: AttributeError – 如果目标字符串引用了无效的路径或解析为非缓冲区的内容。

get_extra_state()[源]#

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

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

请注意，额外的状态应该是可拾取的（picklable），以确保 state_dict 的序列化能够正常工作。我们仅为 Tensors 的序列化提供向后兼容性保证；其他对象的序列化形式如果发生变化，可能无法保证向后兼容性。

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

get_parameter(target)[源]#

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

See the docstring for get_submodule for a more detailed explanation of this method’s functionality as well as how to correctly specify target.

参数: target (str) – 要查找的 Parameter 的完全限定字符串名称。（参见 get_submodule 以了解如何指定完全限定字符串。）
返回: 由 target 引用的参数
返回类型: 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)，其中 N 是传递模块的数量。因此，对于检查某个子模块是否存在这个简单场景，应始终使用 get_submodule。

参数: target (str) – 要查找的子模块的完全限定字符串名称。（参见上面的示例了解如何指定完全限定字符串。）
返回: 由 target 引用的子模块
返回类型: torch.nn.Module
引发: AttributeError – 如果在目标字符串解析出的路径中的任何一点，(子)路径解析为不存在的属性名，或者解析为一个不是 nn.Module 实例的对象。

property graph#

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

有关详细信息，请参阅解释图。

half()[源]#

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

注意

此方法就地修改模块。

返回: self
返回类型: 模块

property inlined_graph#

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

此图将经过预处理，内联所有函数和方法调用。有关详细信息，请参阅解释图。

ipu(device=None)[源]#

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

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

注意

此方法就地修改模块。

参数: device (int, optional) – 如果指定，所有参数都将复制到该设备
返回: self
返回类型: 模块

load_state_dict(state_dict, strict=True, assign=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 时则保留 state_dict 中张量的属性。唯一的例外是 Parameter 的 requires_grad 字段，此时将保留模块的值。默认值：False。

返回

missing_keys 是一个包含此模块期望但
在提供的 state_dict 中缺失的任何键的字符串列表。
unexpected_keys 是一个字符串列表，包含此模块
不期望但在提供的 state_dict 中存在的键。

返回类型

NamedTuple，包含 missing_keys 和 unexpected_keys 字段。

注意

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

modules()[源]#

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

生成: 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)[源]#

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

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

注意

此方法就地修改模块。

参数: device (int, optional) – 如果指定，所有参数都将复制到该设备
返回: self
返回类型: 模块

named_buffers(prefix='', recurse=True, remove_duplicate=True)[源]#

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

参数

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()[源]#

返回对直接子模块的迭代器，生成模块的名称和模块本身。

生成: (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)[源]#

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

参数

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)[源]#

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

参数

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)[源]#

返回模块参数的迭代器。

这通常传递给优化器。

参数: 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)[源]#

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

此函数已弃用，推荐使用 register_full_backward_hook()，并且此函数的功能在未来版本中将发生变化。

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

register_buffer(name, tensor, persistent=True)[源]#

向模块添加一个缓冲区。

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

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

参数

name (str) – 缓冲区的名称。可以使用给定名称从此模块访问缓冲区
tensor (Tensor 或 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)[源]#

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

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

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

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

如果 with_kwargs 为 True，则 forward 钩子将接收传递给 forward 函数的 kwargs，并应返回可能已修改的输出。钩子应具有以下签名：

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

参数

hook (Callable) – 用户定义的待注册钩子。
prepend (bool) – 如果为 True，则提供的 hook 将在对此 torch.nn.Module 的所有现有 forward 钩子之前触发。否则，提供的 hook 将在所有现有 forward 钩子之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward 钩子将在通过此方法注册的所有钩子之前触发。默认为 False。
with_kwargs (bool) – 如果为 True，则钩子将接收传递给 forward 函数的 kwargs。默认为 False。
always_call (bool) – 如果为 True，无论在调用 Module 时是否引发异常，都会运行钩子。默认为 False。

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_forward_pre_hook(hook, *, prepend=False, with_kwargs=False)[源]#

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

每次调用 forward() 之前，都会调用此钩子。

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

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

如果 with_kwargs 为 true，则 forward pre-hook 将接收传递给 forward 函数的 kwargs。如果钩子修改了输入，则应同时返回 args 和 kwargs。钩子应具有以下签名：

hook(module, args, kwargs) -> None or a tuple of modified input and kwargs

参数

hook (Callable) – 用户定义的待注册钩子。
prepend (bool) – 如果为 true，则提供的 hook 将在对此 torch.nn.Module 的所有现有 forward_pre 钩子之前触发。否则，提供的 hook 将在所有现有 forward_pre 钩子之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre 钩子将在通过此方法注册的所有钩子之前触发。默认为 False。
with_kwargs (bool) – 如果为 true，则钩子将接收传递给 forward 函数的 kwargs。默认为 False。

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook, prepend=False)[源]#

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

每次计算相对于模块的梯度时，将调用此钩子，其触发规则如下：

通常，钩子在计算相对于模块输入的梯度时触发。

如果模块输入都不需要梯度，则在计算相对于模块输出的梯度时触发钩子。

如果模块输出都不需要梯度，则钩子将不触发。

钩子应具有以下签名

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

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

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

警告

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

参数

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

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)[源]#

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

每次计算模块的梯度时，将调用此钩子。钩子应具有以下签名

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

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

警告

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

参数

hook (Callable) – 要注册的用户定义钩子。
prepend (bool) – 如果为 true，则提供的 hook 将在对此 torch.nn.Module 的所有现有 backward_pre 钩子之前触发。否则，提供的 hook 将在所有现有 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 参数是一个 NamedTuple，包含 missing_keys 和 unexpected_keys 属性。missing_keys 是一个包含缺失键的 list of str，而 unexpected_keys 是一个包含意外键的 list of str。

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

请注意，在调用 load_state_dict() 时，如果 strict=True，那么钩子对 missing_keys 或 unexpected_keys 的修改会按预期影响检查。向这两个集合中的任何一个添加元素，都会在 strict=True 时引发错误，而清空这两个集合则可以避免错误。

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

register_load_state_dict_pre_hook(hook)[源]#

注册一个预钩子，用于在模块的 load_state_dict() 被调用之前运行。

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

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

register_module(name, module)[源]#

是 add_module() 的别名。

register_parameter(name, param)[源]#

向模块添加一个参数。

可以使用给定名称作为属性访问该参数。

参数

name (str) – 参数的名称。可以使用给定名称从此模块访问该参数
param (Parameter 或 None) – 要添加到模块的参数。如果为 None，则在参数上运行的操作（如 cuda）将被忽略。如果为 None，则该参数 **不** 包含在模块的 state_dict 中。

register_state_dict_post_hook(hook)[源]#

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

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

注册的钩子可以就地修改 state_dict。

register_state_dict_pre_hook(hook)[源]#

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

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

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

requires_grad_(requires_grad=True)[源]#

更改自动梯度是否应记录此模块中参数的操作。

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

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

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

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

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。

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

在上述示例中，如果您设置 strict=True 并调用 set_submodule("net_b.conv", nn.Conv2d(1, 1, 1), strict=True)，由于 net_b 中不存在名为 conv 的子模块，因此会引发 AttributeError。

参数

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

引发

ValueError – 如果 target 字符串为空，或者如果 module 不是 nn.Module 的实例。
AttributeError – 如果在目标字符串解析出的路径中的任何一点，(子)路径解析为不存在的属性名，或者解析为一个不是 nn.Module 实例的对象。

share_memory()[源]#

请参阅 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) – 默认情况下，state_dict 中返回的 Tensor 已从自动微分中分离。如果设置为 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（如果给出），但其 dtypes 不变。当设置 non_blocking 时，它会尝试异步（相对于主机）进行转换/移动（如果可能），例如将具有固定内存的 CPU Tensors 移动到 CUDA 设备。

有关示例，请参阅下文。

注意

此方法就地修改模块。

参数

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

返回

self

返回类型

模块

示例

>>> 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) – 是否应递归地将子模块的参数和缓冲区移动到指定的设备。

返回

self

返回类型

模块

train(mode=True)[源]#

将模块设置为训练模式。

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

参数: mode (bool) – 设置训练模式（True）还是评估模式（False）。默认值：True。
返回: self
返回类型: 模块

type(dst_type)[源]#

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

注意

此方法就地修改模块。

参数: dst_type (type or string) – 所需类型
返回: self
返回类型: 模块

xpu(device=None)[源]#

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

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

注意

此方法就地修改模块。

参数: device (int, optional) – 如果指定，所有参数都将复制到该设备
返回: self
返回类型: 模块

zero_grad(set_to_none=True)[源]#

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

有关更多背景信息，请参阅 torch.optim.Optimizer 下的类似函数。

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

ScriptModule#

文档

教程

资源