BinaryToDecimal

類 torchrl.data.BinaryToDecimal(num_bits: int, device: device, dtype: dtype, convert_to_binary: bool = False)

一個用於將二進位制編碼張量轉換為十進位制的模組。

這是一個工具類，可以將二進位制編碼張量（例如 1001）轉換為其十進位制值（例如 9）。

引數：

• num_bits (int) – 用於基數表的位數。位數必須小於或等於輸入長度，並且輸入長度必須能被 num_bits 整除。如果 num_bits 小於輸入中的位數，最終結果將使用 sum() 在最後一個維度上進行聚合。

• device (torch.device) – 期望輸入和輸出所在的裝置。

• dtype (torch.dtype) – 輸出的資料型別。

• convert_to_binary (bool, optional) – 如果為 True，則傳遞給 forward 方法的輸入將使用 heavyside() 被轉換為二進位制輸入。預設為 False。

示例

>>> binary_to_decimal = BinaryToDecimal(
...    num_bits=4, device="cpu", dtype=torch.int32, convert_to_binary=True
... )
>>> binary = torch.Tensor([[0, 0, 1, 0, 0, 0, 0, 1], [0, 0, 0, 0, 0, 0, 10, 0]])
>>> decimal = binary_to_decimal(binary)
>>> assert decimal.shape == (2,)
>>> assert (decimal == torch.Tensor([3, 2])).all()

add_module(name: str, module: Optional[Module]) → None

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

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

引數：

• name (str) – 子模組的名稱。可以使用給定的名稱從此模組訪問子模組

• module (Module) – 要新增到模組的子模組。

apply(fn: Callable[[Module], None]) → T

將 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() → T

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

注意

此方法就地修改模組。

返回：

自身

返回型別：

模組

buffers(recurse: bool = True) → Iterator[Tensor]

返回一個遍歷模組緩衝區的迭代器。

引數：

recurse (bool) – 如果為 True，則生成此模組和所有子模組的緩衝區。否則，只生成直接屬於此模組的緩衝區。

生成：

torch.Tensor – 模組緩衝區

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

children() → Iterator[Module]

返回一個遍歷直接子模組的迭代器。

生成：

模組 – 子模組

compile(*args, **kwargs)

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

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

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

cpu() → T

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

注意

此方法就地修改模組。

返回：

自身

返回型別：

模組

cuda(device: Optional[Union[int, device]] = None) → T

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

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

注意

此方法就地修改模組。

引數：

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

返回：

自身

返回型別：

模組

double() → T

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

注意

此方法就地修改模組。

返回：

自身

返回型別：

模組

eval() → T

將模組設定為評估模式。

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

這等同於 self.train(False)。

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

返回：

自身

返回型別：

模組

extra_repr() → str

返回模組的額外表示。

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

float() → T

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

注意

此方法就地修改模組。

返回：

自身

返回型別：

模組

forward(features: Tensor) → Tensor

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

應由所有子類重寫。

注意

雖然正向傳播的邏輯需要在本函式中定義，但應該在之後呼叫 Module 例項而不是直接呼叫此函式，因為前者負責執行已註冊的鉤子，而後者會靜默忽略它們。

get_buffer(target: str) → Tensor

如果存在，則返回由 target 指定的緩衝區，否則丟擲錯誤。

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

引數：

target – 要查詢的緩衝區的完全限定字串名稱。（有關如何指定完全限定字串，請參見 get_submodule。）

返回：

由 target 引用的緩衝區

返回型別：

torch.Tensor

引發：

AttributeError – 如果目標字串引用了無效路徑或解析到的不是緩衝區

get_extra_state() → Any

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

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

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

返回：

要儲存在模組 state_dict 中的任何額外狀態

返回型別：

物件

get_parameter(target: str) → Parameter

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

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

引數：

target – 要查詢的引數的完全限定字串名稱。（有關如何指定完全限定字串，請參見 get_submodule。）

返回：

由 target 引用的引數

返回型別：

torch.nn.Parameter

引發：

AttributeError – 如果目標字串引用了無效路徑或解析到的不是 nn.Parameter

get_submodule(target: str) → 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_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 – 要查詢的子模組的完全限定字串名稱。（有關如何指定完全限定字串，請參見上文示例。）

返回：

由 target 引用的子模組

返回型別：

torch.nn.Module

引發：

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

half() → T

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

注意

此方法就地修改模組。

返回：

自身

返回型別：

模組

ipu(device: Optional[Union[int, device]] = None) → T

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

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

注意

此方法就地修改模組。

引數：

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

返回：

自身

返回型別：

模組

load_state_dict(state_dict: Mapping[str, Any], strict: bool = True, assign: bool = 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 中張量的屬性。唯一的例外是 requires_grad 欄位。

返回：

• missing_keys 是一個 str 列表，包含此模組期望但缺失的任何鍵。

  （在提供的 state_dict 中缺失）。

• unexpected_keys 是一個 str 列表，包含此模組不期望但存在的鍵

  （在提供的 state_dict 中存在）。

返回型別：

帶有 missing_keys 和 unexpected_keys 欄位的 NamedTuple

注意

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

modules() → 迭代器[模組]

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

生成：

模組 – 網路中的一個模組

注意

重複的模組僅返回一次。在以下示例中，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: 可選[聯合[整型, device]] = None) → T

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

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

注意

此方法就地修改模組。

引數：

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

返回：

自身

返回型別：

模組

named_buffers(prefix: 字串 = '', recurse: 布林值 = True, remove_duplicate: 布林值 = True) → 迭代器[元組[字串, 張量]]

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

引數：

• prefix (`字串`) – 加在所有緩衝區名稱前面的字首。

• recurse (`布林值`，*可選*) – 如果為 True，則生成此模組和所有子模組的緩衝區。否則，僅生成直接屬於此模組的緩衝區。預設為 True。

• remove_duplicate (`布林值`，*可選*) – 是否刪除結果中的重複緩衝區。預設為 True。

生成：

(`字串`, `torch.張量`) – 包含名稱和緩衝區的元組

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())

named_children() → 迭代器[元組[字串, 模組]]

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

生成：

(`字串`, 模組) – 包含名稱和子模組的元組

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, module in model.named_children():
>>>     if name in ['conv4', 'conv5']:
>>>         print(module)

named_modules(memo: 可選[集合[模組]] = None, prefix: 字串 = '', remove_duplicate: 布林值 = True)

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

引數：

• memo – 用於儲存已新增到結果中的模組集合的備忘錄。

• prefix – 將新增到模組名稱中的字首。

• remove_duplicate – 是否移除結果中的重複模組例項。

生成：

(`字串`, 模組) – 包含名稱和模組的元組。

注意

重複的模組僅返回一次。在以下示例中，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 (`字串`) – 加在所有引數名稱前面的字首。

• recurse (`布林值`) – 如果為 True，則生成此模組和所有子模組的引數。否則，僅生成直接屬於此模組的引數。

• remove_duplicate (`布林值`，*可選*) – 是否移除結果中的重複引數。預設為 True。

生成：

(`字串`, 引數) – 包含名稱和引數的元組。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())

parameters(recurse: 布林值 = True) → 迭代器[引數]

返回模組引數的迭代器。

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

引數：

recurse (`布林值`) – 如果為 True，則生成此模組和所有子模組的引數。否則，僅生成直接屬於此模組的引數。

生成：

引數 – 模組引數。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> 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: 可呼叫物件[[模組, 聯合[元組[張量, ...], 張量], 聯合[元組[張量, ...], 張量], 聯合[None, 元組[張量, ...], 張量]]) → 可移除控制代碼

在模組上註冊一個反向傳播 hook。

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

返回：

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

返回型別：

torch.utils.hooks.可移除控制代碼

register_buffer(name: 字串, tensor: 可選[張量], persistent: 布林值 = True) → None

向模組新增一個緩衝區。

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

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

引數：

• name (`字串`) – 緩衝區的名稱。可以使用給定名稱從此模組訪問緩衝區。

• tensor (`張量` 或 `None`) – 要註冊的緩衝區。如果為 None，則執行在緩衝區上的操作（例如 cuda）將被忽略。如果為 None，則緩衝區將**不**包含在模組的 state_dict 中。

• persistent (`布林值`) – 緩衝區是否為此模組的 state_dict 的一部分。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> self.register_buffer('running_mean', torch.zeros(num_features))

register_forward_hook(hook: 聯合[可呼叫物件[[T, 元組[任意型別, ...], 任意型別], 可選[任意型別]], 可呼叫物件[[T, 元組[任意型別, ...], 字典[字串, 任意型別], 任意型別], 可選[任意型別]]], *, prepend: 布林值 = False, with_kwargs: 布林值 = False, always_call: 布林值 = False) → 可移除控制代碼

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

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

如果 with_kwargs 為 False 或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數不會傳遞給 hook，只會傳遞給 forward。hook 可以修改輸出。它可以就地修改輸入，但由於此 hook 是在 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 (`可呼叫物件`) – 要註冊的使用者定義 hook。

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

• with_kwargs (`布林值`) – 如果為 True，則會向 hook 傳遞給 forward 函式的 kwargs。預設值：False。

• always_call (`布林值`) – 如果為 True，則無論呼叫 Module 時是否引發異常，都將執行 hook。預設值：False。

返回：

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

返回型別：

torch.utils.hooks.可移除控制代碼

register_forward_pre_hook(hook: 聯合[可呼叫物件[[T, 元組[任意型別, ...]], 可選[任意型別]], 可呼叫物件[[T, 元組[任意型別, ...], 字典[字串, 任意型別]], 可選[元組[任意型別, 字典[字串, 任意型別]]]]], *, prepend: 布林值 = False, with_kwargs: 布林值 = False) → 可移除控制代碼

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

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

如果 with_kwargs 為 false 或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數不會傳遞給 hook，只會傳遞給 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 (`可呼叫物件`) – 要註冊的使用者定義 hook。

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

• with_kwargs (`布林值`) – 如果為 true，則會向 hook 傳遞給 forward 函式的 kwargs。預設值：False。

返回：

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

返回型別：

torch.utils.hooks.可移除控制代碼

register_full_backward_hook(hook: 可呼叫物件[[模組, 聯合[元組[張量, ...], 張量], 聯合[元組[張量, ...], 張量], 聯合[None, 元組[張量, ...], 張量]], prepend: 布林值 = False) → 可移除控制代碼

在模組上註冊一個反向傳播 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 的檢視（view）。類似地，呼叫者將接收 Module 的 forward 函式返回的每個 Tensor 的檢視（view）。

警告

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

引數：

• hook (`可呼叫物件`) – 要註冊的使用者定義 hook。

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

返回：

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

返回型別：

torch.utils.hooks.可移除控制代碼

register_full_backward_pre_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) → RemovableHandle

在模組上註冊一個完整的反向傳播前向鉤子。

每次計算模組的梯度時都會呼叫此鉤子。鉤子簽名應如下所示：

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

grad_output 是一個元組。鉤子不應修改其引數，但可以選擇返回一個關於輸出的新梯度，該梯度將代替後續計算中的 grad_output 使用。對於所有非張量引數，grad_output 中的條目將是 None。

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

警告

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

引數：

• hook (`可呼叫物件`) – 要註冊的使用者定義 hook。

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

返回：

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

返回型別：

torch.utils.hooks.可移除控制代碼

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

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

請注意，在 `strict=True` 模式下呼叫 load_state_dict() 時執行的檢查會受到鉤子對 missing_keys 或 unexpected_keys 的修改的影響，這符合預期。向任一鍵集新增內容都會在 strict=True 時導致錯誤，而清除所有缺失鍵和意外部索引鍵則可以避免錯誤。

返回：

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

返回型別：

torch.utils.hooks.可移除控制代碼

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: str, module: Optional[Module]) → None

是 add_module() 的別名。

register_parameter(name: str, param: Optional[Parameter]) → None

向模組新增一個引數。

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

引數：

• name (str) – 引數的名稱。可以使用此模組透過給定的名稱訪問該引數。

• param (Parameter or 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: bool = True) → T

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

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

此方法對於凍結模組部分用於微調或單獨訓練模型部分（例如 GAN 訓練）非常有用。

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

引數：

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

返回：

自身

返回型別：

模組

set_extra_state(state: Any) → None

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

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

引數：

state (dict) – 來自 state_dict 的額外狀態。

set_submodule(target: str, module: Module) → None

如果由 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。）

要將 Conv2d 替換為新的子模組 Linear，可以呼叫 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

引數：

• target – 要查詢的子模組的完全限定字串名稱。（有關如何指定完全限定字串，請參見上文示例。）

• module – 要設定為子模組的模組。

引發：

• ValueError – 如果目標字串為空。

• AttributeError – 如果目標字串引用了無效路徑或解析到的不是 nn.Module

share_memory() → T

請參閱 torch.Tensor.share_memory_()。

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

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> 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 時，它會嘗試儘可能非同步地相對於主機進行轉換/移動，例如，將具有固定記憶體的 CPU 張量移動到 CUDA 裝置。

請參閱下面的示例。

注意

此方法就地修改模組。

引數：

• device (torch.device) – 此模組中引數和緩衝區的期望裝置。

• dtype (torch.dtype) – 此模組中引數和緩衝區的期望浮點或複數 dtype。

• tensor (torch.Tensor) – 張量，其 dtype 和 device 是此模組中所有引數和緩衝區的期望 dtype 和 device。

• memory_format (torch.memory_format) – 此模組中 4D 引數和緩衝區的期望記憶體格式（僅關鍵字引數）。

返回：

自身

返回型別：

模組

示例

>>> # xdoctest: +IGNORE_WANT("non-deterministic")
>>> 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)
>>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1)
>>> 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: Optional[Union[int, str, device]], recurse: bool = True) → T

將引數和緩衝區移動到指定的裝置，而不復制儲存。

引數：

• device (torch.device) – 此模組中引數和緩衝區的期望裝置。

• recurse (bool) – 子模組的引數和緩衝區是否應遞迴移動到指定的裝置。

返回：

自身

返回型別：

模組

train(mode: bool = True) → T

將模組設定為訓練模式。

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

引數：

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

返回：

自身

返回型別：

模組

type(dst_type: Union[dtype, str]) → T

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

注意

此方法就地修改模組。

引數：

dst_type (type or string) – 期望的型別。

返回：

自身

返回型別：

模組

xpu(device: Optional[Union[int, device]] = None) → T

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

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

注意

此方法就地修改模組。

引數：

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

返回：

自身

返回型別：

模組

zero_grad(set_to_none: bool = True) → None

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

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

引數：

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