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] 一个 ConstMap，遵循 [0] 中输出的 CONSTANT.cN 格式。[0] 输出中的索引是底层常量的值的键。

有关详细信息，请参阅 检查代码。

compile(*args, **kwargs)

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

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

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

cpu()

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

注意

此方法会就地修改模块。

返回值

自身

返回类型

Module

cuda(device=None)

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

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

注意

此方法会就地修改模块。

参数

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

返回值

自身

返回类型

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的序列化工作正常。我们仅为序列化张量提供向后兼容性保证；如果其他对象的序列化pickle形式发生更改，则可能会破坏向后兼容性。

返回值

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

返回类型

object

get_parameter(target)

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

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

参数

target (str) – 要查找的参数的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅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_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, 可选) – 如果指定，则所有参数将被复制到该设备

返回值

自身

返回类型

Module

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 中张量的属性。唯一的例外是 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, 可选) – 如果指定，则所有参数将被复制到该设备

返回值

自身

返回类型

Module

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 或 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 将在该 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, prepend=False)

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

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

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

grad_output是一个元组。钩子不应该修改其参数，但可以选择返回一个关于输出的新梯度，该梯度将在后续计算中代替grad_output使用。对于所有非张量参数，grad_output中的条目将为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参数是一个NamedTuple，包含属性missing_keys和unexpected_keys。missing_keys是一个包含缺失键的str列表，unexpected_keys是一个包含意外键的str列表。

如果需要，可以就地修改给定的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。

返回值

自身

返回类型

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)

如果存在，则设置由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) – 要设置子模块的模块。

引发

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

• AttributeError – 如果目标字符串引用无效路径或解析为非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, 可选) – 如果提供，则模块的状态将更新到字典中，并返回相同的对象。否则，将创建一个OrderedDict并返回。默认值：None。

• prefix (str, 可选) – 添加到参数和缓冲区名称之前的词缀，用于组成state_dict中的键。默认值：''。

• keep_vars (bool, 可选) – 默认情况下，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（如果给出），但数据类型保持不变。当设置non_blocking时，它会尝试异步地转换/移动主机，如果可能的话，例如，将具有固定内存的CPU张量移动到CUDA设备。

请参见下面的示例。

注意

此方法会就地修改模块。

参数

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

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

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

• 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 或 string) – 目标类型

返回值

自身

返回类型

Module

xpu(device=None)

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

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

注意

此方法会就地修改模块。

参数

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

返回值

自身

返回类型

Module

zero_grad(set_to_none=True)

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

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

参数

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