QueryModule

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

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

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

引數：:

• in_keys (NestedKeys 列表) – 輸入 tensordict 的鍵，將用於生成雜湊值。

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

關鍵字引數：:

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

• hash_module (可呼叫物件[[Any], int] 或此類物件的列表，可選) – 類似於 SipHash 的雜湊模組（預設）。如果提供了可呼叫物件的列表，其長度必須與 in_keys 的數量相等。

• hash_to_int (可呼叫物件[[int], int]，可選) – 一個有狀態函式，將雜湊值對映到儲存中對應的非負整數索引。預設為 HashToInt。

• aggregator (可呼叫物件[[int], int]，可選) – 用於將多個雜湊值組合在一起的雜湊函式。僅當存在多個 in_keys 時才應傳遞此引數。如果提供了單個 hash_module 但未傳遞聚合器，則其值將取 hash_module 的值。如果沒有 hash_module 或 hash_module 的列表但未傳遞聚合器，則將預設為 SipHash。

• clone (布林值，可選) – 如果為 True，將返回輸入 TensorDict 的淺層副本。這可用於檢索儲存中的整數索引，對應於給定的輸入 tensordict。這可以在執行時透過提供 clone 引數覆蓋。預設為 False。

示例

>>> 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 (字串) – 子模組的名稱。可以使用給定的名稱從此模組訪問子模組

• module (模組) – 要新增到模組的子模組。

apply(fn: Callable[[Module], None]) → T

將 fn 遞迴地應用於每個子模組 (由 .children() 返回) 以及自身。

典型用法包括初始化模型的引數（另請參見 torch.nn.init）。

引數：:

fn (模組 -> None) – 要應用於每個子模組的函式

返回值：:

自身

返回值型別：:

模組

示例

>>> @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 資料型別。

注意

此方法會就地修改模組。

返回值：:

自身

返回值型別：:

模組

buffers(recurse: bool = True) → Iterator[Tensor]

返回模組緩衝區的迭代器。

引數：:

recurse (布林值) – 如果為 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]

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

生成值：:

模組 – 一個子模組

compile(*args, **kwargs)

使用 torch.compile() 編譯此模組的 forward 方法。

此模組的 __call__ 方法被編譯，所有引數都按原樣傳遞給 torch.compile()。

請參閱 torch.compile() 以瞭解有關此函式引數的詳細資訊。

cpu() → T

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

注意

此方法會就地修改模組。

返回值：:

自身

返回值型別：:

模組

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

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

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

注意

此方法會就地修改模組。

引數：:

device (整數，可選) – 如果指定，所有引數將複製到該裝置

返回值：:

自身

返回值型別：:

模組

double() → T

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

注意

此方法會就地修改模組。

返回值：:

自身

返回值型別：:

模組

eval() → T

將模組設定為評估模式。

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

這等同於 self.train(False)。

請參閱 本地停用梯度計算 以比較 .eval() 以及其他一些可能與其混淆的類似機制。

返回值：:

自身

返回值型別：:

模組

extra_repr() → str

返回模組的額外表示。

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

float() → T

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

注意

此方法會就地修改模組。

返回值：:

自身

返回值型別：:

模組

forward(tensordict: TensorDictBase, *, extend: bool = True, write_hash: bool = True, clone: bool | None = None) → TensorDictBase

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

所有子類都應覆蓋此方法。

注意

雖然需要在函式內定義 forward pass 的實現，但應呼叫 Module 例項而不是此方法，因為前者會負責執行已註冊的 hook，而後者會靜默忽略它們。

get_buffer(target: str) → Tensor

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

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

引數：:

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

返回值：:

由 target 引用的緩衝區

返回值型別：:

torch.Tensor

丟擲：:

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

get_extra_state() → Any

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

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

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

返回值：:

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

返回值型別：:

物件

get_parameter(target: str) → Parameter

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

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

引數：:

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

返回值：:

由 target 引用的 Parameter

返回值型別：:

torch.nn.Parameter

丟擲：:

AttributeError – 如果 target 字串引用了無效路徑或解析到的內容不是 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 – 如果 target 字串引用了無效路徑或解析到的內容不是 nn.Module

half() → T

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

注意

此方法會就地修改模組。

返回值：:

自身

返回值型別：:

模組

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

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

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

注意

此方法會就地修改模組。

引數：:

device (整數，可選) – 如果指定，所有引數將複製到該裝置

返回值：:

自身

返回值型別：:

模組

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 (字典) – 包含引數和持久緩衝區的字典。

• strict (布林值，可選) – 是否嚴格要求 state_dict 中的鍵與此模組的 state_dict() 函式返回的鍵匹配。預設值：True

• assign (bool, 可選) – 設定為 False 時，將保留當前模組中張量的屬性，而設定為 True 時，則保留狀態字典 (state dict) 中張量的屬性。唯一的例外是 requires_grad 欄位。 預設值： ``False`

返回值：:

• missing_keys 是一個字串列表，包含此模組預期存在但在提供的 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 (整數，可選) – 如果指定，所有引數將複製到該裝置

返回值：:

自身

返回值型別：:

模組

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，前向鉤子將接收傳遞給 forward 函式的 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，則 hook 將接收傳遞給 forward 函式的 kwargs。預設值：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，前向傳播預鉤子將接收傳遞給 forward 函式的 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，則 hook 將接收傳遞給 forward 函式的 kwargs。預設值：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(module, grad_input, grad_output) -> tuple(Tensor) or None

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

出於技術原因，當此鉤子應用於模組時，其 forward 函式將接收傳遞給模組的每個張量的檢視。同樣，呼叫者將接收模組 forward 函式返回的每個張量的檢視。

警告

使用反向傳播鉤子時，不允許就地修改輸入或輸出，否則將引發錯誤。

引數：:

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

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

返回值：:

一個控制代碼，可以透過呼叫 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

在模組上註冊一個反向傳播預鉤子。

每次計算模組的梯度時，都會呼叫此鉤子。鉤子應具有以下簽名：

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

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

出於技術原因，當此鉤子應用於模組時，其 forward 函式將接收傳遞給模組的每個張量的檢視。同樣，呼叫者將接收模組 forward 函式返回的每個張量的檢視。

警告

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

引數：:

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

• 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)

註冊一個後置 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。

請注意，呼叫 load_state_dict() 時使用 strict=True 進行的檢查會受到 hook 對 missing_keys 或 unexpected_keys 所做修改的影響，這是符合預期的。向任何一組鍵中新增內容都會在 strict=True 時導致丟擲錯誤，而清空缺失和意外部索引鍵則可以避免錯誤。

返回值：:

一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子。

返回值型別：:

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，將在載入狀態字典前被呼叫。

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() 方法註冊一個前置 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。

返回值：:

自身

返回值型別：:

模組

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，可選) – 如果設定為 None，模組將使用 self.parameters() 進行重置。否則，我們將就地重置 tensordict 中的引數。這對於引數未儲存在模組本身中的函式式模組很有用。

返回值：:

新引數的 tensordict，僅當 parameters 不為 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)

此方法也支援函式式引數取樣

>>> 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 中找到的鍵。

這在想要擺脫複雜圖中的中間鍵或當這些鍵的存在可能觸發意外行為時很有用。

原始的 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)

此功能也適用於分派引數： .. 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 – 如果 target 字串引用了無效路徑或解析到的內容不是 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) – 如果提供，模組的狀態將更新到此 dict 中並返回同一物件。否則，將建立一個 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) – 其 dtype 和 device 是此模組中所有引數和緩衝區的期望 dtype 和 device 的 Tensor。

• memory_format (torch.memory_format) – 此模組中 4D 引數和緩衝區的期望記憶體格式（僅關鍵字引數）。

返回值：:

自身

返回值型別：:

模組

示例

>>> # 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) – 子模組的引數和緩衝區是否應遞迴移動到指定裝置。

返回值：:

自身

返回值型別：:

模組

train(mode: bool = True) → T

將模組設定為訓練模式。

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

引數：:

mode (bool) – 是否設定為訓練模式（True）或評估模式（False）。預設值：True。

返回值：:

自身

返回值型別：:

模組

type(dst_type: Union[dtype, str]) → T

將所有引數和緩衝區轉換為 dst_type。

注意

此方法會就地修改模組。

引數：:

dst_type (型別 或 字串) – 期望的型別。

返回值：:

自身

返回值型別：:

模組

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

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

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

注意

此方法會就地修改模組。

引數：:

device (整數，可選) – 如果指定，所有引數將複製到該裝置

返回值：:

自身

返回值型別：:

模組

zero_grad(set_to_none: bool = True) → None

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

請參閱 torch.optim.Optimizer 下的類似函式以獲取更多背景資訊。

引數：:

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