SipHash¶

class torchrl.data.SipHash(as_tensor: bool = True)[源]¶

一個用於計算給定張量的 SipHash 值的模組。

一個基於 Python SipHash 實現的雜湊函式模組。輸入張量應具有 [batch_size, num_features] 的形狀，輸出形狀將為 [batch_size]。

引數：

as_tensor (bool, 可選) – 如果 True，位元組將透過內建的 hash 函式轉換為整數並對映到張量。預設值：True。
警告： (..) – 此模組依賴於內建的 hash 函式。：為了在多次執行中獲得可重現的結果，必須在執行程式碼之前設定 PYTHONHASHSEED 環境變數（在程式碼執行期間更改此值無效）。

示例

>>> # Assuming we set PYTHONHASHSEED=0 prior to running this code
>>> a = torch.tensor([[0.1, 0.2], [0.3, 0.4], [0.5, 0.6]])
>>> b = a.clone()
>>> hash_module = SipHash(as_tensor=True)
>>> hash_a = hash_module(a)
>>> hash_a
tensor([-4669941682990263259, -3778166555168484291, -9122128731510687521])
>>> hash_b = hash_module(b)
>>> assert (hash_a == hash_b).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) – 要應用於每個子模組的函式
返回值：: self
返回型別：: 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() → T¶

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

注意

此方法會就地修改模組。

返回值：: self
返回型別：: Module

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]¶

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

生成：: Module – 子模組

compile(*args, **kwargs)¶

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

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

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

cpu() → T¶

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

注意

此方法會就地修改模組。

返回值：: self
返回型別：: Module

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

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

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

注意

此方法會就地修改模組。

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

double() → T¶

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

注意

此方法會就地修改模組。

返回值：: self
返回型別：: Module

eval() → T¶

將模組設定為評估模式。

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

這等同於 self.train(False)。

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

返回值：: self
返回型別：: Module

extra_repr() → str¶

返回模組的額外表示。

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

float() → T¶

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

注意

此方法會就地修改模組。

返回值：: self
返回型別：: Module

forward(x: torch.Tensor) → torch.Tensor | List[bytes][源]¶

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

應由所有子類重寫。

注意

雖然 forward 通道的方法需要在該函式中定義，但之後應該呼叫 Module 例項而不是此函式本身，因為前者負責執行註冊的鉤子，而後者會默默忽略它們。

get_buffer(target: str) → Tensor¶

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

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

引數：: target – 要查詢的緩衝區的完全限定字串名稱。（有關如何指定完全限定字串，請參閱 get_submodule。）
返回值：: target 引用的緩衝區
返回型別：: torch.Tensor
丟擲：: AttributeError – 如果 target 字串引用了無效路徑或解析為非緩衝區物件

get_extra_state() → Any¶

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

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

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

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

get_parameter(target: str) → Parameter¶

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

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

引數：: target – 要查詢的 Parameter 的完全限定字串名稱。（有關如何指定完全限定字串，請參閱 get_submodule。）
返回值：: target 引用的 Parameter
返回型別：: torch.nn.Parameter
丟擲：: AttributeError – 如果 target 字串引用了無效路徑或解析為非 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 – 如果 target 字串引用了無效路徑或解析為非 nn.Module 物件

half() → T¶

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

注意

此方法會就地修改模組。

返回值：: self
返回型別：: Module

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

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

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

注意

此方法會就地修改模組。

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

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, 可選) – 是否嚴格執行 state_dict 中的鍵與此模組的 state_dict() 函式返回的鍵匹配。預設值：True
assign (bool, 可選) – 當設定為 False 時，保留當前模組中張量的屬性，而設定為 True 時保留 state dict 中張量的屬性。唯一的例外是 requires_grad 欄位。預設值：False`

返回值：

missing_keys 是一個字串列表，包含由此模組預期
但在提供的 state_dict 中缺失的任何鍵。
unexpected_keys 是一個字串列表，包含
由此模組不預期但在提供的 state_dict 中存在的鍵。

返回型別：

帶有 missing_keys 和 unexpected_keys 欄位的 NamedTuple

注意

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

modules() → Iterator[Module]¶

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

生成：: 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: Optional[Union[int, device]] = None) → T¶

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

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

注意

此方法會就地修改模組。

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

named_buffers(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) → Iterator[Tuple[str, Tensor]]¶

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

引數：

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

生成：

(str, torch.Tensor) – 包含名稱和 buffer 的元組

示例

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

named_children() → Iterator[Tuple[str, Module]]¶

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

生成：: (str, Module) – 包含名稱和子模組的元組

示例

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

named_modules(memo: Optional[Set[Module]] = None, prefix: str = '', remove_duplicate: bool = True)¶

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

引數：

memo – 用於儲存已新增到結果中的模組集合的備忘錄
prefix – 將新增到模組名稱前的字首
remove_duplicate – 是否移除結果中重複的模組例項

生成：

(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: str = '', recurse: bool = True, remove_duplicate: bool = True) → Iterator[Tuple[str, Parameter]]¶

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

引數：

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

生成：

(str, Parameter) – 包含名稱和引數的元組

示例

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

parameters(recurse: bool = True) → Iterator[Parameter]¶

返回一個模組引數的迭代器。

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

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

示例

>>> # 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: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]]) → RemovableHandle¶

在模組上註冊一個反向鉤子。

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

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

register_buffer(name: str, tensor: Optional[Tensor], persistent: bool = True) → None¶

向模組新增一個 buffer。

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

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

引數：

name (str) – buffer 的名稱。可以使用給定的名稱從該模組訪問 buffer
tensor (Tensor or None) – 要註冊的 buffer。如果為 None，則在 buffer 上執行的操作（如 cuda）將被忽略。如果為 None，則 buffer 不包含在模組的 state_dict 中。
persistent (bool) – buffer 是否是此模組 state_dict 的一部分。

示例

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

register_forward_hook(hook: Union[Callable[[T, Tuple[Any, ...], Any], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any], Any], Optional[Any]]], *, prepend: bool = False, with_kwargs: bool = False, always_call: bool = False) → RemovableHandle¶

在模組上註冊一個前向鉤子。

每次 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.modules.Module 上所有已存在的 forward 鉤子之前觸發。否則，提供的 hook 將在此 torch.nn.modules.Module 上所有已存在的 forward 鉤子之後觸發。請注意，使用 register_module_forward_hook() 註冊的全域性 forward 鉤子將在此方法註冊的所有鉤子之前觸發。預設為：False
with_kwargs (bool) – 如果為 True，hook 將接收傳遞給 forward 函式的 kwargs。預設為：False
always_call (bool) – 如果為 True，無論呼叫模組時是否丟擲異常，hook 都將執行。預設為：False

返回值：

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

返回型別：

torch.utils.hooks.RemovableHandle

register_forward_pre_hook(hook: Union[Callable[[T, Tuple[Any, ...]], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any]], Optional[Tuple[Any, Dict[str, Any]]]]], *, prepend: bool = False, with_kwargs: bool = False) → RemovableHandle¶

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

每次呼叫 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.modules.Module 上所有已存在的 forward_pre 鉤子之前觸發。否則，提供的 hook 將在此 torch.nn.modules.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: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) → RemovableHandle¶

在模組上註冊一個反向鉤子。

每當計算模組的梯度時，此鉤子就會被呼叫，即當且僅當計算模組輸出的梯度時，鉤子才會執行。鉤子應具有以下簽名：

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

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

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

警告

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

引數：

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

返回值：

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

返回型別：

torch.utils.hooks.RemovableHandle

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 中的條目對於所有非 Tensor 引數將為 None。

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

警告

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

引數：

hook (Callable) – 要註冊的使用者定義鉤子。
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() 來移除新增的鉤子

返回型別：

torch.utils.hooks.RemovableHandle

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 是一個 list 型別的 str，包含缺失的鍵；unexpected_keys 是一個 list 型別的 str，包含意外的鍵。

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

注意，呼叫 load_state_dict() 並設定 strict=True 時執行的檢查，會如預期那樣受到鉤子對 missing_keys 或 unexpected_keys 進行修改的影響。向任一組鍵新增內容都會在 strict=True 時導致丟擲錯誤，而清空 missing 和 unexpected 鍵則會避免錯誤。

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

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 或 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。
返回值：: self
返回型別：: Module

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_b 本身有兩個子模組 net_c 和 linear。net_c 又有一個子模組 conv。）

要用新的子模組 Linear 覆蓋 Conv2d，你可以呼叫 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

引數：

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

module – 用於設定子模組的模組。

丟擲：

ValueError – 如果目標字串為空

AttributeError – 如果 target 字串引用了無效路徑或解析為非 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, 可選) – 如果提供，模組的狀態將更新到此字典中並返回同一物件。否則，將建立一個 OrderedDict 並返回。預設值：None。

prefix (str, 可選) – 新增到引數和緩衝區名稱字首，以構成 state_dict 中的鍵。預設值：''。

keep_vars (bool, 可選) – 預設情況下，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 Tensor 移動到 CUDA 裝置。

示例如下。

注意

此方法會就地修改模組。

引數：

device (torch.device) – 此模組中引數和緩衝區所需的裝置

dtype (torch.dtype) – 此模組中引數和緩衝區所需的浮點型或複數型 dtype

tensor (torch.Tensor) – 其 dtype 和 device 是此模組中所有引數和緩衝區所需 dtype 和 device 的 Tensor

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

返回值：

self

返回型別：

Module

示例

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

返回值：

self

返回型別：

Module

train(mode: bool = True) → T¶

將模組設定為訓練模式。

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

引數：

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

返回值：

self

返回型別：

Module

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

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

注意

此方法會就地修改模組。

引數：

dst_type (type 或 string) – 所需的型別

返回值：

self

返回型別：

Module

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

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

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

注意

此方法會就地修改模組。

引數：

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

返回值：

self

返回型別：

Module

zero_grad(set_to_none: bool = True) → None¶

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

請參閱 torch.optim.Optimizer 下的類似函式以獲取更多上下文。

引數：

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

SipHash¶

文件

教程

資源