模块¶

class torch.nn.Module(*args, **kwargs)[源代码]¶

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

您的模型也应该继承此类。

模块也可以包含其他模块，允许以树结构嵌套它们。你可以将子模块作为常规属性进行分配：

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

class Model(nn.Module):
    def __init__(self):
        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__()。

Variables: 训练 (bool) – 布尔值表示此模块是否处于训练模式或评估模式。

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

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

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

Parameters

名称 (str) – 子模块的名称。可以通过给定的名称从此模块访问子模块
模块 (模块) – 要添加到模块中的子模块。

apply(fn)[源代码]¶

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

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

Parameters: fn (Module -> None) – 要应用于每个子模块的函数
Returns: 自身
Return type: 模块

示例：

>>> @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)
线性(in_features=2, out_features=2, bias=True)
包含参数:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
线性(in_features=2, out_features=2, bias=True)
包含参数:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
顺序(
  (0): 线性(in_features=2, out_features=2, bias=True)
  (1): 线性(in_features=2, out_features=2, bias=True)
)

bfloat16()[源代码]¶

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

注意

此方法就地修改模块。

Returns: 自身
Return type: 模块

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

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

Parameters: 递归 (布尔值) – 如果为True，则生成此模块及其所有子模块的缓冲区。否则，仅生成此模块的直接成员的缓冲区。
Yields: torch.Tensor – 模块缓冲区
Return type: 迭代器[张量]

示例：

>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
 (20L,)
 (20L, 1L, 5L, 5L)

children()[源代码]¶

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

Yields: 模块 – 一个子模块
Return type: 迭代器[模块]

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

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

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

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

cpu()[源代码]¶

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

注意

此方法就地修改模块。

Returns: 自身
Return type: 模块

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

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

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

注意

此方法就地修改模块。

Parameters: 设备 (int, 可选) – 如果指定，所有参数将被复制到该设备
Returns: 自身
Return type: 模块

double()[源代码]¶

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

注意

此方法就地修改模块。

Returns: 自身
Return type: 模块

eval()[源代码]¶

将模块设置为评估模式。

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

这等同于 self.train(False)。

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

Returns: 自身
Return type: 模块

extra_repr()[源代码]¶

设置模块的额外表示形式。

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

Return type: str

float()[源代码]¶

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

注意

此方法就地修改模块。

Returns: 自身
Return type: 模块

forward(*input)¶

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

应由所有子类重写。

注意

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

get_buffer(target)[源代码]¶

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

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

Parameters: 目标 (字符串) – 要查找的缓冲区的完全限定字符串名称。(参见 get_submodule 以了解如何指定完全限定字符串。)
Returns: 由target引用的缓冲区
Return type: torch.Tensor
Raises: AttributeError – 如果目标字符串引用了一个无效的路径或解析为不是缓冲区的内容

get_extra_state()[源代码]¶

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

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

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

Returns: 在模块的 state_dict 中存储的任何额外状态
Return type: object

get_parameter(target)[源代码]¶

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

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

Parameters: 目标 (字符串) – 要查找的参数的完全限定字符串名称。(参见 get_submodule 以了解如何指定完全限定字符串。)
Returns: 由 target 引用的参数
Return type: torch.nn.Parameter
Raises: AttributeError – 如果目标字符串引用了一个无效的路径或解析为不是nn.Parameter的内容

get_submodule(target)[源代码]¶

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

例如，假设你有一个 nn.Module A，它的结构如下：

A(
    (net_b): 模块(
        (net_c): 模块(
            (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。

Parameters: 目标 (str) – 要查找的子模块的完全限定字符串名称。（请参阅上面的示例，了解如何指定完全限定字符串。）
Returns: 由 target 引用的子模块
Return type: torch.nn.Module
Raises: AttributeError – 如果目标字符串引用无效路径或解析为不是nn.Module的内容

half()[源代码]¶

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

注意

此方法就地修改模块。

Returns: 自身
Return type: 模块

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

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

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

注意

此方法就地修改模块。

Parameters: 设备 (int, 可选) – 如果指定，所有参数将被复制到该设备
Returns: 自身
Return type: 模块

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。

Parameters

state_dict (字典) – 一个包含参数和持久缓冲区的字典。
严格 (布尔值, 可选) – 是否严格强制 state_dict 中的键与该模块的 state_dict() 函数返回的键匹配。默认值: True
assign (bool, 可选) – 当 False 时，当前模块中张量的属性保持不变，而当 True 时，状态字典中张量的属性保持不变。唯一的例外是 requires_grad 字段，默认值: ``False`

Returns

missing_keys 是一个包含缺失键的字符串列表
unexpected_keys 是一个包含意外键的字符串列表

Return type

NamedTuple 包含 missing_keys 和 unexpected_keys 字段

注意

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

modules()[源代码]¶

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

Yields: 模块 – 网络中的一个模块
Return type: 迭代器[模块]

注意

重复的模块只会返回一次。在下面的示例中，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)

named_buffers(prefix='', recurse=True, remove_duplicate=True)[源代码]¶

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

Parameters

前缀 (字符串) – 要添加到所有缓冲区名称的前缀。
递归 (布尔值, 可选) – 如果为True，则生成此模块及其所有子模块的缓冲区。否则，仅生成此模块的直接成员的缓冲区。默认为True。
remove_duplicate (布尔值, 可选) – 是否在结果中移除重复的缓冲区。默认为 True。

Yields

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

Return type

迭代器[元组[字符串, 张量]]

示例：

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

named_children()[源代码]¶

返回一个遍历直接子模块的迭代器，同时生成模块的名称和模块本身。

Yields: (字符串, 模块) – 包含名称和子模块的元组
Return type: 迭代器[元组[字符串, 模块]]

示例：

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

named_modules(memo=None, prefix='', remove_duplicate=True)[源代码]¶

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

Parameters

备忘录 (可选[集合[模块]]) – 用于存储已添加到结果中的模块集合的备忘录
前缀 (字符串) – 将添加到模块名称的前缀
remove_duplicate (bool) – 是否在结果中移除重复的模块实例

Yields

(字符串, 模块) – 名称和模块的元组

注意

重复的模块只会返回一次。在下面的示例中，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)[源代码]¶

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

Parameters

前缀 (str) – 要添加到所有参数名称的前缀。
递归 (bool) – 如果为True，则生成此模块及其所有子模块的参数。否则，仅生成此模块的直接成员参数。
remove_duplicate (bool, 可选) – 是否在结果中删除重复的参数。默认为 True。

Yields

(字符串, 参数) – 包含名称和参数的元组

Return type

迭代器[元组[字符串, 参数]]

示例：

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

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

返回模块参数的迭代器。

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

Parameters: 递归 (布尔值) – 如果为True，则生成此模块及其所有子模块的参数。否则，仅生成此模块的直接成员参数。
Yields: 参数 – 模块参数
Return type: 迭代器[参数]

示例：

>>> for param in model.parameters():
>>>     print(type(param), param.size())
 (20L,)
 (20L, 1L, 5L, 5L)

register_backward_hook(hook)[源代码]¶

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

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

Returns: 一个可以用于通过调用handle.remove()来移除添加的钩子的句柄
Return type: torch.utils.hooks.RemovableHandle

register_buffer(name, tensor, persistent=True)[源代码]¶

向模块添加一个缓冲区。

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

缓冲区可以通过给定的名称作为属性进行访问。

Parameters

名称 (str) – 缓冲区的名称。可以通过给定的名称从此模块访问缓冲区
tensor (Tensor 或 None) – 要注册的缓冲区。如果 None，则运行在缓冲区上的操作，例如 cuda，将被忽略。如果 None，缓冲区将不包含在模块的 state_dict 中。
持久化 (布尔值) – 缓冲区是否是此模块的 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 或 modified output

Parameters

钩子 (可调用对象) – 要注册的用户定义钩子。
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

Returns

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

Return type

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 为真，前向预钩子将被传递给前向函数的 kwargs。如果钩子修改了输入，则应返回 args 和 kwargs。钩子应具有以下签名：

hook(module, args, kwargs) -> None 或 a tuple of modified input 和 kwargs

Parameters

钩子 (可调用对象) – 要注册的用户定义钩子。
prepend (bool) – 如果为真，提供的 hook 将在所有现有的 forward_pre 钩子之前触发。否则，提供的 hook 将在所有现有的 forward_pre 钩子之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre 钩子将在所有通过此方法注册的钩子之前触发。默认值：False
with_kwargs (bool) – 如果为真，hook 将被传递给 forward 函数的 kwargs。默认值：False

Returns

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

Return type

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 中的条目对于所有非张量参数将为 None。

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

警告

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

Parameters

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

Returns

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

Return type

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)[源代码]¶

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

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

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

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

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

警告

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

Parameters

钩子 (可调用对象) – 要注册的用户定义钩子。
prepend (bool) – 如果为真，提供的 hook 将在所有现有的 backward_pre 钩子之前触发。否则，提供的 hook 将在所有现有的 backward_pre 钩子之后触发。请注意，使用 register_module_full_backward_pre_hook() 注册的全局 backward_pre 钩子将在所有通过此方法注册的钩子之前触发。

Returns

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

Return type

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)[源代码]¶

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

It should have the following signature::: hook(module, incompatible_keys) -> 无

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

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

请注意，当使用 strict=True 调用 load_state_dict() 时执行的检查会受到钩子对 missing_keys 或 unexpected_keys 所做修改的影响，这是预期的。对任一组键的添加将导致在 strict=True 时抛出错误，而清除掉缺失和意外的键将避免错误。

Returns: 一个可以用于通过调用handle.remove()来移除添加的钩子的句柄
Return type: torch.utils.hooks.RemovableHandle

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

别名 add_module()。

register_parameter(name, param)[源代码]¶

向模块添加一个参数。

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

Parameters

名称 (str) – 参数的名称。可以通过给定的名称从此模块中访问该参数
参数 (参数或无) – 要添加到模块的参数。如果 无，则对参数运行的操作（例如 cuda）将被忽略。如果 无，则该参数不包含在模块的 state_dict 中。

register_state_dict_pre_hook(hook)[源代码]¶

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

这些钩子将在调用 state_dict 之前，使用参数 self、prefix 和 keep_vars 进行调用。注册的钩子可以在调用 state_dict 之前执行预处理。

requires_grad_(requires_grad=True)[源代码]¶

更改是否应在此模块的参数上记录自动求导操作。

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

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

参见局部禁用梯度计算，了解.requires_grad_()与几种可能与之混淆的类似机制之间的比较。

Parameters: requires_grad (布尔值) – 是否应在此模块的参数上记录自动求导操作。默认值：True。
Returns: 自身
Return type: 模块

set_extra_state(state)[源代码]¶

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

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

Parameters: 状态 (字典) – 来自 state_dict 的额外状态

share_memory()[源代码]¶

参见 torch.Tensor.share_memory_()。

Return type: 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，因为它不是为最终用户设计的。

Parameters

目标 (字典, 可选) – 如果提供，模块的状态将被更新到该字典中，并且返回相同的对象。否则，将创建并返回一个有序字典。默认值: 无。
前缀 (字符串, 可选) – 添加到参数和缓冲区名称的前缀，以组成 state_dict 中的键。默认值: ''。
keep_vars (布尔值, 可选) – 默认情况下，状态字典中返回的 Tensor 会从自动求导中分离。如果设置为 True，则不会执行分离操作。默认值：False。

Returns

包含模块整个状态的字典

Return type

dict

示例：

>>> module.state_dict().keys()
['bias', 'weight']

to(device: Optional[Union[str, 设备, int]] = ..., dtype: Optional[数据类型] = ..., non_blocking: bool = ...) → Self[源代码]¶

to(dtype: 数据类型, non_blocking: bool = ...) → Self

to(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 设备。

请参见以下示例。

注意

此方法就地修改模块。

Parameters

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

Returns

自身

Return type

模块

示例：

>>> linear = nn.Linear(2, 2)
>>> linear.weight
包含参数:
tensor([[ 0.1913, -0.3420],
        [-0.5113, -0.2325]])
>>> linear.to(torch.double)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
包含参数:
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
包含参数:
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
包含参数:
tensor([[ 0.1914, -0.3420],
        [-0.5112, -0.2324]], dtype=torch.float16)

>>> linear = nn.Linear(2, 2, bias=None).to(torch.cdouble)
>>> linear.weight
包含参数:
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)[源代码]¶

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

Parameters

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

Returns

自身

Return type

模块

train(mode=True)[源代码]¶

将模块设置为训练模式。

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

Parameters: 模式 (布尔值) – 是否设置训练模式 (True) 或评估模式 (False)。默认值: True。
Returns: 自身
Return type: 模块

type(dst_type)[源代码]¶

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

注意

此方法就地修改模块。

Parameters: dst_type (type 或 string) – 所需类型
Returns: 自身
Return type: 模块

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

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

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

注意

此方法就地修改模块。

Parameters: 设备 (int, 可选) – 如果指定，所有参数将被复制到该设备
Returns: 自身
Return type: 模块

zero_grad(set_to_none=True)[源代码]¶

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

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

Parameters: set_to_none (布尔值) – 不是设置为零，而是将梯度设置为None。参见 torch.optim.Optimizer.zero_grad() 了解详情。