模块

class torch.nn.Module(*args, **kwargs)

所有神经网络模块的基类。

您的模型也应该子类化此类。

模块还可以包含其他模块，允许您将它们嵌套在树结构中。您可以将子模块分配为常规属性

import torch.nn as nn
import torch.nn.functional as F

class Model(nn.Module):
    def __init__(self) -> None:
        super().__init__()
        self.conv1 = nn.Conv2d(1, 20, 5)
        self.conv2 = nn.Conv2d(20, 20, 5)

    def forward(self, x):
        x = F.relu(self.conv1(x))
        return F.relu(self.conv2(x))

以这种方式分配的子模块将被注册，并且当您调用 to() 等时，它们的参数也将被转换。

注意

如上例所示，在子类上进行赋值之前，必须对父类进行 __init__() 调用。

变量

training (bool) – 布尔值表示此模块是处于训练模式还是评估模式。

add_module(name, module)

向当前模块添加子模块。

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

参数

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

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

apply(fn)

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

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

参数

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

返回

自身

返回类型

模块

示例

>>> @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 数据类型。

注意

此方法就地修改模块。

返回

自身

返回类型

模块

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]

compile(*args, **kwargs)

使用 torch.compile() 编译此模块的前向传播。

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

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

cpu()

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

注意

此方法就地修改模块。

返回

自身

返回类型

模块

cuda(device=None)

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

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

注意

此方法就地修改模块。

参数

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

返回

自身

返回类型

模块

double()

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

注意

此方法就地修改模块。

返回

自身

返回类型

模块

eval()

将模块设置为评估模式。

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

这等效于 self.train(False)。

请参阅 局部禁用梯度计算，了解 .eval() 与几个可能与它混淆的类似机制之间的比较。

返回

自身

返回类型

模块

extra_repr()

设置模块的额外表示。

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

返回类型

str

float()

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

注意

此方法就地修改模块。

返回

自身

返回类型

模块

forward(*input)

定义每次调用时执行的计算。

所有子类都应该重写。

注意

虽然前向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是这个，因为前者负责运行注册的钩子，而后者则默默地忽略它们。

get_buffer(target)

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

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

参数

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

返回

由 target 引用的缓冲区

返回类型

torch.Tensor

Raises

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

get_extra_state()

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

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

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

返回

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

返回类型

object

get_parameter(target)

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

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

参数

target (str) – 要查找的参数的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）

返回

由 target 引用的参数

返回类型

torch.nn.Parameter

Raises

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

Raises

AttributeError – 如果目标字符串引用无效路径或解析为非 nn.Module 的东西

half()

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

注意

此方法就地修改模块。

返回

自身

返回类型

模块

ipu(device=None)

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

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

注意

此方法就地修改模块。

参数

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

返回

自身

返回类型

模块

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 时，保留状态字典中张量的属性。唯一的例外是 requires_grad 字段的 Default: ``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) – 如果指定，所有参数将被复制到该设备

返回

自身

返回类型

模块

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

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

每次 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 将传递给前向函数的 kwargs。默认值： False

• always_call (bool) – 如果为 True，则无论在调用模块时是否引发异常，都会运行 hook。默认值： 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，则前向预钩子将传递给前向函数的 kwargs。如果钩子修改了输入，则应返回 args 和 kwargs。钩子应具有以下签名

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

参数

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

• prepend (bool) – 如果为 true，则提供的 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) – 如果为 true，则 hook 将传递给前向函数的 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 将仅对应于作为位置参数给出的输入，并且所有 kwarg 参数都被忽略。在 grad_input 和 grad_output 中的条目对于所有非张量参数将为 None。

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

警告

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

参数

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

• prepend (bool) – 如果为 True，则提供的 hook 将在所有现有的 backward 钩子之前触发，这些钩子位于此 torch.nn.modules.Module 上。否则，提供的 hook 将在所有现有的 backward 钩子之后触发，这些钩子位于此 torch.nn.modules.Module 上。请注意，使用 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 使用。在 grad_output 中的条目对于所有非张量参数将为 None。

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

警告

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

参数

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

• prepend (bool) – 如果为 True，则提供的 hook 将在所有现有的 backward_pre 钩子之前触发，这些钩子位于此 torch.nn.modules.Module 上。否则，提供的 hook 将在所有现有的 backward_pre 钩子之后触发，这些钩子位于此 torch.nn.modules.Module 上。请注意，使用 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，而 unexpected_keys 是一个包含意外键的 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, 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。

返回

自身

返回类型

模块

set_extra_state(state)

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

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

参数

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

set_submodule(target, 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 覆盖 Conv2d，您可以调用 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

参数

• target (str) – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上面的示例。）

• module (Module) – 要设置子模块的模块。

Raises

• ValueError – 如果目标字符串为空

• AttributeError – 如果目标字符串引用无效路径或解析为非 nn.Module 的东西

share_memory()

见 torch.Tensor.share_memory_()。

返回类型

T

state_dict(*, destination: T_destination, prefix: str = '', keep_vars: bool = False) → T_destination

state_dict(*, prefix: str = '', keep_vars: bool = False) → Dict[str, Any]

返回一个包含模块的整个状态的引用字典。

包括参数和持久缓冲区（例如运行平均值）。键是对应的参数和缓冲区名称。设置为 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(device: Optional[Union[str, device, int]] = ..., dtype: Optional[dtype] = ..., non_blocking: bool = ...) → Self

to(dtype: dtype, non_blocking: bool = ...) → Self

to(tensor: Tensor, non_blocking: bool = ...) → Self

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

这可以被调用为

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) – 其数据类型和设备是此模块中所有参数和缓冲区的目标数据类型和设备的张量

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

返回

自身

返回类型

模块

示例

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

返回

自身

返回类型

模块

train(mode=True)

将模块设置为训练模式。

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

参数

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

返回

自身

返回类型

模块

type(dst_type)

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

注意

此方法就地修改模块。

参数

dst_type (type or string) – 目标类型

返回

自身

返回类型

模块

xpu(device=None)

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

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

注意

此方法就地修改模块。

参数

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

返回

自身

返回类型

模块

zero_grad(set_to_none=True)

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

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

参数

set_to_none (bool) – 而不是设置为零，将梯度设置为 None。请参见 torch.optim.Optimizer.zero_grad() 获取详细信息。