模組

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) – 要應用於每個子模組的函式

回傳

self

回傳類型

模組

範例

>>> @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 資料類型。

注意

此方法會就地修改模組。

回傳

self

回傳類型

模組

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() 編譯此模組的 forward。

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

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

cpu()

將所有模型參數和緩衝區移至 CPU。

注意

此方法會就地修改模組。

回傳

self

回傳類型

模組

cuda(device=None)

將所有模型參數和緩衝區移至 GPU。

這也會使關聯的參數和緩衝區成為不同的物件。 因此，如果模組在優化時將存在於 GPU 上，則應在建構優化器之前呼叫它。

注意

此方法會就地修改模組。

參數

device (int, optional) – 如果指定，所有參數將被複製到該裝置

回傳

self

回傳類型

模組

double()

將所有浮點參數和緩衝區轉換為 double 資料類型。

注意

此方法會就地修改模組。

回傳

self

回傳類型

模組

eval()

將模組設定為評估模式。

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

這與 self.train(False) 等效。

請參閱局部停用梯度計算，以比較 .eval() 和幾個可能與其混淆的類似機制。

回傳

self

回傳類型

模組

extra_repr()

傳回模組的額外表示。

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

回傳類型

str

float()

將所有浮點參數和緩衝區轉換為 float 資料類型。

注意

此方法會就地修改模組。

回傳

self

回傳類型

模組

forward(*input)

定義每次呼叫時執行的計算。

應該被所有子類別覆寫。

注意

雖然前向傳遞的配方需要在這個函數中定義，但應該在之後呼叫 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 的序列化正常運作。我們僅為序列化 Tensors 提供向後相容性保證；如果其他物件的序列化 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)，其中 N 是可遞移模組的數量。因此，對於簡單的檢查以確定某些子模組是否存在，應該始終使用 get_submodule。

參數

target (str) – 要尋找的子模組的完整字串名稱。（有關如何指定完整字串，請參見上面的範例。）

回傳

由 target 參照的子模組

回傳類型

torch.nn.Module

引發

AttributeError – 如果目標字串引用了無效的路徑，或解析為不是 nn.Module 的物件時

half()

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

注意

此方法會就地修改模組。

回傳

self

回傳類型

模組

ipu(device=None)

將所有模型參數和緩衝區移動到 IPU。

這也會使相關聯的參數和緩衝區成為不同的物件。因此，如果模組在被優化時將存在於 IPU 上，則應在建構優化器之前呼叫此方法。

注意

此方法會就地修改模組。

參數

device (int, optional) – 如果指定，所有參數將被複製到該裝置

回傳

self

回傳類型

模組

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) – 一個包含參數和持久性緩衝區的 dict。

• strict (bool, optional) – 是否嚴格強制 state_dict 中的鍵與此模組的 state_dict() 函數傳回的鍵匹配。預設值： True

• assign (bool, optional) – 當設定為 False 時，會保留目前模組中張量的屬性，而設定為 True 則會保留狀態 dict 中張量的屬性。唯一的例外是 requires_grad 欄位 Default: ``False`

回傳

• missing_keys 是一個 str 清單，包含此模組預期的但在提供的 state_dict 中遺失的任何鍵。

  此模組預期的但在提供的 state_dict 中遺失的任何鍵。

• unexpected_keys 是一個 str 清單，包含此模組不預期的但存在於提供的 state_dict 中的鍵。

  存在於提供的 state_dict 中的鍵。

回傳類型

具有 missing_keys 和 unexpected_keys 欄位的 NamedTuple

注意

如果參數或緩衝區註冊為 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) – 如果指定，所有參數將被複製到該裝置

回傳

self

回傳類型

模組

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)

傳回一個遍歷 module 參數的迭代器。

這通常會傳遞給優化器 (optimizer)。

參數

recurse (bool) – 如果為 True，則產生此模組和所有子模組的參數。 否則，僅產生作為此模組直接成員的參數。

產生

Parameter – module 參數

回傳類型

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)

在 module 上註冊一個 backward hook。

此函數已被棄用，建議使用 register_full_backward_hook()，且此函數的行為將在未來版本中變更。

回傳

一個 handle，可用於通過呼叫 handle.remove() 來移除添加的 hook

回傳類型

torch.utils.hooks.RemovableHandle

register_buffer(name, tensor, persistent=True)

將 buffer 添加到 module。

這通常用於註冊不應被視為模型參數的 buffer。 例如，BatchNorm 的 running_mean 不是參數，而是 module 狀態的一部分。 預設情況下，buffer 是持久的，並將與參數一起儲存。 可以通過將 persistent 設定為 False 來更改此行為。 持久 buffer 和非持久 buffer 之間的唯一區別是後者不會成為此 module 的 state_dict 的一部分。

可以使用給定的名稱作為屬性存取 buffer。

參數

• name (str) – buffer 的名稱。 可以使用給定的名稱從此 module 存取 buffer

• tensor (Tensor or None) – 要註冊的 buffer。 如果 None，則忽略在 buffer 上執行的操作，例如 cuda。 如果 None，則 buffer **不** 包含在 module 的 state_dict 中。

• persistent (bool) – buffer 是否為此 module 的 state_dict 的一部分。

範例

>>> self.register_buffer('running_mean', torch.zeros(num_features))

register_forward_hook(hook, *, prepend=False, with_kwargs=False, always_call=False)

在 module 上註冊一個 forward hook。

每次 forward() 計算出一個輸出後，都會呼叫該 hook。

如果 with_kwargs 為 False 或未指定，則輸入僅包含提供給 module 的位置參數。 關鍵字參數不會傳遞給 hook，僅傳遞給 forward。 hook 可以修改輸出。 它可以就地修改輸入，但由於在呼叫 forward() 後呼叫此 hook，因此它不會對 forward 產生影響。 hook 應具有以下簽名

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

如果 with_kwargs 為 True，則 forward hook 將被傳遞給 forward 函數的 kwargs，並預期返回可能已修改的輸出。 hook 應具有以下簽名

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

參數

• hook (Callable) – 要註冊的使用者定義 hook。

• prepend (bool) – 如果為 True，提供的 hook 將會在該 torch.nn.modules.Module 上的所有既有 forward hooks 之前觸發。 否則，提供的 hook 將會在該 torch.nn.modules.Module 上的所有既有 forward hooks 之後觸發。 請注意，使用 register_module_forward_hook() 註冊的全域 forward hooks 將會在由此方法註冊的所有 hooks 之前觸發。 預設值：False

• with_kwargs (bool) – 如果為 True，hook 會被傳遞給 forward 函式的 kwargs。 預設值：False

• always_call (bool) – 如果為 True，則無論在呼叫 Module 時是否引發例外，都會執行 hook。 預設值：False

回傳

一個 handle，可用於通過呼叫 handle.remove() 來移除添加的 hook

回傳類型

torch.utils.hooks.RemovableHandle

register_forward_pre_hook(hook, *, prepend=False, with_kwargs=False)

在 module 上註冊一個 forward pre-hook。

每次呼叫 forward() 之前都會呼叫該 hook。

如果 with_kwargs 為 false 或未指定，則輸入僅包含給予 module 的位置參數。關鍵字參數不會傳遞給 hooks，而只會傳遞給 forward。hook 可以修改輸入。使用者可以在 hook 中返回一個 tuple 或一個經過修改的單一值。 如果返回單一值（除非該值已經是一個 tuple），我們會將該值包裝成一個 tuple。 hook 應該具有以下簽章

hook(module, args) -> None or modified input

如果 with_kwargs 為 true，則 forward pre-hook 將會被傳遞給 forward 函式的 kwargs。如果 hook 修改了輸入，則 args 和 kwargs 都應該返回。 hook 應該具有以下簽章

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

參數

• hook (Callable) – 要註冊的使用者定義 hook。

• prepend (bool) – 如果為 true，提供的 hook 將會在該 torch.nn.modules.Module 上的所有既有 forward_pre hooks 之前觸發。 否則，提供的 hook 將會在該 torch.nn.modules.Module 上的所有既有 forward_pre hooks 之後觸發。 請注意，使用 register_module_forward_pre_hook() 註冊的全域 forward_pre hooks 將會在由此方法註冊的所有 hooks 之前觸發。 預設值：False

• with_kwargs (bool) – 如果為 true，hook 會被傳遞給 forward 函式的 kwargs。 預設值：False

回傳

一個 handle，可用於通過呼叫 handle.remove() 來移除添加的 hook

回傳類型

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook, prepend=False)

在 module 上註冊一個 backward hook。

每次計算關於 module 的梯度時都會呼叫該 hook，也就是說，當且僅當計算關於 module 輸出的梯度時才會執行該 hook。 hook 應該具有以下簽章

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

grad_input 和 grad_output 是包含關於輸入和輸出的梯度的 tuple。 hook 不應修改其參數，但它可以選擇性地返回一個關於輸入的新梯度，該梯度將用於代替後續計算中的 grad_input。grad_input 將僅對應於作為位置參數給出的輸入，並且所有 kwarg 參數都會被忽略。 對於所有非 Tensor 參數，grad_input 和 grad_output 中的條目將為 None。

由於技術原因，當此 hook 應用於 Module 時，其 forward 函數將接收傳遞給 Module 的每個 Tensor 的 view。 同樣，呼叫者將接收由 Module 的 forward 函數返回的每個 Tensor 的 view。

警告

使用 backward hooks 時不允許修改輸入或輸出，否則會引發錯誤。

參數

• hook (Callable) – 要註冊的使用者自定義 hook。

• prepend (bool) – 如果為 true，提供的 hook 將在這個 torch.nn.modules.Module 上所有現有的 backward hooks 之前觸發。 否則，提供的 hook 將在這個 torch.nn.modules.Module 上所有現有的 backward hooks 之後觸發。 請注意，使用 register_module_full_backward_hook() 註冊的全域 backward hooks 將在由此方法註冊的所有 hooks 之前觸發。

回傳

一個 handle，可用於通過呼叫 handle.remove() 來移除添加的 hook

回傳類型

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)

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

每次計算模組的梯度時，都會調用該 hook。 這個 hook 應該有以下簽名：

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

grad_output 是一個元組。 這個 hook 不應該修改它的參數，但它可以選擇性地返回一個相對於輸出的新梯度，該梯度將代替後續計算中的 grad_output。 對於所有非 Tensor 參數，grad_output 中的條目將為 None。

由於技術原因，當此 hook 應用於 Module 時，其 forward 函數將接收傳遞給 Module 的每個 Tensor 的 view。 同樣，呼叫者將接收由 Module 的 forward 函數返回的每個 Tensor 的 view。

警告

使用 backward hooks 時不允許就地修改輸入，否則會引發錯誤。

參數

• hook (Callable) – 要註冊的使用者自定義 hook。

• prepend (bool) – 如果為 true，提供的 hook 將在這個 torch.nn.modules.Module 上所有現有的 backward_pre hooks 之前觸發。 否則，提供的 hook 將在這個 torch.nn.modules.Module 上所有現有的 backward_pre hooks 之後觸發。 請注意，使用 register_module_full_backward_pre_hook() 註冊的全域 backward_pre hooks 將在由此方法註冊的所有 hooks 之前觸發。

回傳

一個 handle，可用於通過呼叫 handle.remove() 來移除添加的 hook

回傳類型

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)

註冊一個 post-hook，使其在模組的 load_state_dict() 呼叫之後運行。

它應該具有以下簽名：

hook(module, incompatible_keys) -> None

module 參數是註冊此 hook 的當前模組，incompatible_keys 參數是一個 NamedTuple，由屬性 missing_keys 和 unexpected_keys 組成。 missing_keys 是一個包含缺失鍵的 str list，而 unexpected_keys 是一個包含未預期鍵的 str list。

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

請注意，在使用 strict=True 呼叫 load_state_dict() 時執行的檢查會受到 hook 對 missing_keys 或 unexpected_keys 進行修改的影響，正如預期的那樣。 向任何一組鍵添加內容都會導致在 strict=True 時拋出錯誤，而清除缺失和未預期的鍵都可以避免錯誤。

回傳

一個 handle，可用於通過呼叫 handle.remove() 來移除添加的 hook

回傳類型

torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)

註冊一個 pre-hook，使其在模組的 load_state_dict() 呼叫之前運行。

它應該具有以下簽名：

hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950

參數

hook (Callable) – 將在載入 state dict 之前調用的可呼叫 hook。

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。

它應該具有以下簽名：

hook(module, state_dict, prefix, local_metadata) -> None

註冊的 Hook 可以在原地修改 state_dict。

register_state_dict_pre_hook(hook)

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

它應該具有以下簽名：

hook(module, prefix, keep_vars) -> None

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

requires_grad_(requires_grad=True)

更改 autograd 是否應記錄此模組中參數上的操作。

此方法會就地設定參數的 requires_grad 屬性。

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

有關 .requires_grad_() 與可能與之混淆的幾種類似機制的比較，請參閱 在本地停用梯度計算。

參數

requires_grad (bool) – autograd 是否應記錄此模組中參數上的操作。 預設值：True。

回傳

self

回傳類型

模組

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(*, 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 (如果給定的話)，但 dtype 保持不變。當設定 non_blocking 時，如果可能，它會嘗試相對於主機異步轉換/移動，例如，將具有釘選記憶體的 CPU Tensor 移動到 CUDA 裝置。

請參閱下面的範例。

注意

此方法會就地修改模組。

參數

• device (torch.device) – 此模組中參數和緩衝區的目標裝置

• dtype (torch.dtype) – 此模組中參數和緩衝區的目標浮點數或複數 dtype

• tensor (torch.Tensor) – Tensor，其 dtype 和裝置是此模組中所有參數和緩衝區的目標 dtype 和裝置

• memory_format (torch.memory_format) – 此模組中 4D 參數和緩衝區的目標記憶體格式 (僅限關鍵字引數)

回傳

self

回傳類型

模組

範例

>>> 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) – 是否應將子模組的參數和緩衝區遞迴地移動到指定的裝置。

回傳

self

回傳類型

模組

train(mode=True)

將模組設定為訓練模式。

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

參數

mode (bool) – 是否設定訓練模式 (True) 或評估模式 (False)。 預設值：True。

回傳

self

回傳類型

模組

type(dst_type)

將所有參數和緩衝區轉換為 dst_type。

注意

此方法會就地修改模組。

參數

dst_type (type 或 string) – 期望的類型

回傳

self

回傳類型

模組

xpu(device=None)

將所有模型參數和緩衝區移動到 XPU。

這也會使相關的參數和緩衝區成為不同的物件。因此，如果模組將在 XPU 上運行並進行優化，則應在建構優化器之前呼叫它。

注意

此方法會就地修改模組。

參數

device (int, optional) – 如果指定，所有參數將被複製到該裝置

回傳

self

回傳類型

模組

zero_grad(set_to_none=True)

重置所有模型參數的梯度。

有關更多上下文，請參閱 torch.optim.Optimizer 下的類似函數。

參數

set_to_none (bool) – 不是設定為零，而是將 grads 設定為 None。有關詳細資訊，請參閱 torch.optim.Optimizer.zero_grad()。