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] 遵循 [0] 輸出中 CONSTANT.cN 格式的 ConstMap。 [0] 輸出中的索引是底層常量值的鍵。

詳見檢查程式碼。

compile(*args, **kwargs)[原始碼]¶

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

此模組的 __call__ 方法會被編譯，所有引數會原樣傳遞給 torch.compile()。

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

cpu()[原始碼]¶

將所有模型引數和緩衝區移動到 CPU。

注意

此方法會就地修改模組。

返回: 自身
返回型別: Module

cuda(device=None)[原始碼]¶

將所有模型引數和緩衝區移動到 GPU。

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

注意

此方法會就地修改模組。

引數: device (int, optional) – 如果指定，所有引數將被複制到該裝置
返回: 自身
返回型別: 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 的序列化正常工作。我們僅為 Tensor 的序列化提供向後相容性保證；如果其他物件的序列化 pickle 格式發生變化，可能會破壞向後相容性。

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

get_parameter(target)[原始碼]¶

返回由 target 給定的引數（如果存在），否則丟擲錯誤。

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

引數: target (str) – 要查詢的 Parameter 的完全限定字串名稱。（有關如何指定完全限定字串，請參閱 get_submodule。）
返回: 由 target 引用的 Parameter
返回型別: 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_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, optional) – 如果指定，所有引數將被複制到該裝置
返回: 自身
返回型別: 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, optional) – 是否嚴格要求 state_dict 中的鍵與此模組的 state_dict() 函式返回的鍵匹配。預設值：True
assign (bool, optional) – 當設定為 False 時，當前模組中張量的屬性將被保留；而設定為 True 時，則保留 state dict 中張量的屬性。唯一的例外是預設值：``False`` 的 requires_grad 欄位

返回

missing_keys 是一個字串列表，包含此模組
預期但提供的 state_dict 中缺失的所有鍵。
unexpected_keys 是一個字串列表，包含此模組未預期
但存在於提供的 state_dict 中的鍵。

返回型別

NamedTuple，包含 missing_keys 和 unexpected_keys 欄位

注意

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

modules()[source]¶

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

產生: 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)[source]¶

將所有模型引數和緩衝區移至 MTIA。

這也會使相關的引數和緩衝區成為不同的物件。因此，如果在最佳化時模組將駐留在 MTIA 上，則應在構建最佳化器之前呼叫此方法。

注意

此方法會就地修改模組。

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

named_buffers(prefix='', recurse=True, remove_duplicate=True)[source]¶

返回模組緩衝區的迭代器，同時生成緩衝區的名稱以及緩衝區本身。

引數

prefix (str) – 字首，將新增到所有緩衝區名稱之前。
recurse (bool, optional) – 如果為 True，則生成此模組和所有子模組的緩衝區。否則，只生成此模組的直接成員緩衝區。預設為 True。
remove_duplicate (bool, optional) – 是否移除結果中重複的緩衝區。預設為 True。

產生

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

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

產生: (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)[source]¶

返回網路中所有模組的迭代器，同時生成模組的名稱以及模組本身。

引數

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

返回模組引數的迭代器，同時生成引數的名稱以及引數本身。

引數

prefix (str) – 字首，將新增到所有引數名稱之前。
recurse (bool) – 如果為 True，則生成此模組和所有子模組的引數。否則，只生成此模組的直接成員引數。
remove_duplicate (bool, optional) – 是否移除結果中重複的引數。預設為 True。

產生

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

返回模組引數的迭代器。

這通常會傳遞給最佳化器。

引數: 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)[source]¶

在模組上註冊一個後向 hook。

此函式已被棄用，推薦使用 register_full_backward_hook()，並且此函式的行為將在未來版本中更改。

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

register_buffer(name, tensor, persistent=True)[source]¶

向模組新增一個緩衝區。

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

可以使用給定的名稱作為屬性訪問緩衝區。

引數

name (str) – 緩衝區的名稱。可以使用給定名稱從此模組訪問緩衝區
tensor (Tensor or 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)[source]¶

在模組上註冊一個前向 hook。

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

如果 with_kwargs 為 False 或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數不會傳遞給 hook，只會傳遞給 forward。Hook 可以修改輸出。它可以就地修改輸入，但對 forward 沒有影響，因為它是在呼叫 forward() 之後呼叫的。Hook 應具有以下簽名

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

如果 with_kwargs 為 True，前向 hook 將接收傳遞給 forward 函式的 kwargs，並應返回可能已修改的輸出。Hook 應具有以下簽名

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

引數

hook (Callable) – 要註冊的使用者定義 hook。
prepend (bool) – 如果為 True，則提供的 hook 將在此 torch.nn.Module 上的所有現有 forward hooks 之前觸發。否則，提供的 hook 將在此 torch.nn.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.remove() 來移除新增的 hook

返回型別

torch.utils.hooks.RemovableHandle

register_forward_pre_hook(hook, *, prepend=False, with_kwargs=False)[source]¶

在模組上註冊一個前向預 hook。

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

如果 with_kwargs 為 false 或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數不會傳遞給 hooks，只會傳遞給 forward。Hook 可以修改輸入。使用者可以在 hook 中返回一個元組或一個修改後的單個值。如果返回單個值，我們將把該值包裝到一個元組中（除非該值本身已經是一個元組）。Hook 應具有以下簽名

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

如果 with_kwargs 為 true，前向預 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.Module 上的所有現有 forward_pre hooks 之前觸發。否則，提供的 hook 將在此 torch.nn.Module 上的所有現有 forward_pre hooks 之後觸發。請注意，透過 register_module_forward_pre_hook() 註冊的全域性 forward_pre hooks 將在此方法註冊的所有 hooks 之前觸發。預設值：False
with_kwargs (bool) – 如果為 true，則 hook 將接收傳遞給 forward 函式的 kwargs。預設值：False

返回

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

返回型別

torch.utils.hooks.RemovableHandle

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

在模組上註冊一個後向 hook。

每次計算相對於模組的梯度時，都會呼叫此 hook，即，當且僅當計算了相對於模組輸出的梯度時，hook 才會執行。Hook 應具有以下簽名

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

grad_input 和 grad_output 是元組，分別包含相對於輸入和輸出的梯度。Hook 不應修改其引數，但可以選擇性地返回一個相對於輸入的新梯度，該梯度將在後續計算中用於替換 grad_input。grad_input 只對應於作為位置引數給出的輸入，所有 kwarg 引數都被忽略。grad_input 和 grad_output 中的非 Tensor 引數對應的條目將為 None。

出於技術原因，將此 hook 應用於 Module 時，其 forward 函式將接收傳遞給 Module 的每個 Tensor 的檢視。類似地，呼叫者將接收 Module 的 forward 函式返回的每個 Tensor 的檢視。

警告

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

引數

hook (Callable) – 要註冊的使用者定義 hook。
prepend (bool) – 如果為 true，則提供的 hook 將在此 torch.nn.Module 上的所有現有 backward hooks 之前觸發。否則，提供的 hook 將在此 torch.nn.Module 上的所有現有 backward hooks 之後觸發。請注意，透過 register_module_full_backward_hook() 註冊的全域性 backward hooks 將在此方法註冊的所有 hooks 之前觸發。

返回

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

返回型別

torch.utils.hooks.RemovableHandle

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

在模組上註冊一個後向預 hook。

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

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

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

出於技術原因，將此 hook 應用於 Module 時，其 forward 函式將接收傳遞給 Module 的每個 Tensor 的檢視。類似地，呼叫者將接收 Module 的 forward 函式返回的每個 Tensor 的檢視。

警告

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

引數

hook (Callable) – 要註冊的使用者定義 hook。
prepend (bool) – 如果為 true，則提供的 hook 將在此 torch.nn.Module 上的所有現有 backward_pre hooks 之前觸發。否則，提供的 hook 將在此 torch.nn.Module 上的所有現有 backward_pre hooks 之後觸發。請注意，透過 register_module_full_backward_pre_hook() 註冊的全域性 backward_pre hooks 將在此方法註冊的所有 hooks 之前觸發。

返回

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

返回型別

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 型別 list，而 unexpected_keys 是一個包含意外部索引鍵的 str 型別 list。

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

請注意，當呼叫 load_state_dict() 並設定 strict=True 時執行的檢查會受到 Hook 對 missing_keys 或 unexpected_keys 所做的修改的影響，這符合預期。向任何一組鍵新增內容都會在 strict=True 時導致錯誤丟擲，而清空缺失鍵和意外部索引鍵則可以避免錯誤。

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

register_load_state_dict_pre_hook(hook)[原始碼]¶

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

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

引數: hook (Callable) – 可呼叫 Hook，將在載入 state dict 之前呼叫。

register_module(name, module)[原始碼]¶

add_module() 的別名。

register_parameter(name, param)[原始碼]¶

向模組新增一個引數。

引數可以透過給定的名稱作為屬性訪問。

引數

name (str) – 引數的名稱。可以使用此模組透過給定的名稱訪問該引數
param (Parameter or 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。
返回: 自身
返回型別: 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, strict=False)[原始碼]¶

如果存在，則設定由 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_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 (bool) – 如果為 False，該方法將替換現有子模組或在父模組存在時建立新子模組。如果為 True，該方法將僅嘗試替換現有子模組，如果子模組尚不存在則丟擲錯誤。

丟擲

ValueError – 如果 target 字串為空或如果 module 不是 nn.Module 的例項。
AttributeError – 如果沿 target 字串形成的路徑在任何時候（子）路徑解析為不存在的屬性名稱或不是 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, 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(*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 (如果給出)，但 dtype 保持不變。當設定 non_blocking 時，如果可能，它會嘗試相對於主機非同步進行轉換/移動，例如，將帶有 pinned memory 的 CPU 張量移動到 CUDA 裝置。

請參閱下面的示例。

注意

此方法會就地修改模組。

引數

device (torch.device) – 此模組中引數和緩衝區的期望裝置
dtype (torch.dtype) – 此模組中引數和緩衝區的期望浮點或複數 dtype
tensor (torch.Tensor) – 其 dtype 和 device 是此模組中所有引數和緩衝區的期望 dtype 和 device 的張量
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 or string) – 期望的型別
返回: 自身
返回型別: Module

xpu(device=None)[原始碼]¶

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

這也使得關聯的引數和緩衝區成為不同的物件。因此，如果在最佳化時模組將駐留在 XPU 上，則應在構造最佳化器之前呼叫此方法。

注意

此方法會就地修改模組。

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

zero_grad(set_to_none=True)[原始碼]¶

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

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

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

ScriptModule¶

文件

教程

資源