RandomProjectionHash

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

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

此模組需要安裝 sklearn。

關鍵字引數:

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

• dtype_cast (torch.dtype, optional) – 投影要轉換成的 dtype。預設為 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() 編譯此 Module 的 forward。

此 Module 的 __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 實例，而不是直接呼叫此函式，因為前者會負責執行已註冊的 hooks，而後者會靜默地忽略它們。

get_buffer(target: str) → Tensor

傳回由 target 給定的緩衝區（如果存在），否則會拋出錯誤。

請參閱 get_submodule 的 docstring，以更詳細地說明此方法的功能，以及如何正確指定 target。

參數:

target – 要尋找的緩衝區的完整字串名稱。（請參閱 get_submodule，以了解如何指定完整字串。）

回傳:

由 target 參考的緩衝區

回傳類型:

torch.Tensor

Raises:

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

get_extra_state() → Any

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

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

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

回傳:

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

回傳類型:

object

get_parameter(target: str) → Parameter

傳回由 target 給定的參數（如果存在），否則會拋出錯誤。

請參閱 get_submodule 的 docstring，以更詳細地說明此方法的功能，以及如何正確指定 target。

參數:

target – 要尋找的參數的完整字串名稱。（請參閱 get_submodule，以了解如何指定完整字串。）

回傳:

由 target 參考的參數

回傳類型:

torch.nn.Parameter

Raises:

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)，其中 N 是傳遞模組的數量。因此，對於簡單的檢查，以確認某些子模組是否存在，應該始終使用 get_submodule。

參數:

target – 要尋找的子模組的完整字串名稱。（請參閱上面的範例，了解如何指定完整字串。）

回傳:

target 所引用的子模組

回傳類型:

torch.nn.Module

Raises:

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，則必須在呼叫 load_state_dict 之後建立優化器，除非 get_swap_module_params_on_conversion() 為 True。

參數:

• state_dict (dict) – 一個包含參數和持久緩衝區的字典。

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

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

回傳:

• missing_keys 是一個字串列表，其中包含此模組預期但提供的 state_dict 中缺少的任何鍵。

  此模組預期但提供的 state_dict 中缺少的任何鍵。

• unexpected_keys 是一個字串列表，其中包含此模組不需要但在提供的 state_dict 中存在的鍵。

  此模組不需要但在提供的 state_dict 中存在的鍵。

回傳類型:

NamedTuple 具有 missing_keys 和 unexpected_keys 欄位

注意

如果一個參數或緩衝區被註冊為 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, optional) – 如果為 True，則產生此模組和所有子模組的緩衝區。 否則，僅產生作為此模組直接成員的緩衝區。 預設值為 True。

• remove_duplicate (bool, optional) – 是否刪除結果中重複的緩衝區。預設值為 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, 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

在模組上註冊一個 backward hook。

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

回傳:

一個 handle，可用於透過呼叫 handle.remove() 來移除新增的 hook

回傳類型:

torch.utils.hooks.RemovableHandle

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

將一個 buffer 新增到模組中。

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

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

參數:

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

• tensor (Tensor 或 None) – 要註冊的 buffer。如果 None，則會忽略在 buffers 上執行的操作，例如 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 hook。

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

如果 with_kwargs 是 False 或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數不會傳遞給 hooks，只會傳遞給 forward。hook 可以修改輸出。它可以就地修改輸入，但由於它是在呼叫 forward() 之後呼叫的，因此不會對 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: 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 pre-hook。

每次在調用 forward() 之前，都會呼叫這個 hook。

如果 with_kwargs 為 false 或未指定，則輸入僅包含傳遞給模組的位置參數。關鍵字參數不會傳遞給 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: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) → RemovableHandle

在模組上註冊一個 backward hook。

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

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

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

由於技術原因，當此 hook 應用於 Module 時，其 forward 函式將接收傳遞給 Module 的每個 Tensor 的視圖。同樣，呼叫者將接收 Module 的 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，可用於透過呼叫 handle.remove() 來移除新增的 hook

回傳類型:

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 是一個 tuple。Hook 不應修改其參數，但可以選擇性地回傳一個相對於輸出的新梯度，該梯度將用於後續計算以取代 grad_output。對於所有非 Tensor 參數，grad_output 中的條目將會是 None。

由於技術原因，當此 hook 應用於 Module 時，其 forward 函式將接收傳遞給 Module 的每個 Tensor 的視圖。同樣，呼叫者將接收 Module 的 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，可用於透過呼叫 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 之前將被調用的 Callable hook。

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() 方法註冊一個 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_b 本身有兩個子模組 net_c 和 linear。net_c 接著又有一個子模組 conv。)

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

參數:

• target – 要尋找的子模組的完整字串名稱。（請參閱上面的範例，了解如何指定完整字串。）

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

Raises:

• 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 和裝置是此模組中所有參數和緩衝區的目標 dtype 和裝置

• 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, optional) – 如果有指定，所有參數會被複製到該裝置上

回傳:

self

回傳類型:

Module

zero_grad(set_to_none: bool = True) → None

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

更多上下文請參考torch.optim.Optimizer下的類似函數（在 PyTorch v2.5 中）。

參數:

set_to_none (bool) – 將梯度設為 None，而不是設為零。詳情請參閱torch.optim.Optimizer.zero_grad() (在 PyTorch v2.5 中)。