RandomProjectionHash

class torchrl.data.RandomProjectionHash(*, n_components: int | None = None, dtype_cast=torch.bfloat16, as_tensor: bool = True, init_method: Callable[[torch.Tensor], torch.Tensor | None] | None = None, **kwargs)

一個模組，它將隨機投影與 SipHash 結合，以獲得低維張量，更易於透過 SipHash 進行嵌入。

此模組需要安裝 sklearn。

關鍵字引數:

• n_components (int, optional) – 投影的低維分量數量。預設為 16。

• dtype_cast (torch.dtype, optional) – 將投影轉換為的資料型別。預設為 torch.bfloat16。

• as_tensor (bool, optional) – 如果為 True，則位元組將透過內建的 hash 函式轉換為整數並對映到張量。預設為 True。

• 警告: (..) – 此模組依賴於內建的 hash 函式。: 為了在不同執行中獲得可重現的結果，必須在執行程式碼之前設定 PYTHONHASHSEED 環境變數（在程式碼執行期間更改此值無效）。

• init_method – TODO

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, optional) – 如果指定，所有引數將複製到該裝置

返回:

self

返回型別:

Module

double() → T

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

注意

此方法會就地修改模組。

返回:

self

返回型別:

Module

eval() → T

將模組設定為評估模式。

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

這等同於 self.train(False)。

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

返回:

self

返回型別:

Module

extra_repr() str

返回模組的額外表示。

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

fit(x)

將隨機投影擬合到輸入資料。

float() → T

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

注意

此方法會就地修改模組。

返回:

self

返回型別:

Module

forward(x: Tensor) → Tensor

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

應被所有子類重寫。

注意

雖然前向傳播的步驟需要在函式內定義，但之後應該呼叫 Module 例項而不是這個函式，因為前者負責執行註冊的鉤子，而後者會默默忽略它們。

get_buffer(target: str) → Tensor

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

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

引數:

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

返回:

由 target 引用的緩衝區

返回型別:

torch.Tensor

丟擲:

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

get_extra_state() → Any

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

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

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

返回:

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

返回型別:

object

get_parameter(target: str) → Parameter

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

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

引數:

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

返回:

由 target 引用的 Parameter

返回型別:

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

要檢查我們是否擁有 linear 子模組，我們可以呼叫 get_submodule("net_b.linear")。要檢查我們是否擁有 conv 子模組，我們可以呼叫 get_submodule("net_b.net_c.conv")。

get_submodule 的執行時受目標中模組巢狀程度的限制。named_modules 的查詢可以實現相同的結果，但在傳遞模組數量上是 O(N)。因此，對於檢查某個子模組是否存在這種簡單情況，應始終使用 get_submodule。

引數:

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

返回:

由 target 引用的子模組

返回型別:

torch.nn.Module

丟擲:

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

half() → T

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

注意

此方法會就地修改模組。

返回:

self

返回型別:

Module

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

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

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

注意

此方法會就地修改模組。

引數:

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

返回:

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, optional) – 是否嚴格執行 state_dict 中的鍵與此模組 state_dict() 函式返回的鍵匹配。預設為 True

• assign (bool, optional) – 設定為 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, optional) – 如果指定，所有引數將複製到該裝置

返回:

self

返回型別:

Module

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

返回一個迭代器，用於迭代模組緩衝區，產生緩衝區的名稱以及緩衝區本身。

引數:

• prefix (str) – 要附加到所有緩衝區名稱前的**字首**。

• recurse (bool, 可選) – 如果為 True，則產生此模組和所有子模組的緩衝區。否則，只產生作為此模組直接成員的緩衝區。預設為 True。

• remove_duplicate (bool, 可選) – 是否刪除結果中的重複緩衝區。預設為 True。

生成:

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

示例

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

向模組新增一個緩衝區。

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

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

引數:

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

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

• persistent (bool) – 緩衝區是否屬於此模組的 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() 呼叫後執行。該鉤子應具有以下簽名：

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

如果 with_kwargs 為 True，前向鉤子將接收傳遞給前向函式的 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，則傳遞給前向函式的 kwargs 將傳遞給 hook。預設值： 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，前向預鉤子將接收傳遞給前向函式的 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，則傳遞給前向函式的 kwargs 將傳遞給 hook。預設值： 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，即，僅當計算模組輸出的梯度時，hook 才會執行。hook 應具有以下簽名

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

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

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

警告

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

引數:

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

• prepend (bool) – 如果為 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() 可用於移除已新增的鉤子

返回型別:

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

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

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

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

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

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

警告

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

引數:

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

• prepend (bool) – 如果為 true，提供的 hook 將在此 torch.nn.modules.Module 上所有現有的 backward_pre hook 之前觸發。否則，提供的 hook 將在此 torch.nn.modules.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)

註冊一個 post-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)

註冊一個 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: 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() 方法註冊一個 post-hook。

它應具有以下簽名：

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

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

register_state_dict_pre_hook(hook)

為 state_dict() 方法註冊一個 pre-hook。

它應具有以下簽名：

hook(module, prefix, keep_vars) -> None

註冊的 hook 可用於在呼叫 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_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）將被移動到 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 or string) – 期望的型別

返回:

self

返回型別:

Module

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

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

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

注意

此方法會就地修改模組。

引數:

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

返回:

self

返回型別:

Module

zero_grad(set_to_none: bool = True) → None

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

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

引數:

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