ScriptModule

类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) – 用于每个子模块的函数
返回值: 自己
返回类型: 模块

示例：

>>> @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()

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

注意

此方法会直接修改模块。

返回值: 自己
返回类型: 模块

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]

属性代码

返回 forward 方法所使用的内部图的美化表示（以有效 Python 语法形式呈现）。

详情请参见Inspecting Code。

属性code_with_constants

返回一个元组。

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

[0] 提供了 forward 方法内部图的美化表示（有效的 Python 语法）。参见代码。[1] 是一个 ConstMap，遵循 [0] 输出中的 CONSTANT.cN 格式。[0] 中的索引作为底层常量值的键。

详情请参见Inspecting Code。

compile(*args, **kwargs)

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

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

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

cpu()

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

注意

此方法会直接修改模块。

返回值: 自己
返回类型: 模块

cuda(device=None)

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

这也会使相关的参数和缓冲区变成不同的对象。因此，如果模块在优化时会运行在GPU上，应该在构建优化器之前进行调用。

注意

此方法会直接修改模块。

参数: device (int, 可选) – 如果指定设备，所有参数将会被复制到该设备
返回值: 自己
返回类型: 模块

double()

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

注意

此方法会直接修改模块。

返回值: 自己
返回类型: 模块

eval()

将模块设置为评估模式。

这仅对某些模块有效。参见特定模块的文档以了解它们在训练和评估模式下的行为细节，特别是像Dropout、BatchNorm等受影响的模块。

这相当于self.train(False)。

参见局部禁用梯度计算，了解更多关于.eval()与其他可能与其混淆的几种类似机制之间的差异。

返回值: 自己
返回类型: 模块

extra_repr()

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

为了打印自定义的额外信息，你需要在自己的模块中重写这个方法。无论是单行还是多行字符串都可以接受。

返回类型: str

float()

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

注意

此方法会直接修改模块。

返回值: 自己
返回类型: 模块

get_buffer(target)

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

请参阅 get_submodule 的文档字符串，了解该方法的功能详解及如何正确指定 target。

参数: target (str) – 要查找的缓冲区的完全合格字符串名称。（如何指定完全合格字符串，请参见get_submodule。）
返回值: 由target引用的缓冲区
返回类型: torch.Tensor
异常: AttributeError – 当目标字符串引用了无效路径或解析结果不是缓冲区时引发

get_extra_state()

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

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

注意，额外的状态需要是可序列化的（picklable），以确保状态字典能够正常序列化。我们仅对张量（Tensors）的序列化提供向后兼容性的保证；其他对象如果其序列化格式发生变化，则可能会破坏向后兼容性。

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

get_parameter(目标)

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

请参阅 get_submodule 的文档字符串，了解该方法的功能详解及如何正确指定 target。

参数: target (str) – 要查找的参数的完全合格字符串名称。（关于如何指定完全合格字符串，请参见get_submodule。）
返回值: 由 target 引用的参数
返回类型: torch.nn.Parameter
异常: AttributeError – 如果目标字符串引用了无效的路径，或者解析结果不是 nn.Parameter 的对象

get_submodule(目标)

如果存在，返回由 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) – 要查找的子模块的完整qualified字符串名称。请参见上面的例子，了解如何指定完整的qualified字符串。
返回值: 由target引用的子模块
返回类型: torch.nn.Module
异常: AttributeError – 如果目标字符串引用了无效的路径，或者解析结果不是 nn.Module 的对象

属性图

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

详细信息请参见解释图表。

半()

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

注意

此方法会直接修改模块。

返回值: 自己
返回类型: 模块

属性 inlined_graph

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

此图将进行预处理，以内联所有函数和方法调用。详情请参见解释图表。

ipu(device=None)

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

这也会使相关的参数和缓冲区变成不同的对象。因此，如果模块在优化时会运行在IPU上，应该在构建优化器之前进行调用。

注意

此方法会直接修改模块。

参数: device (int, 可选) – 如果指定设备，所有参数将会被复制到该设备
返回值: 自己
返回类型: 模块

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, 可选) – 当 False 时，当前模块中张量的属性被保留；当 True 时，状态字典中张量的属性被保留。唯一例外的是requires_grad字段，默认值为False

返回值

missing_keys 是一个包含所有预期缺失键的字符串列表

由该模块生成但未包含在提供的 state_dict 中的。
unexpected_keys 是一个包含意外键的字符串列表

该模块期望但不存在于提供的 state_dict 中。

返回类型

NamedTuple 包含 missing_keys 和 unexpected_keys 字段

注意

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

模块()

获取网络中所有模块的迭代器。

收益率: 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(设备=None)

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

这也会使相关的参数和缓冲区变成不同的对象。因此，如果模块在多线程环境下进行优化，应该在创建优化器之前先调用它。

注意

此方法会直接修改模块。

参数: device (int, 可选) – 如果指定设备，所有参数将会被复制到该设备
返回值: 自己
返回类型: 模块

named_buffers(prefix='', recurse=True, remove_duplicate=True): 返回一个迭代器来遍历模块的缓冲区，并同时 yield 缓冲区的名字和其内容。

参数

prefix (str) – 添加到所有缓冲区名称前面的前缀。

recurse (bool, 可选) – 如果为 True，则生成此模块及其所有子模块的缓冲区；否则，仅生成直接属于该模块的缓冲区。默认值为 True。

remove_duplicate (bool, 可选) – 是否删除结果中的重复缓冲区。默认值为 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)

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

参数

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)

返回一个迭代器，用于遍历模块参数，并同时 yield 参数的名称和其值。

参数

prefix (str) – 添加到所有参数名称前面的前缀。

recurse (bool) – 如果为 True，则返回此模块及其所有子模块的参数。否则，仅返回直接属于此模块的参数。

remove_duplicate (bool, 可选) – 是否删除结果中的重复参数。默认为 True。

收益率

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

返回类型

Iterator[Tuple[str, Parameter]]

示例：

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

参数（recurse=True）

返回一个遍历模块参数的迭代器。

这通常会被传送给优化器。

参数

recurse (bool) – 如果为 True，则返回此模块及其所有子模块的参数。否则，仅返回直接属于此模块的参数。

收益率

参数 — 模块参数

返回类型

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，则在调用 Module 时无论是否引发异常，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 将在所有现有 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 只对应于作为位置参数传递的输入，并忽略所有关键字参数。grad_input 和 grad_output 中对于非张量参数的部分将为 None。

出于技术原因，当这个钩子应用到一个模块时，它的前向函数会接收传递给该模块的每个张量的视图。同样，调用方也会接收到模块的前向函数返回的每个张量的视图。

警告

在使用 backward hooks 时，禁止就地修改输入或输出，否则会触发错误。

参数

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

prepend (bool) – 如果为 true，则提供的 hook 将在该 torch.nn.modules.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。对于所有非张量参数，grad_output 中的条目将是 None。

出于技术原因，当这个钩子应用到一个模块时，它的前向函数会接收传递给该模块的每个张量的视图。同样，调用方也会接收到模块的前向函数返回的每个张量的视图。

警告

在使用 backward 钩子时，禁止就地修改输入，否则会触发错误。

参数

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

prepend (bool) – 如果为 true，则提供的 hook 将在该 torch.nn.modules.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(回调函数)

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

它应具有如下签名：

hook(module, incompatible_keys)

The module 参数表示当前注册此钩子的模块，而 incompatible_keys 参数是一个 NamedTuple，包含两个属性：missing_keys 和 unexpected_keys。其中，missing_keys 是一个字符串列表，包含了缺失的键；unexpected_keys 也是一个字符串列表，包含了意外出现的键。

可以按需就地修改给定的 incompatible_keys（不兼容键）。

注意，在调用load_state_dict() 时，如果 strict=True，那么钩子对missing_keys 或 unexpected_keys 的修改将影响检查结果，如预期的那样。当向任一集合中添加键时，在 strict=True 情况下会抛出错误；清除缺失和意外的所有键则可以避免错误。

返回值

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

返回类型

torch.utils.hooks.RemovableHandle

注册加载状态字典预挂钩(钩子)

在模块的 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)

别名 for add_module().

register_parameter(name, param)

在模块中添加一个参数。

可以使用给定的名字将参数作为属性进行访问。

参数

name (str) – 参数的名称。可以通过这个名字在模块中访问该参数。

param (Parameter 或 None) – 要添加到模块中的参数。如果为 None，则忽略在参数上运行的操作（例如cuda）。此外，如果为None，该参数不包含在模块的 state_dict 中。

register_state_dict_post_hook(回调函数)

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

它应具有如下签名：

hook(module, state_dict, prefix, local_metadata)

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

register_state_dict_pre_hook(钩子函数)

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

它应具有如下签名：

hook(module, prefix, keep_vars)

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

requires_grad_(requires_grad=True)

更改是否记录该模块中参数的操作。

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

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

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

参数

requires_grad (bool) – 是否应启用自动求导来记录此模块参数上的操作。默认值： True。

返回值

自己

返回类型

模块

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 指定的子模块，否则抛出错误。

例如，假设你有一个 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 替换 Conv2d，你需要调用 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

参数

target (str) – 要查找的子模块的完整qualified字符串名称。请参见上面的例子，了解如何指定完整的qualified字符串。

module (Module) – 需要设置子模块的目标模块。

异常

ValueError — 如果目标字符串为空

AttributeError – 如果目标字符串引用了无效的路径，或者解析结果不是 nn.Module 的对象

共享内存()

参见 torch.Tensor.share_memory_()。

返回类型

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, 可选) – 默认情况下，状态字典中返回的Tensor 会与自动求导分离。如果设置为True，则不会执行分离操作。默认值： False。

返回值

包含模块全部状态的字典

返回类型

字典

示例：

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

调用(*args, **kwargs)

移动和/或调整参数和缓冲区。

这可以被调用为

to(device=None, dtype=None, non_blocking=False)

转换为(dtype, non_blocking=False))

转换为(tensor, non_blocking=False)

转换为(memory_format=torch.channels_last)

其签名与torch.Tensor.to()类似，但仅接受浮点或复数dtype。此外，此方法只会将浮点或复数参数和缓冲区转换为指定的dtype（如果提供的话）。整型参数和缓冲区将会被移动到指定的设备device（如果提供了该设备），但数据类型保持不变。当设置non_blocking时，它会尽可能异步地进行转换/移动操作，例如将具有固定内存的CPU张量移动到CUDA设备。

请参看以下示例。

注意

此方法会直接修改模块。

参数

device (torch.device) – 指定此模块中的参数和缓冲区所需使用的设备
dtype (torch.dtype) - 指定此模块中的参数和缓冲区所需的浮点或复数数据类型。
tensor (torch.Tensor) – 此张量的数据类型（dtype）和设备是该模块中所有参数和缓冲区所需的数据类型和设备。
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。
返回值: 自己
返回类型: 模块

类型(目标类型)

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

注意

此方法会直接修改模块。

参数: dst_type (type 或 字符串) – 指定的目标类型
返回值: 自己
返回类型: 模块

xpu(device=None)

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

这也会使相关的参数和缓冲区变成不同的对象。因此，如果模块在优化过程中会运行在XPU上，应该在构建优化器之前进行调用。

注意

此方法会直接修改模块。

参数: device (int, 可选) – 如果指定设备，所有参数将会被复制到该设备
返回值: 自己
返回类型: 模块

zero_grad(set_to_none=True)

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

更多上下文信息，请参见torch.optim.Optimizer中的类似函数。

参数: set_to_none (bool) – 代替将梯度设置为零，将其设置为 None。详情请参见 torch.optim.Optimizer.zero_grad()。