TensorDictMap

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

TensorDict 的對映儲存。

此模組類似於儲存。它接受 tensordict 作為輸入，並返回另一個 tensordict 作為輸出，類似於 TensorDictModuleBase。然而，它提供了額外的功能，例如 Python 對映。

關鍵詞引數：

• query_module (TensorDictModuleBase) – 一個查詢模組，通常是 QueryModule 的例項，用於將一組 tensordict 條目對映到雜湊鍵。

• storage (Dict[NestedKey, TensorMap[torch.Tensor, torch.Tensor]]) – 一個字典，表示從索引鍵到張量儲存的對映。

• collate_fn (callable, optional) – 一個函式，用於從儲存中整理（collate）樣本。對於每種已知的儲存型別，預設值不同（ListStorage 為 stack，TensorStorage 子型別及其他為 identity）。

示例

>>> import torch
>>> from tensordict import TensorDict
>>> from typing import cast
>>> from torchrl.data import LazyTensorStorage
>>> query_module = QueryModule(
...     in_keys=["key1", "key2"],
...     index_key="index",
... )
>>> embedding_storage = LazyTensorStorage(1000)
>>> tensor_dict_storage = TensorDictMap(
...     query_module=query_module,
...     storage={"out": embedding_storage},
... )
>>> index = TensorDict(
...     {
...         "key1": torch.Tensor([[-1], [1], [3], [-3]]),
...         "key2": torch.Tensor([[0], [2], [4], [-4]]),
...     },
...     batch_size=(4,),
... )
>>> value = TensorDict(
...     {"out": torch.Tensor([[10], [20], [30], [40]])}, batch_size=(4,)
... )
>>> tensor_dict_storage[index] = value
>>> tensor_dict_storage[index]
TensorDict(
    fields={
        out: Tensor(shape=torch.Size([4, 1]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([4]),
    device=None,
    is_shared=False)
>>> assert torch.sum(tensor_dict_storage.contains(index)).item() == 4
>>> new_index = index.clone(True)
>>> new_index["key3"] = torch.Tensor([[4], [5], [6], [7]])
>>> retrieve_value = tensor_dict_storage[new_index]
>>> assert cast(torch.Tensor, retrieve_value["index"] == value["index"]).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) – 要應用於每個子模組的函式

返回：

自身

返回型別：

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

注意

此方法會就地修改模組。

返回：

自身

返回型別：

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() 編譯此模組的前向傳播。

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

有關此函式引數的詳細資訊，請參見 torch.compile()。

cpu() → T

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

注意

此方法會就地修改模組。

返回：

自身

返回型別：

Module

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

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

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

注意

此方法會就地修改模組。

引數：

device (int, optional) – 如果指定，所有引數將被複制到該裝置

返回：

自身

返回型別：

Module

double() → T

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

注意

此方法會就地修改模組。

返回：

自身

返回型別：

Module

eval() → T

將模組設定為評估模式。

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

這等同於 self.train(False)。

有關 .eval() 與可能與之混淆的幾種類似機制之間的比較，請參見 區域性停用梯度計算。

返回：

自身

返回型別：

Module

extra_repr() → str

返回模組的額外表示。

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

float() → T

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

注意

此方法會就地修改模組。

返回：

自身

返回型別：

Module

forward(*input: Any) → None

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

應被所有子類覆蓋（override）。

注意

雖然需要在函式內定義前向傳播（forward pass）的實現，但之後應該呼叫 Module 例項而不是直接呼叫此方法，因為前者負責執行已註冊的鉤子（hooks），而後者則會靜默忽略它們。

classmethod from_tensordict_pair(source, dest, in_keys: List[NestedKey], out_keys: List[NestedKey] | None = None, max_size: int = 1000, storage_constructor: type | None = None, hash_module: Callable | None = None, collate_fn: Callable[[Any], Any] | None = None, write_fn: Callable[[Any, Any], Any] | None = None, consolidated: bool | None = None) → TensorDictMap

使用預定義的經驗法則，從一對 tensordict（source 和 dest）建立一個新的 TensorDictStorage。

引數：

• source (TensorDict) – source tensordict 的示例，用作儲存中的索引。

• dest (TensorDict) – dest tensordict 的示例，用作儲存中的資料。

• in_keys (List[NestedKey]) – 在對映中使用的鍵列表。

• out_keys (List[NestedKey]) – 在輸出 tensordict 中返回的鍵列表。out_keys 中不存在的鍵，即使存在於 dest 中，也不會儲存在儲存中。預設為 None（所有鍵都註冊）。

• max_size (int, optional) – 儲存中的最大元素數量。如果傳遞了 storage_constructor 則忽略。預設為 1000。

• storage_constructor (Type, optional) – 張量儲存的型別。預設為 LazyDynamicStorage。其他選項包括 FixedStorage。

• hash_module (Callable, optional) – 在 QueryModule 中使用的雜湊函式。對於低維輸入，預設為 SipHash，對於較大輸入，預設為 RandomProjectionHash。

• collate_fn (callable, optional) – 一個函式，用於從儲存中整理（collate）樣本。對於每種已知的儲存型別，預設值不同（ListStorage 為 stack，TensorStorage 子型別及其他為 identity）。

• consolidated (bool, optional) – 是否將儲存合併到一個單獨的儲存張量中。預設為 False。

示例

>>> # The following example requires torchrl and gymnasium to be installed
>>> from torchrl.envs import GymEnv
>>> torch.manual_seed(0)
>>> env = GymEnv("CartPole-v1")
>>> env.set_seed(0)
>>> rollout = env.rollout(100)
>>> source, dest = rollout.exclude("next"), rollout.get("next")
>>> storage = TensorDictMap.from_tensordict_pair(
...     source, dest,
...     in_keys=["observation", "action"],
... )
>>> # maps the (obs, action) tuple to a corresponding next state
>>> storage[source] = dest
>>> print(source["_index"])
tensor([ 0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13])
>>> storage[source]
TensorDict(
    fields={
        done: Tensor(shape=torch.Size([14, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        observation: Tensor(shape=torch.Size([14, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        reward: Tensor(shape=torch.Size([14, 1]), device=cpu, dtype=torch.float32, is_shared=False),
        terminated: Tensor(shape=torch.Size([14, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        truncated: Tensor(shape=torch.Size([14, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([14]),
    device=None,
    is_shared=False)

get_buffer(target: str) → Tensor

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

有關此方法的更多功能詳情以及如何正確指定 target，請參見 get_submodule 的文件字串。

引數：

target – 要查詢的緩衝區的完全限定字串名稱。（有關如何指定完全限定字串，請參見 get_submodule。）

返回：

由 target 引用的緩衝區

返回型別：

torch.Tensor

引發：

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

get_extra_state() → Any

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

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

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

返回：

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

返回型別：

object

get_parameter(target: str) → Parameter

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

有關此方法的更多功能詳情以及如何正確指定 target，請參見 get_submodule 的文件字串。

引數：

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

注意

此方法會就地修改模組。

返回：

自身

返回型別：

Module

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

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

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

注意

此方法會就地修改模組。

引數：

device (int, optional) – 如果指定，所有引數將被複制到該裝置

返回：

自身

返回型別：

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

引數：

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

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

• assign (bool, 可選) – 當設定為 False 時，當前模組中張量的屬性將被保留；而設定為 True 時，則保留狀態字典中張量的屬性。唯一的例外是 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 (int, optional) – 如果指定，所有引數將被複制到該裝置

返回：

自身

返回型別：

Module

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() 之後呼叫的，因此不會影響 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，無論呼叫 Module 時是否引發異常，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 只對應作為位置引數給定的輸入，所有關鍵字引數都被忽略。grad_input 和 grad_output 中的非 Tensor 引數的條目將為 None。

出於技術原因，當此鉤子應用於 Module 時，其 forward 函式將接收傳遞給 Module 的每個 Tensor 的檢視。類似地，呼叫者將接收 Module 的 forward 函式返回的每個 Tensor 的檢視。

警告

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

引數：

• 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 是一個元組。鉤子不應修改其引數，但可以選擇返回一個新的、相對於輸出的梯度，該梯度將在後續計算中替代 grad_output 使用。grad_output 中的非 Tensor 引數對應的條目將為 None。

出於技術原因，當此鉤子應用於 Module 時，其 forward 函式將接收傳遞給 Module 的每個 Tensor 的檢視。類似地，呼叫者將接收 Module 的 forward 函式返回的每個 Tensor 的檢視。

警告

使用反向鉤子時不允許原地（inplace）修改輸入，否則會引發錯誤。

引數：

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

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

返回：

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

返回型別：

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)

在模組的 load_state_dict() 被呼叫後註冊一個後置鉤子。

它應具有以下簽名：

hook(module, incompatible_keys) -> None

module 引數是註冊此鉤子的當前模組，incompatible_keys 引數是一個 NamedTuple，包含 missing_keys 和 unexpected_keys 屬性。missing_keys 是一個包含缺失鍵的 str list，unexpected_keys 是一個包含意外部索引鍵的 str list。

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

請注意，當呼叫 load_state_dict() 並設定 strict=True 時執行的檢查會受到鉤子對 missing_keys 或 unexpected_keys 所做修改的影響，這是符合預期的。向任一鍵集合新增鍵將導致在 strict=True 時丟擲錯誤，而清除所有缺失和意外部索引鍵將避免錯誤。

返回：

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

返回型別：

torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)

在模組的 load_state_dict() 被呼叫前註冊一個預鉤子。

它應具有以下簽名：

hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950

引數：

hook (Callable) – 在載入狀態字典之前呼叫的可呼叫鉤子。

register_module(name: str, module: Optional[Module]) → None

add_module() 的別名。

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

向模組新增一個引數。

可以使用給定的名稱作為屬性訪問此引數。

引數：

• name (str) – 引數的名稱。可以使用此模組透過給定的名稱訪問該引數。

• param (Parameter or None) – 要新增到模組的引數。如果為 None，則對引數執行的操作（例如 cuda）將被忽略。如果為 None，則引數不會包含在模組的 state_dict 中。

register_state_dict_post_hook(hook)

為 state_dict() 方法註冊一個後置鉤子。

它應具有以下簽名：

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

註冊的鉤子可以原地修改 state_dict。

register_state_dict_pre_hook(hook)

為 state_dict() 方法註冊一個預鉤子。

它應具有以下簽名：

hook(module, prefix, keep_vars) -> None

註冊的鉤子可用於在呼叫 state_dict 之前執行預處理。

requires_grad_(requires_grad: bool = True) → T

更改 Autograd 是否應該記錄此模組中引數上的操作。

此方法原地設定引數的 requires_grad 屬性。

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

有關 .requires_grad_() 與可能與之混淆的幾種類似機制的比較，請參閱區域性停用梯度計算。

引數：

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

返回：

自身

返回型別：

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 of parameters, optional) – 如果設定為 None，模組將使用 self.parameters() 進行重置。否則，我們將原地重置 tensordict 中的引數。這對於引數不儲存在模組本身中的函式式模組（functional modules）非常有用。

返回：

新的引數 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)

此方法還支援函式式引數取樣（functional parameter sampling）

>>> 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 (a sequence of strings or tuples of strings) – 應包含在輸出 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 arguments)：.. 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) – 如果提供，模組的狀態將更新到此字典中，並返回同一個物件。否則，將建立一個 OrderedDict 並返回。預設值: None。

• prefix (str, optional) – 新增到引數和緩衝區名稱字首，用於構成 state_dict 中的鍵。預設值: ''。

• keep_vars (bool, optional) – 預設情況下，state dict 中返回的 Tensor 與 autograd 分離（detached）。如果設定為 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 後，如果可能，會嘗試相對於主機非同步進行轉換/移動，例如，將具有固定記憶體（pinned memory）的 CPU 張量移動到 CUDA 裝置。

請參閱下面的示例。

注意

此方法會就地修改模組。

引數：

• device (torch.device) – 此模組中引數和緩衝區的目標裝置。

• dtype (torch.dtype) – 此模組中引數和緩衝區的目標浮點或複數 dtype。

• tensor (torch.Tensor) – 一個張量，其 dtype 和 device 是此模組中所有引數和緩衝區的目標 dtype 和 device。

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

返回：

自身

返回型別：

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

返回：

自身

返回型別：

Module

train(mode: bool = True) → T

將模組設定為訓練模式。

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

引數：

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

返回：

自身

返回型別：

Module

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

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

注意

此方法會就地修改模組。

引數：

dst_type (type or string) – 目標型別

返回：

自身

返回型別：

Module

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

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

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

注意

此方法會就地修改模組。

引數：

device (int, optional) – 如果指定，所有引數將被複制到該裝置

返回：

自身

返回型別：

Module

zero_grad(set_to_none: bool = True) → None

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

更多上下文，請參閱 torch.optim.Optimizer 下的類似函式。

引數：

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