BinaryToDecimal

class 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) – 輸出 dtype。

• convert_to_binary (bool, optional) – 如果 True，則使用 heavyside() 將 forward 方法的輸入轉換為二進位輸入。預設為 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) – 將應用於每個子模組的函式

回傳:

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(features: Tensor) → Tensor

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

應由所有子類別覆寫。

注意

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

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 的工作序列化。 我們僅提供序列化 Tensors 的向後相容性保證； 如果其他物件的序列化 pickle 格式發生變更，則可能會中斷向後相容性。

回傳:

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

回傳類型:

object

get_parameter(target: str) → Parameter

如果存在，則返回 target 給定的參數，否則拋出錯誤。

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

參數:

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_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 資料類型。

注意

此方法會就地修改模組。

回傳:

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 時，保留狀態字典中張量的屬性。唯一的例外是 requires_grad 欄位 Default: ``False`

回傳:

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

  by this module but missing from the provided state_dict.

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

  expected by this module but present in the provided 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, 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

將緩衝區新增至模組。

這通常用於註冊不應被視為模型參數的緩衝區。例如，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 hook。

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

如果 with_kwargs 是 False 或未指定，則輸入僅包含傳遞給模組的位置參數。 關鍵字參數不會傳遞給 hook，而只會傳遞給 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 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。

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

如果 with_kwargs 為 false 或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數不會傳遞給 hooks，只會傳遞給 forward。 hook 可以修改輸入。使用者可以在 hook 中返回一個 tuple 或一個單一的修改值。如果返回單一值（除非該值已經是一個 tuple），我們會將該值包裝到一個 tuple 中。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 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 的視圖 (view)。同樣，呼叫者將接收由 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

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

每次計算模組的梯度時都會呼叫該 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)。同樣，呼叫者將接收由 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 引數是由屬性 missing_keys 和 unexpected_keys 組成的 NamedTuple。 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 之前被調用的可呼叫 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() 方法註冊一個後置 hook。

它應具有以下簽名：

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

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

register_state_dict_pre_hook(hook)

為 state_dict() 方法註冊一個前置 hook。

它應具有以下簽名：

hook(module, prefix, keep_vars) -> None

註冊的 hooks 可以用於在呼叫 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。）

若要使用新的子模組 Linear 覆寫 Conv2d，您可以呼叫 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 Tensor 移動到 CUDA 裝置。

請參閱下面的範例。

注意

此方法會就地修改模組。

參數:

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

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

• tensor (torch.Tensor) – 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()。