HashToInt¶

class torchrl.data.HashToInt[原始碼]¶

將雜湊值轉換為可用於索引連續儲存體的整數。

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¶

設定模組的額外表示。

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

float() → T¶

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

注意

此方法會原地修改模組。

回傳值:: self
回傳類型:: Module

forward(*input: Any) → None¶

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

應該由所有子類別覆寫。

注意

雖然 forward pass 的方法需要在這個函數中定義，但應該在之後呼叫 Module 實例，而不是呼叫這個函數，因為前者會處理已註冊的 hooks，而後者會靜默地忽略它們。

get_buffer(target: str) → Tensor¶

如果存在 target 指定的 buffer，則傳回該 buffer，否則拋出錯誤。

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

參數:: target – 要尋找的 buffer 的完整字串名稱。（請參閱 get_submodule，了解如何指定完整字串。）
回傳值:: 由 target 參考的 buffer
回傳類型:: torch.Tensor
引發:: AttributeError – 如果目標字串參考無效路徑或解析為不是 buffer 的東西

get_extra_state() → Any¶

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

如果您需要儲存額外狀態，請為您的模組實作此函數和對應的 set_extra_state()。在建構模組的 state_dict() 時會呼叫此函數。

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

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

get_parameter(target: str) → Parameter¶

如果存在 target 指定的 parameter，則傳回該 parameter，否則拋出錯誤。

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

參數:: target – 要尋找的 Parameter 的完整字串名稱。（請參閱 get_submodule，了解如何指定完整字串。）
回傳值:: 由 target 參考的 Parameter
回傳類型:: torch.nn.Parameter
引發:: AttributeError – 如果目標字串參考無效路徑或解析為不是 nn.Parameter 的東西

get_submodule(target: str) → Module¶

如果存在 target 指定的 submodule，則傳回該 submodule，否則拋出錯誤。

例如，假設您有一個 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 有一個巢狀 submodule net_b，它本身有兩個 submodules net_c 和 linear。net_c 然後有一個 submodule conv。)

要檢查我們是否有 linear submodule，我們會呼叫 get_submodule("net_b.linear")。要檢查我們是否有 conv submodule，我們會呼叫 get_submodule("net_b.net_c.conv")。

get_submodule 的執行時間受 target 中模組巢狀結構的程度限制。針對 named_modules 的查詢可實現相同的結果，但它是 O(N)（模組的遞移數）。因此，對於簡單的檢查以查看是否存在某個 submodule，應始終使用 get_submodule。

參數:: target – 要尋找的 submodule 的完整字串名稱。（有關如何指定完整字串，請參閱上面的範例。）
回傳值:: 由 target 參考的 submodule
回傳類型:: torch.nn.Module
引發:: AttributeError – 如果目標字串參考無效路徑或解析為不是 nn.Module 的東西

half() → T¶

將所有浮點參數和 buffer 轉換為 half 資料類型。

注意

此方法會原地修改模組。

回傳值:: self
回傳類型:: Module

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

將所有模型參數和 buffer 移至 IPU。

這也會使相關的參數和緩衝區成為不同的物件。因此，如果模組將在IPU上運行並進行優化，則應在構建優化器之前調用此方法。

注意

此方法會原地修改模組。

參數:: device (int, optional) – 如果指定，所有參數將複製到該裝置
回傳值:: self
回傳類型:: Module

load_state_dict(state_dict: Mapping[str, Any], strict: bool = True, assign: bool = False)[source]¶

從 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 欄位。預設值： ``False`

回傳值:

missing_keys 是一個字串列表，包含此模組預期的、但在提供的 state_dict 中遺失的任何鍵。
by this module but missing from the provided state_dict.
unexpected_keys 是一個字串列表，包含此模組不預期的、
但在提供的 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]]¶

傳回一個 module buffers 的迭代器，會同時產生 buffer 的名稱和 buffer 本身。

參數:

prefix (str) – 要加在所有 buffer 名稱前面的前綴詞。
recurse (bool, optional) – 如果為 True，則會產生此 module 和所有 submodule 的 buffers。否則，只會產生屬於此 module 的直接成員的 buffers。預設值為 True。
remove_duplicate (bool, optional) – 是否移除結果中重複的 buffers。預設值為 True。

產生:

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

範例

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

傳回一個 immediate children modules 的迭代器，會同時產生 module 的名稱和 module 本身。

產生:: (str, Module) – 包含名稱和 child module 的 Tuple

範例

>>> # 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)¶

傳回一個 network 中所有 modules 的迭代器，會同時產生 module 的名稱和 module 本身。

參數:

memo – 一個用於儲存已加入結果的 modules 集合的備忘錄。
prefix – 將加到 module 名稱的前綴詞。
remove_duplicate – 是否移除結果中重複的 module 實例。

產生:

(str, Module) – 名稱和 module 的 Tuple

注意

重複的模組只會返回一次。在以下範例中，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]]¶

傳回一個 module parameters 的迭代器，會同時產生 parameter 的名稱和 parameter 本身。

參數:

prefix (str) – 要加在所有 parameter 名稱前面的前綴詞。
recurse (bool) – 如果為 True，則會產生此 module 和所有 submodule 的 parameters。否則，只會產生屬於此 module 的直接成員的 parameters。
remove_duplicate (bool, optional) – 是否移除結果中重複的 parameters。預設值為 True。

產生:

(str, Parameter) – 包含名稱和 parameter 的 Tuple

範例

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

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

傳回一個 module parameters 的迭代器。

這通常會傳遞給 optimizer。

參數:: recurse (bool) – 如果為 True，則會產生此 module 和所有 submodule 的 parameters。否則，只會產生屬於此 module 的直接成員的 parameters。
產生:: Parameter – module 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 或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數將不會傳遞給 hook，而只會傳遞給 forward。 hook 可以修改輸出。它可以就地修改輸入，但由於此 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 hook 之前觸發。否則，提供的 hook 將在此 torch.nn.modules.Module 上的所有現有 forward hook 之後觸發。請注意，使用 register_module_forward_hook() 註冊的全域 forward hook 將在由此方法註冊的所有 hook 之前觸發。預設值：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¶

在模組上註冊一個前向預先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 (Callable) – 要註冊的使用者定義 hook。
prepend (bool) – 如果為 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 (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 的視圖 (view)。同樣地，呼叫者 (caller) 將接收 Module 的 forward 函數返回的每個 Tensor 的視圖。

警告

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

參數:

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¶

在 module 上註冊一個 backward pre-hook。

每次計算 module 的梯度時都會呼叫此 hook。這個 hook 應該具有以下簽名：

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

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

由於技術原因，當此 hook 應用於 Module 時，其 forward 函數將接收傳遞給 Module 的每個 Tensor 的視圖 (view)。同樣地，呼叫者 (caller) 將接收 Module 的 forward 函數返回的每個 Tensor 的視圖。

警告

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

參數:

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，以便在呼叫 module 的 load_state_dict() 之後運行。

它應具有以下簽名：: hook(module, incompatible_keys) -> None

module 參數是註冊此 hook 的當前 module，而 incompatible_keys 參數是一個 NamedTuple，由屬性 missing_keys 和 unexpected_keys 組成。 missing_keys 是一個包含遺失的 key 的 str 的 list，而 unexpected_keys 是一個包含未預期的 key 的 str 的 list。

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

請注意，在呼叫 load_state_dict() 時執行的檢查 (使用 strict=True) 會受到 hook 對 missing_keys 或 unexpected_keys 進行修改的影響，正如預期的那樣。向任一組 key 添加內容將導致在 strict=True 時拋出錯誤，而清除遺失和未預期的 key 將避免錯誤。

回傳值:: 一個 handle，可用於透過呼叫 handle.remove() 來移除已新增的 hook
回傳類型:: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)¶

註冊一個 pre-hook，使其在 module 的 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: str, module: Optional[Module]) → None¶: 是 add_module() 的別名。

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

將一個 parameter 加入到 module。

可以使用給定的名稱，作為屬性來存取這個 parameter。

參數:

name (str) – parameter 的名稱。可以使用這個名稱從這個 module 存取這個 parameter
param (Parameter or None) – 要加入到 module 的 parameter。如果 None，則會忽略在 parameters 上執行的操作，例如 cuda。如果 None，這個 parameter 不會包含在 module 的 state_dict 中。

register_state_dict_post_hook(hook)¶

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

它應具有以下簽名：: hook(module, state_dict, prefix, local_metadata) -> None

已註冊的 hooks 可以就地修改 state_dict。

register_state_dict_pre_hook(hook)¶

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

它應具有以下簽名：: hook(module, prefix, keep_vars) -> None

已註冊的 hooks 可用於在進行 state_dict 呼叫之前執行預處理。

requires_grad_(requires_grad: bool = True) → T¶

變更 autograd 是否應記錄此 module 中 parameters 上的操作。

這個方法會就地設定 parameters 的 requires_grad 屬性。

這個方法對於凍結 module 的一部分以進行微調或單獨訓練模型的各個部分（例如，GAN 訓練）很有幫助。

請參閱本機停用梯度計算，以比較 .requires_grad_() 與可能與之混淆的幾個類似機制。

參數:: requires_grad (bool) – autograd 是否應記錄此 module 中 parameters 上的操作。預設值：True。
回傳值:: self
回傳類型:: Module

set_extra_state(state: Any) → None¶

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

這個函式從 load_state_dict() 呼叫，以處理在 state_dict 中找到的任何額外狀態。如果您需要在其 state_dict 中儲存額外狀態，請為您的 module 實作此函式和對應的 get_extra_state()。

參數:: state (dict) – 來自 state_dict 的額外狀態

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

如果存在，設定由 target 給定的 submodule，否則拋出錯誤。

例如，假設您有一個 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 有一個巢狀 submodule net_b，它本身有兩個 submodules net_c 和 linear。net_c 然後有一個 submodule conv。)

要使用新的 submodule Linear 覆蓋 Conv2d，您可以呼叫 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

參數:

target – 要尋找的 submodule 的完整字串名稱。（有關如何指定完整字串，請參閱上面的範例。）
module – 要將 submodule 設定為的 module。

引發:

ValueError – 如果目標字串為空
AttributeError – 如果目標字串參考無效路徑或解析為不是 nn.Module 的東西

share_memory() → T¶: 請參閱 torch.Tensor.share_memory_()。

state_dict() → Dict[str, Tensor][原始碼]¶

傳回一個字典，其中包含模組整個狀態的參考。

包含參數和持續性緩衝區（例如，執行平均）。鍵是相應的參數和緩衝區名稱。設定為 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 張量移動到 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 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()。

HashToInt¶

文件

教學課程

資源