QueryModule

class torchrl.data.QueryModule(*args, **kwargs)

用於為儲存產生相容索引的模組。

一個查詢儲存並傳回該儲存所需索引的模組。目前，它僅輸出整數索引 (torch.int64)。

參數:

• in_keys (NestedKeys 清單) – 將用於產生雜湊值的輸入 tensordict 的鍵。

• index_key (NestedKey) – 將寫入索引值的輸出鍵。預設為 "_index"。

關鍵字引數:

• hash_key (NestedKey) – 將寫入雜湊值的輸出鍵。預設為 "_hash"。

• hash_module (Callable[[Any], int] 或這些的清單, 選用) – 類似於 SipHash 的雜湊模組 (預設)。如果提供可呼叫物件的清單，其長度必須等於 in_keys 的數量。

• hash_to_int (Callable[[int], int], 選用) – 一個具狀態的函數，將雜湊值對應到與儲存中的索引相對應的非負整數。預設為 HashToInt。

• aggregator – 將多個雜湊值組合在一起的雜湊函數。只有在有多個 in_keys 時才應傳遞此引數。如果提供單個 hash_module 但未傳遞 aggregator，它將採用 hash_module 的值。如果未提供 hash_module 或 hash_modules 的清單，但未傳遞 aggregator，它將預設為 SipHash。

d

範例

>>> query_module = QueryModule(
...     in_keys=["key1", "key2"],
...     index_key="index",
...     hash_module=SipHash(),
... )
>>> query = TensorDict(
...     {
...         "key1": torch.Tensor([[1], [1], [1], [2]]),
...         "key2": torch.Tensor([[3], [3], [2], [3]]),
...         "other": torch.randn(4),
...     },
...     batch_size=(4,),
... )
>>> res = query_module(query)
>>> # The first two pairs of key1 and key2 match
>>> assert res["index"][0] == res["index"][1]
>>> # The last three pairs of key1 and key2 have at least one mismatching value
>>> assert res["index"][1] != res["index"][2]
>>> assert res["index"][2] != res["index"][3]

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，則產生此模組和所有子模組的緩衝區。 否則，僅產生作為此模組直接成員的緩衝區。

Yields:

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]

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

Yields:

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(tensordict: TensorDictBase, extend: bool = True, write_hash: bool = True) → TensorDictBase

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

應由所有子類別覆寫。

注意

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

get_buffer(target: str) → Tensor

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

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

參數:

target – 要尋找的緩衝區的完整字串名稱。(請參閱 get_submodule，瞭解如何指定完整字串。)

回傳值:

由 target 參考的緩衝區

回傳類型:

torch.Tensor

引發:

AttributeError – 如果目標字串引用無效路徑或解析為非緩衝區的內容

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 給定的參數，否則拋出錯誤。

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

參數:

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 的執行時間受限於 target 中模組的巢狀深度。針對 named_modules 的查詢可以達到相同的結果，但它的時間複雜度為 O(N)，其中 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

static is_tdmodule_compatible(module)

檢查模組是否與 TensorDictModule API 相容。

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

回傳值:

• missing_keys 是一個 str 列表，包含此模組預期的但 state_dict 中遺失的任何鍵。

  by this module but missing from the provided state_dict.

• unexpected_keys 是一個 str 列表，包含未使用的鍵

  此模組預期存在，但存在於提供的 state_dict 中。

回傳類型:

具有 missing_keys 和 unexpected_keys 欄位的 NamedTuple

注意

如果一個參數或緩衝區被註冊為 None，並且它對應的鍵存在於 state_dict 中，load_state_dict() 將會引發 RuntimeError。

modules() → Iterator[Module]

傳回一個遍歷網路中所有模組的迭代器。

Yields:

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。

Yields:

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

傳回一個遍歷直接子模組的迭代器，同時產生模組的名稱和模組本身。

Yields:

(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 – 是否移除結果中重複的模組實例

Yields:

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

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

參數:

• prefix (str) – 要加到所有參數名稱前面的前綴字串。

• recurse (bool) – 如果為 True，則產生此 module 及其所有子 module 的參數。 否則，僅產生屬於此 module 直接成員的參數。

• remove_duplicate (bool, optional) – 是否移除結果中重複的參數。 預設為 True。

Yields:

(str, 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 參數的迭代器。

這通常會傳遞給優化器 (optimizer)。

參數:

recurse (bool) – 如果為 True，則產生此 module 及其所有子 module 的參數。 否則，僅產生屬於此 module 直接成員的參數。

Yields:

Parameter – module 參數。

範例

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

在 module 上註冊一個 backward hook。

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

回傳值:

可以使用 handle.remove() 移除所加入 hook 的 handle。

回傳類型:

torch.utils.hooks.RemovableHandle

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

將一個 buffer 添加到 module。

這通常用於註冊不應被視為模型參數的緩衝區。例如，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.remove() 移除所加入 hook 的 handle。

回傳類型:

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 pre-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.remove() 移除所加入 hook 的 handle。

回傳類型:

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

在 module 上註冊一個 backward hook。

每次計算 module 的梯度時都會呼叫這個 hook，也就是說，只有在計算 module 輸出的梯度時才會執行這個 hook。這個 hook 應該具有以下簽名：

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

grad_input 和 grad_output 是包含輸入和輸出梯度的 tuple。hook 不應修改其引數，但它可以選擇性地傳回一個相對於輸入的新梯度，該梯度將用於取代後續計算中的 grad_input。grad_input 只會對應於作為位置引數提供的輸入，並且所有 kwarg 引數都會被忽略。grad_input 和 grad_output 中的條目對於所有非 Tensor 引數都會是 None。

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

警告

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

參數:

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

• prepend (bool) – 如果為 true，則提供的 hook 將在本 torch.nn.modules.Module 上的所有現有 backward hooks 之前觸發。否則，提供的 hook 將在本 torch.nn.modules.Module 上的所有現有 backward hooks 之後觸發。請注意，使用 register_module_full_backward_hook() 註冊的全域 backward hooks 將在本方法註冊的所有 hooks 之前觸發。

回傳值:

可以使用 handle.remove() 移除所加入 hook 的 handle。

回傳類型:

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 是一個 tuple。hook 不應修改其引數，但它可以選擇性地回傳一個新的梯度（相對於輸出），以取代後續計算中使用的 grad_output。對於所有非 Tensor 引數，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_pre hook 之前觸發。 否則，提供的 hook 將在這個 torch.nn.modules.Module 上所有現有的 backward_pre hook 之後觸發。 請注意，使用 register_module_full_backward_pre_hook() 註冊的全域 backward_pre hook 將在以此方法註冊的所有 hook 之前觸發。

回傳值:

可以使用 handle.remove() 移除所加入 hook 的 handle。

回傳類型:

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)

註冊一個後置 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.remove() 移除所加入 hook 的 handle。

回傳類型:

torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)

註冊一個前置 hook，在模組的 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

向模組新增一個參數。

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

參數:

• 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

註冊的 hook 可以在原地修改 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 是否應記錄此模組中參數上的操作。

此方法就地設定參數的 requires_grad 屬性。

此方法有助於凍結模組的一部分以進行微調，或單獨訓練模型的部分（例如，GAN 訓練）。

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

參數:

requires_grad (bool) – autograd 是否應記錄此模組中參數上的操作。預設值：True。

回傳值:

self

回傳類型:

Module

reset_out_keys()

將 out_keys 屬性重設為其原始值。

傳回：相同的模組，具有其原始 out_keys 值。

範例

>>> from tensordict import TensorDict
>>> from tensordict.nn import TensorDictModule, TensorDictSequential
>>> import torch
>>> mod = TensorDictModule(lambda x, y: (x+2, y+2), in_keys=["a", "b"], out_keys=["c", "d"])
>>> mod.select_out_keys("d")
>>> td = TensorDict({"a": torch.zeros(()), "b": torch.ones(())}, [])
>>> mod(td)
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        d: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> mod.reset_out_keys()
>>> mod(td)
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        c: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        d: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

reset_parameters_recursive(parameters: Optional[TensorDictBase] = None) → Optional[TensorDictBase]

遞迴地重設模組及其子模組的參數。

參數:

parameters (參數的 TensorDict, optional) – 如果設定為 None，則模組將使用 self.parameters() 進行重設。 否則，我們將就地重設 tensordict 中的參數。 這對於參數未儲存在模組本身的 functional 模組很有用。

回傳值:

新參數的 tensordict，僅當參數不是 None 時。

範例

>>> from tensordict.nn import TensorDictModule
>>> from torch import nn
>>> net = nn.Sequential(nn.Linear(2,3), nn.ReLU())
>>> old_param = net[0].weight.clone()
>>> module = TensorDictModule(net, in_keys=['bork'], out_keys=['dork'])
>>> module.reset_parameters()
>>> (old_param == net[0].weight).any()
tensor(False)

此方法還支援 functional 參數取樣

>>> from tensordict import TensorDict
>>> from tensordict.nn import TensorDictModule
>>> from torch import nn
>>> net = nn.Sequential(nn.Linear(2,3), nn.ReLU())
>>> module = TensorDictModule(net, in_keys=['bork'], out_keys=['dork'])
>>> params = TensorDict.from_module(module)
>>> old_params = params.clone(recurse=True)
>>> module.reset_parameters(params)
>>> (old_params == params).any()
False

select_out_keys(*out_keys) → TensorDictModuleBase

選擇將在輸出 tensordict 中找到的 keys。

當想要去除複雜圖表中的中間 keys，或者當這些 keys 的存在可能觸發意外行為時，這非常有用。

原始的 out_keys 仍然可以透過 module.out_keys_source 存取。

參數:

*out_keys (字串或字串元組的序列) – 應該在輸出 tensordict 中找到的 out_keys。

傳回：相同的模組，就地修改並更新了 out_keys。

最簡單的用法是使用 TensorDictModule

範例

>>> from tensordict import TensorDict
>>> from tensordict.nn import TensorDictModule, TensorDictSequential
>>> import torch
>>> mod = TensorDictModule(lambda x, y: (x+2, y+2), in_keys=["a", "b"], out_keys=["c", "d"])
>>> td = TensorDict({"a": torch.zeros(()), "b": torch.ones(())}, [])
>>> mod(td)
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        c: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        d: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> mod.select_out_keys("d")
>>> td = TensorDict({"a": torch.zeros(()), "b": torch.ones(())}, [])
>>> mod(td)
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        d: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

此功能也適用於 dispatched 引數：.. rubric:: 範例

>>> mod(torch.zeros(()), torch.ones(()))
tensor(2.)

此變更將就地發生（即將傳回具有更新的 out_keys 清單的相同模組）。 可以使用 TensorDictModuleBase.reset_out_keys() 方法回復它。

範例

>>> mod.reset_out_keys()
>>> mod(TensorDict({"a": torch.zeros(()), "b": torch.ones(())}, []))
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        c: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        d: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

這也適用於其他類別，例如 Sequential：.. rubric:: 範例

>>> from tensordict.nn import TensorDictSequential
>>> seq = TensorDictSequential(
...     TensorDictModule(lambda x: x+1, in_keys=["x"], out_keys=["y"]),
...     TensorDictModule(lambda x: x+1, in_keys=["y"], out_keys=["z"]),
... )
>>> td = TensorDict({"x": torch.zeros(())}, [])
>>> seq(td)
TensorDict(
    fields={
        x: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        y: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        z: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> seq.select_out_keys("z")
>>> td = TensorDict({"x": torch.zeros(())}, [])
>>> seq(td)
TensorDict(
    fields={
        x: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        z: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

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 Tensors 移動到 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 或 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()。