AveragedModel¶

class torch.optim.swa_utils.AveragedModel(model, device=None, avg_fn=None, multi_avg_fn=None, use_buffers=False)[source][source]¶

實現了用於隨機權重平均 (SWA) 和指數移動平均 (EMA) 的平均模型。

隨機權重平均由 Pavel Izmailov, Dmitrii Podoprikhin, Timur Garipov, Dmitry Vetrov 和 Andrew Gordon Wilson (UAI 2018) 在平均權重導致更廣闊的區域性最優解和更好的泛化能力一文中提出。

指數移動平均是 Polyak 平均的一種變體，但在迭代過程中使用指數權重而非相等權重。

AveragedModel 類在裝置 device 上建立所提供的模組 model 的一個副本，並允許計算 model 引數的執行平均值。

引數

model (torch.nn.Module) – 用於 SWA/EMA 的模型
device (torch.device, 可選) – 如果提供，平均模型將儲存在 device 上
avg_fn (function, 可選) – 用於更新引數的平均函式；該函式必須接受 AveragedModel 引數的當前值，model 引數的當前值，以及已平均的模型數量作為輸入；如果為 None，則使用等權平均 (預設值: None)
multi_avg_fn (function, 可選) – 用於原地更新引數的平均函式；該函式必須接受 AveragedModel 引數的當前值列表，model 引數的當前值列表，以及已平均的模型數量作為輸入；如果為 None，則使用等權平均 (預設值: None)
use_buffers (bool) – 如果為 True，它將計算模型引數和 buffers 的執行平均值。(預設值: False)

示例

>>> loader, optimizer, model, loss_fn = ...
>>> swa_model = torch.optim.swa_utils.AveragedModel(model)
>>> scheduler = torch.optim.lr_scheduler.CosineAnnealingLR(optimizer,
>>>                                     T_max=300)
>>> swa_start = 160
>>> swa_scheduler = SWALR(optimizer, swa_lr=0.05)
>>> for i in range(300):
>>>      for input, target in loader:
>>>          optimizer.zero_grad()
>>>          loss_fn(model(input), target).backward()
>>>          optimizer.step()
>>>      if i > swa_start:
>>>          swa_model.update_parameters(model)
>>>          swa_scheduler.step()
>>>      else:
>>>          scheduler.step()
>>>
>>> # Update bn statistics for the swa_model at the end
>>> torch.optim.swa_utils.update_bn(loader, swa_model)

您也可以使用自定義平均函式配合 avg_fn 或 multi_avg_fn 引數。如果未提供平均函式，預設會計算權重的等權平均 (SWA)。

示例

>>> # Compute exponential moving averages of the weights and buffers
>>> ema_model = torch.optim.swa_utils.AveragedModel(model,
>>>             torch.optim.swa_utils.get_ema_multi_avg_fn(0.9), use_buffers=True)

注意

當將 SWA/EMA 與包含 Batch Normalization 的模型一起使用時，您可能需要更新 Batch Normalization 的啟用統計資訊。這可以透過使用 torch.optim.swa_utils.update_bn() 或將 use_buffers 設定為 True 來完成。第一種方法透過將資料傳遞給模型在訓練後階段更新統計資訊。第二種方法透過平均所有 buffers 在引數更新階段完成。經驗證據表明，更新歸一化層中的統計資訊會提高準確性，但您可能希望透過實驗測試哪種方法在您的問題中能產生最佳結果。

注意

avg_fn 和 multi_avg_fn 不會儲存在模型的 state_dict() 中。

注意

當首次呼叫 update_parameters() 時 (即 n_averaged 為 0)，model 的引數會被複制到 AveragedModel 的引數。對於後續每一次呼叫 update_parameters()，都會使用函式 avg_fn 來更新引數。

add_module(name, module)[source]¶

向當前模組新增一個子模組。

該模組可以使用給定的名稱作為屬性進行訪問。

引數

name (str) – 子模組的名稱。可以使用給定的名稱從此模組訪問子模組
module (Module) – 要新增到模組的子模組。

apply(fn)[source]¶

將 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()[source]¶

將所有浮點引數和 buffers 轉換為 bfloat16 資料型別。

注意

此方法會原地修改模組。

返回值: 自身
返回型別: Module

buffers(recurse=True)[source]¶

返回一個模組 buffers 的迭代器。

引數: recurse (bool) – 如果為 True，則生成此模組和所有子模組的 buffers。否則，僅生成此模組的直接成員 buffers。
Yields: torch.Tensor – 模組 buffer
返回型別: 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]¶

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

Yields: Module – 子模組
返回型別: Iterator[Module]

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

使用 torch.compile() 編譯此 Module 的 forward 方法。

此 Module 的 __call__ 方法被編譯，並且所有引數都被原樣傳遞給 torch.compile()。

有關此函式引數的詳細資訊，請參閱 torch.compile()。

cpu()[source]¶

將所有模型引數和 buffers 移動到 CPU。

注意

此方法會原地修改模組。

返回值: 自身
返回型別: Module

cuda(device=None)[source]¶

將所有模型引數和 buffers 移動到 GPU。

這也會使相關的引數和 buffers 成為不同的物件。因此，如果模組在最佳化期間將位於 GPU 上，應在構建最佳化器之前呼叫此方法。

注意

此方法會原地修改模組。

引數: device (int, 可選) – 如果指定，所有引數將被複制到該裝置
返回值: 自身
返回型別: Module

double()[source]¶

將所有浮點引數和 buffers 轉換為 double 資料型別。

注意

此方法會原地修改模組。

返回值: 自身
返回型別: Module

eval()[source]¶

將模組設定為評估模式。

這僅對某些模組有影響。有關它們在訓練/評估模式下的行為細節，請參閱特定模組的文件，例如它們是否受影響，如 Dropout、BatchNorm 等。

這等效於 self.train(False)。

有關 .eval() 與可能與其混淆的幾種類似機制的比較，請參閱區域性停用梯度計算。

返回值: 自身
返回型別: Module

extra_repr()[source]¶

返回模組的額外表示。

要列印定製的額外資訊，您應該在自己的模組中重新實現此方法。單行和多行字串都可接受。

返回型別: str

float()[source]¶

將所有浮點引數和 buffers 轉換為 float 資料型別。

注意

此方法會原地修改模組。

返回值: 自身
返回型別: Module

forward(*args, **kwargs)[source][source]¶: 前向傳播。

get_buffer(target)[source]¶

返回由 target 指定的 buffer，如果存在；否則丟擲錯誤。

有關此方法功能的更詳細說明以及如何正確指定 target，請參閱 get_submodule 的 docstring。

引數: target (str) – 要查詢的 buffer 的完全限定字串名稱。（有關如何指定完全限定字串，請參閱 get_submodule。）
返回值: 由 target 引用的 buffer
返回型別: torch.Tensor
丟擲: AttributeError – 如果目標字串引用無效路徑或解析結果不是 buffer

get_extra_state()[source]¶

返回要包含在模組 state_dict 中的任何額外狀態。

如果您需要儲存額外狀態，請為您的模組實現此方法以及相應的 set_extra_state() 方法。此函式在構建模組的 state_dict() 時呼叫。

請注意，額外狀態應該是可 pickle 化的，以確保 state_dict 的序列化正常工作。我們僅對序列化 Tensors 提供向後相容性保證；如果其他物件的序列化 pickle 形式發生變化，可能會破壞向後相容性。

返回值: 要儲存在模組 state_dict 中的任何額外狀態
返回型別: object

get_parameter(target)[source]¶

返回由 target 指定的 parameter，如果存在；否則丟擲錯誤。

有關此方法功能的更詳細說明以及如何正確指定 target，請參閱 get_submodule 的 docstring。

引數: target (str) – 要查詢的 Parameter 的完全限定字串名稱。（有關如何指定完全限定字串，請參閱 get_submodule。）
返回值: 由 target 引用的 Parameter
返回型別: torch.nn.Parameter
丟擲: AttributeError – 如果目標字串引用無效路徑或解析結果不是 nn.Parameter

get_submodule(target)[source]¶

返回由 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。)或解析結果不是 nn.Parameter

要檢查是否存在 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 例項的物件。

half()[源]¶

將所有浮點引數和緩衝區轉換為 half 資料型別。

注意

此方法會原地修改模組。

返回值: 自身
返回型別: Module

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，則除非 get_swap_module_params_on_conversion() 是 True，否則必須在呼叫 load_state_dict 之後建立最佳化器。

引數

state_dict (dict) – 包含引數和永續性緩衝區的字典。
strict (bool, 可選) – 是否嚴格要求 state_dict 中的鍵與此模組的 state_dict() 函式返回的鍵匹配。預設值：True
assign (bool, 可選) – 當設定為 False 時，保留當前模組中張量的屬性，而將其設定為 True 時，保留狀態字典中張量的屬性。預設值：False

返回值

missing_keys 是一個包含
此模組期望但提供的 state_dict 中缺少的任何鍵的 str 列表。
unexpected_keys 是一個包含不
此模組期望但在提供的 state_dict 中存在的鍵的 str 列表。

返回型別

包含 missing_keys 和 unexpected_keys 欄位的 NamedTuple

注意

如果引數或緩衝區註冊為 None 且其對應的鍵存在於 state_dict 中，則 load_state_dict() 將引發 RuntimeError。

modules()[源]¶

返回網路中所有模組的迭代器。

Yields: 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, 可選) – 如果為 True，則產生此模組及所有子模組的緩衝區。否則，僅產生直接屬於此模組的緩衝區。預設為 True。
remove_duplicate (bool, 可選) – 是否移除結果中的重複緩衝區。預設為 True。

Yields

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

返回直接子模組的迭代器，同時產生模組的名稱和模組本身。

Yields: (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) – 是否移除結果中的重複模組例項

Yields

(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, 可選) – 是否移除結果中的重複引數。預設為 True。

Yields

(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，則產生此模組及所有子模組的引數。否則，僅產生直接屬於此模組的引數。
Yields: 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 函式的 kwargs，並預期返回可能修改後的輸出。鉤子應具有以下簽名

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

引數

hook (Callable) – 要註冊的使用者定義鉤子。
prepend (bool) – 如果為 True，提供的 hook 將在此 torch.nn.Module 上所有現有 forward 鉤子之前觸發。否則，提供的 hook 將在此 torch.nn.Module 上所有現有 forward 鉤子之後觸發。請注意，使用 register_module_forward_hook() 註冊的全域性 forward 鉤子將在此方法註冊的所有鉤子之前觸發。預設值：False
with_kwargs (bool) – 如果為 True，則 hook 將接收傳遞給 forward 函式的 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，前向預鉤子將接收傳遞給 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 將在此 torch.nn.Module 上所有現有 forward_pre 鉤子之後觸發。請注意，使用 register_module_forward_pre_hook() 註冊的全域性 forward_pre 鉤子將在此方法註冊的所有鉤子之前觸發。預設值：False
with_kwargs (bool) – 如果為 true，則 hook 將接收傳遞給 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 將僅對應於作為位置引數給定的輸入，所有 kwarg 引數都將被忽略。grad_input 和 grad_output 中的條目對於所有非張量引數將為 None。

出於技術原因，當此鉤子應用於模組時，其 forward 函式將接收傳遞給模組的每個張量的檢視。類似地，呼叫方將接收模組 forward 函式返回的每個張量的檢視。

警告

在使用反向鉤子時，不允許就地修改輸入或輸出，否則將引發錯誤。

引數

hook (Callable) – 要註冊的使用者定義鉤子。
prepend (布林值) – 如果為 `True`，則提供的 `hook` 將在此 torch.nn.Module 上所有現有的 `backward` hook *之前*觸發。否則，提供的 `hook` 將在此 torch.nn.Module 上所有現有的 `backward` hook *之後*觸發。請注意，使用 register_module_full_backward_hook() 註冊的全域性 `backward` hook 將在此方法註冊的所有 hook *之前*觸發。

返回值

一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子

返回型別

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)[source]¶

在模組上註冊一個 backward pre-hook。

每次計算模組的梯度時都會呼叫該 hook。該 hook 應具有以下簽名

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

grad_output 是一個元組。Hook 不應修改其引數，但它可以選擇返回一個關於輸出的新梯度，該梯度將在後續計算中用於替代 `grad_output`。`grad_output` 中的非 Tensor 引數對應項將為 `None`。

出於技術原因，當此鉤子應用於模組時，其 forward 函式將接收傳遞給模組的每個張量的檢視。類似地，呼叫方將接收模組 forward 函式返回的每個張量的檢視。

警告

使用 backward hook 時不允許原地修改輸入，否則將引發錯誤。

引數

hook (Callable) – 要註冊的使用者定義鉤子。
prepend (布林值) – 如果為 `True`，則提供的 `hook` 將在此 torch.nn.Module 上所有現有的 `backward_pre` hook *之前*觸發。否則，提供的 `hook` 將在此 torch.nn.Module 上所有現有的 `backward_pre` hook *之後*觸發。請注意，使用 register_module_full_backward_pre_hook() 註冊的全域性 `backward_pre` hook 將在此方法註冊的所有 hook *之前*觸發。

返回值

一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子

返回型別

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)[source]¶

註冊一個後置 hook，在模組的 load_state_dict() 被呼叫後執行。

它應具有以下簽名：: hook(module, incompatible_keys) -> None

引數 module 是註冊此 hook 的當前模組，引數 incompatible_keys 是一個 NamedTuple，包含 missing_keys 和 unexpected_keys 屬性。missing_keys 是一個包含缺失鍵的 str 列表，unexpected_keys 是一個包含意外部索引鍵的 str 列表。

如果需要，給定的 incompatible_keys 可以原地修改。

請注意，當呼叫帶有 strict=True 引數的 load_state_dict() 時執行的檢查會受到 hook 對 missing_keys 或 unexpected_keys 所做修改的影響，這是預期的行為。向任一鍵集合中新增鍵都會在 strict=True 時導致錯誤丟擲，而清空所有缺失和意外的鍵將避免錯誤。

返回值: 一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子
返回型別: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)[source]¶

註冊一個前置 hook，在模組的 load_state_dict() 被呼叫前執行。

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

引數: hook (可呼叫物件 Callable) – 在載入狀態字典之前將被呼叫的可呼叫 hook。

register_module(name, module)[source]¶

add_module() 的別名。

register_parameter(name, param)[source]¶

向模組新增一個引數。

可以使用給定的名稱作為屬性來訪問該引數。

引數

name (字串 str) – 引數的名稱。可以使用給定的名稱從該模組訪問該引數
param (Parameter 或 None) – 要新增到模組的引數。如果為 None，則對引數執行的操作（例如 cuda）將被忽略。如果為 None，則該引數**不會**包含在模組的 state_dict 中。

register_state_dict_post_hook(hook)[source]¶

為 state_dict() 方法註冊一個後置 hook。

它應具有以下簽名：: hook(module, state_dict, prefix, local_metadata) -> None

註冊的 hook 可以原地修改 state_dict。

register_state_dict_pre_hook(hook)[source]¶

為 state_dict() 方法註冊一個前置 hook。

它應具有以下簽名：: hook(module, prefix, keep_vars) -> None

註冊的 hook 可用於在呼叫 state_dict 之前執行預處理。

requires_grad_(requires_grad=True)[source]¶

改變是否由 autograd 記錄此模組中引數上的操作。

此方法會原地設定引數的 requires_grad 屬性。

此方法有助於在微調時凍結模組的一部分，或單獨訓練模型的某些部分（例如 GAN 訓練）。

有關 .requires_grad_() 與其他幾個可能混淆的類似機制之間的比較，請參閱區域性停用梯度計算。

引數: requires_grad (布林值) – autograd 是否應記錄此模組中引數上的操作。預設值：True。
返回值: 自身
返回型別: Module

set_extra_state(state)[source]¶

設定載入的 state_dict 中包含的額外狀態。

此函式由 load_state_dict() 呼叫，以處理在 state_dict 中找到的任何額外狀態。如果需要在模組的 state_dict 中儲存額外狀態，請為您的模組實現此函式以及相應的 get_extra_state()。

引數: state (字典 dict) – 來自 state_dict 的額外狀態。

set_submodule(target, module, strict=False)[source]¶

設定由 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_c 和 linear。net_c 接著有一個子模組 conv。）

要用新的子模組 Linear 覆蓋 Conv2d，可以呼叫 set_submodule("net_b.net_c.conv", nn.Linear(1, 1))`，其中 strict 可以是 True 或 False`


要在現有的 net_b 模組中新增一個新的子模組 Conv2d，可以呼叫 set_submodule("net_b.conv", nn.Conv2d(1, 1, 1))`。

在上述示例中，如果將 strict=True 並呼叫 set_submodule("net_b.conv", nn.Conv2d(1, 1, 1), strict=True)`，將引發 `AttributeError`，因為 net_b 沒有名為 conv 的子模組。


引數

target (str) – 要查詢的子模組的完全限定字串名稱。（參見上面示例，瞭解如何指定完全限定字串。）
module (模組 Module) – 用於設定子模組的模組。
strict (布林值) – 如果為 False，則如果父模組存在，此方法將替換現有子模組或建立一個新子模組。如果為 True，則此方法將僅嘗試替換現有子模組，如果子模組不存在，則丟擲錯誤。


丟擲

ValueError – 如果 target 字串為空，或者如果 module 不是 nn.Module 的例項。
AttributeError – 如果由 target 字串形成的路徑在任何地方解析到不存在的屬性名或不是 nn.Module 例項的物件。





share_memory()[source]¶
請參閱 torch.Tensor.share_memory_()。

返回型別







state_dict(*args, destination=None, prefix='', keep_vars=False)[source]¶
返回一個字典，其中包含模組整個狀態的引用。
引數和持久緩衝區（例如，執行平均值）都包含在內。鍵是相應的引數名和緩衝區名。設定為 None 的引數和緩衝區不包含在內。

注意
返回的物件是淺複製。它包含對模組引數和緩衝區的引用。


警告
目前 state_dict() 也按順序接受 destination、prefix 和 keep_vars 的位置引數。然而，這已被棄用，未來的版本將強制使用關鍵字引數。


警告
請避免使用引數 destination，因為它並非為終端使用者設計。


引數

destination (字典 dict, 可選) – 如果提供，模組的狀態將更新到該字典中，並返回相同的物件。否則，將建立一個 OrderedDict 並返回。預設值：None。
prefix (字串 str, 可選) – 新增到引數和緩衝區名稱前的字串，用於構成 state_dict 中的鍵。預設值：''。
keep_vars (布林值, 可選) – 預設情況下，state dict 中返回的 Tensor 從 autograd 分離（detached）。如果設定為 True，則不會執行分離。預設值：False。


返回值
一個包含模組整個狀態的字典

返回型別
字典 dict


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






to(*args, **kwargs)[source]¶
移動和/或轉換引數和緩衝區的資料型別。
可以按以下方式呼叫：


to(device=None, dtype=None, non_blocking=False)[source]




to(dtype, non_blocking=False)[source]




to(tensor, non_blocking=False)[source]




to(memory_format=torch.channels_last)[source]


它的簽名類似於 torch.Tensor.to()，但只接受浮點或複數的 dtype。此外，此方法只會將浮點或複數引數和緩衝區轉換為指定的 dtype（如果提供）。如果提供了 device，則整型引數和緩衝區將被移動到指定 device，但其 dtype 不變。當設定了 non_blocking 時，如果可能，它會嘗試相對於主機非同步地轉換/移動，例如，將具有 pinned memory 的 CPU Tensor 移動到 CUDA 裝置。
參見下面的示例。

注意
此方法會原地修改模組。


引數

device (torch.device) – 此模組中引數和緩衝區的目標裝置。
dtype (torch.dtype) – 此模組中引數和緩衝區的目標浮點或複數 dtype。
tensor (torch.Tensor) – 其 dtype 和裝置為此模組中所有引數和緩衝區的目標 dtype 和裝置的 Tensor。
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)[source]¶
將引數和緩衝區移動到指定裝置，而不復制儲存。

引數

device (torch.device) – 此模組中引數和緩衝區的目標裝置。
recurse (布林值) – 子模組的引數和緩衝區是否應遞迴地移動到指定裝置。


返回值
自身

返回型別
Module






train(mode=True)[source]¶
將模組設定為訓練模式。
這僅對某些模組有影響。有關它們在訓練/評估模式下的行為細節，即它們是否受到影響（例如 Dropout、BatchNorm 等），請參閱特定模組的文件。

引數
mode (布林值) – 是否設定訓練模式（True）或評估模式（False）。預設值：True。

返回值
自身

返回型別
Module






type(dst_type)[source]¶
將所有引數和緩衝區轉換為 dst_type。

注意
此方法會原地修改模組。


引數
dst_type (型別 type 或 字串 string) – 目標型別。

返回值
自身

返回型別
Module






update_parameters(model)[source][source]¶
更新模型引數。






xpu(device=None)[source]¶
將所有模型引數和緩衝區移動到 XPU。
這也會使關聯的引數和緩衝區成為不同的物件。因此，如果模組在最佳化過程中將位於 XPU 上，則應在構建最佳化器之前呼叫此方法。

注意
此方法會原地修改模組。


引數
device (int, 可選) – 如果指定，所有引數將被複制到該裝置

返回值
自身

返回型別
Module






zero_grad(set_to_none=True)[source]¶
重置所有模型引數的梯度。
有關更多上下文，請參閱 torch.optim.Optimizer 下的類似函式。

引數
set_to_none (布林值) – 不設定為零，而是將梯度設定為 None。詳情請參閱 torch.optim.Optimizer.zero_grad()。

AveragedModel¶

文件

教程

資源