TensorDictMap

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

TensorDict 的 Map-Storage。

此模組類似於儲存空間。它採用 tensordict 作為其輸入，並傳回另一個 tensordict 作為輸出，類似於 TensorDictModuleBase。但是，它提供了額外的功能，例如 python map

關鍵字引數:

• query_module (TensorDictModuleBase) – 查詢模組，通常是 QueryModule 的實例，用於將一組 tensordict 條目映射到雜湊金鑰。

• storage (Dict[NestedKey, TensorMap[torch.Tensor, torch.Tensor]]) – 代表從索引金鑰到張量儲存空間的映射的字典。

• collate_fn (callable, optional) – 用於整理儲存空間中樣本的函式。預設為每個已知儲存空間類型的自訂值（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) – 要應用於每個子模組的函數

回傳值:

self

回傳類型:

Module

範例

>>> @torch.no_grad()
>>> def init_weights(m):
>>>     print(m)
>>>     if type(m) == nn.Linear:
>>>         m.weight.fill_(1.0)
>>>         print(m.weight)
>>> net = nn.Sequential(nn.Linear(2, 2), nn.Linear(2, 2))
>>> net.apply(init_weights)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
)

bfloat16() → T

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

注意

此方法會就地修改模組。

回傳值:

self

回傳類型:

Module

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

回傳一個模組緩衝區的迭代器。

參數:

recurse (bool) – 如果為 True，則產生此模組和所有子模組的緩衝區。 否則，僅產生屬於此模組直接成員的緩衝區。

產生:

torch.Tensor – 模組緩衝區

範例

>>> # xdoctest: +SKIP("undefined vars")
>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

children() → Iterator[Module]

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

產生:

Module – 一個子模組

compile(*args, **kwargs)

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

此模組的 __call__ 方法會被編譯，並且所有引數會原封不動地傳遞給 torch.compile()。

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

cpu() → T

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

注意

此方法會就地修改模組。

回傳值:

self

回傳類型:

Module

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

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

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

注意

此方法會就地修改模組。

參數:

device (int, optional) – 如果指定，所有參數都將複製到該裝置

回傳值:

self

回傳類型:

Module

double() → T

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

注意

此方法會就地修改模組。

回傳值:

self

回傳類型:

Module

eval() → T

將模組設定為評估模式。

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

這等效於 self.train(False)。

有關 .eval() 與可能與其混淆的幾種類似機制的比較，請參閱 在本機停用梯度計算。

回傳值:

self

回傳類型:

Module

extra_repr() → str

設定模組的額外表示方式。

若要印出客製化的額外資訊，您應該在自己的模組中重新實作此方法。單行和多行字串都可接受。

float() → T

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

注意

此方法會就地修改模組。

回傳值:

self

回傳類型:

Module

forward(*input: Any) → None

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

應該由所有子類別覆寫。

注意

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

classmethod from_tensordict_pair(source, dest, in_keys: List[NestedKey], out_keys: Optional[List[NestedKey]] = None, storage_constructor: Optional[type] = None, hash_module: Optional[Callable] = None, collate_fn: Optional[Callable[[Any], Any]] = None, write_fn: Optional[Callable[[Any, Any], Any]] = None)

從一對 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（所有鍵都會註冊）。

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

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

• collate_fn (callable, optional) – 用於整理儲存空間中樣本的函式。預設為每個已知儲存空間類型的自訂值（ListStorage 為 stack，TensorStorage 子類型和其他類型為 identity）。

範例

>>> # 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 給定的緩衝區，否則會拋出錯誤。

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

參數:

target – 要尋找的緩衝區的完整字串名稱。（請參閱 get_submodule 了解如何指定完整字串。）

回傳值:

由 target 參照的緩衝區

回傳類型:

torch.Tensor

引發:

AttributeError – 如果目標字串參照無效的路徑或解析為不是緩衝區的物件

get_extra_state() → Any

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

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

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

回傳值:

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

回傳類型:

物件

get_parameter(target: str) → Parameter

傳回由 target 給定的參數（如果存在），否則拋出錯誤。

請參閱 get_submodule 的 docstring，以取得此方法功能的更詳細說明，以及如何正確指定 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) – 包含參數和持久緩衝區的 dict。

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

• assign (bool, optional) – 當 False 時，會保留目前模組中張量的屬性，而當 True 時，會保留 state dict 中張量的屬性。唯一的例外是 requires_grad 欄位。 Default: ``False`

回傳值:

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

  by this module but missing from the provided state_dict.

• unexpected_keys 是一個 str 的列表，包含此模組未預期但提供的 state_dict 中存在的鍵。

  expected by this module but present in the provided state_dict.

回傳類型:

NamedTuple 具有 missing_keys 和 unexpected_keys 欄位

注意

如果參數或緩衝區註冊為 None，且其對應的鍵存在於 state_dict 中，則 load_state_dict() 將引發 RuntimeError。

modules() → Iterator[Module]

傳回網路中所有模組的疊代器。

產生:

Module – 網路中的模組

注意

重複的模組只會傳回一次。在以下範例中，l 只會傳回一次。

範例

>>> l = nn.Linear(2, 2)
>>> net = nn.Sequential(l, l)
>>> for idx, m in enumerate(net.modules()):
...     print(idx, '->', m)

0 -> Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
)
1 -> Linear(in_features=2, out_features=2, bias=True)

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

將所有模型參數和緩衝區移至 MTIA。

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

注意

此方法會就地修改模組。

參數:

device (int, optional) – 如果指定，所有參數都將複製到該裝置

回傳值:

self

回傳類型:

Module

named_buffers(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) → Iterator[Tuple[str, Tensor]]

傳回模組緩衝區的疊代器，同時產生緩衝區的名稱和緩衝區本身。

參數:

• 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.remove() 來移除新增的 hook。

回傳類型:

torch.utils.hooks.RemovableHandle

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

將 buffer 新增到模組。

這通常用於註冊不應被視為模型參數的 buffer。例如，BatchNorm 的 running_mean 不是參數，但它是模組狀態的一部分。預設情況下，Buffer 是持久性的，並且會與參數一起儲存。可以透過將 persistent 設定為 False 來變更此行為。持久性 buffer 和非持久性 buffer 之間的唯一區別在於，後者不會是此模組的 state_dict 的一部分。

可以使用給定的名稱作為屬性存取 Buffer。

參數:

• name (str) – buffer 的名稱。可以使用給定的名稱從此模組存取 buffer

• tensor (Tensor 或 None) – 要註冊的 buffer。如果為 None，則會忽略在 buffer 上執行的操作，例如 cuda。如果為 None，則 buffer 不會包含在模組的 state_dict 中。

• persistent (bool) – buffer 是否為此模組的 state_dict 的一部分。

範例

>>> # xdoctest: +SKIP("undefined vars")
>>> self.register_buffer('running_mean', torch.zeros(num_features))

register_forward_hook(hook: Union[Callable[[T, Tuple[Any, ...], Any], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any], Any], Optional[Any]]], *, prepend: bool = False, with_kwargs: bool = False, always_call: bool = False) → RemovableHandle

在模組上註冊一個 forward hook。

每次在 forward() 計算出一個輸出後，都會呼叫這個 hook。

如果 with_kwargs 是 False 或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數將不會傳遞給 hooks，只會傳遞給 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 hooks 之前觸發。否則，提供的 hook 將會在該 torch.nn.modules.Module 上所有現有的 forward hooks 之後觸發。請注意，使用 register_module_forward_hook() 註冊的全域 forward hooks 將會在所有透過此方法註冊的 hooks 之前觸發。預設值：False

• with_kwargs (bool) – 如果為 True，則 hook 將會傳遞給 forward 函數的 kwargs。預設值：False

• always_call (bool) – 如果 True，無論在呼叫 Module 時是否引發例外，都會執行 hook。預設值：False

回傳值:

一個控制代柄，可用於透過呼叫 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

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

每次呼叫 forward() 之前，都會呼叫此 hook。

如果 with_kwargs 為 false 或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數不會傳遞給 hooks，只會傳遞給 forward。此 hook 可以修改輸入。使用者可以在 hook 中傳回 tuple 或單一修改過的值。如果傳回單一值（除非該值已經是 tuple），我們會將該值包裝成 tuple。此 hook 應具有以下簽章

hook(module, args) -> None or modified input

如果 with_kwargs 為 true，則 forward pre-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。

回傳類型:

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 應用於模組時，其 forward 函式將接收傳遞給模組的每個 Tensor 的視圖。同樣，呼叫者將接收模組 forward 函式傳回的每個 Tensor 的視圖。

警告

使用 backward hook 時，不允許就地修改輸入或輸出，並且會引發錯誤。

參數:

• 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.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 是一個 tuple。這個 hook 不應修改其引數，但它可以選擇性地傳回一個新的相對於輸出的梯度，該梯度將會取代後續計算中的 grad_output。grad_output 中的條目對於所有非 Tensor 引數都會是 None。

由於技術原因，當此 hook 應用於模組時，其 forward 函式將接收傳遞給模組的每個 Tensor 的視圖。同樣，呼叫者將接收模組 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.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 引數是一個 NamedTuple，包含 missing_keys 和 unexpected_keys 屬性。missing_keys 是一個 list 的 str，包含遺失的鍵，而 unexpected_keys 是一個 list 的 str，包含非預期的鍵。

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

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

回傳值:

一個控制代柄，可用於透過呼叫 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() 方法註冊一個 post-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

變更是否應自動記錄此模組中參數上的操作。

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

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

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

參數:

requires_grad (bool) – 自動求導是否應記錄此模組中參數上的操作。預設值：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，可選) – 如果設定為 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 – 如果目標字串引用無效路徑或解析為非 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) – 預設情況下，狀態字典中返回的 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，如果給定，但資料類型保持不變。 當設定 non_blocking 時，如果可能，它會嘗試相對於主機非同步地轉換/移動，例如，將具有鎖頁記憶體的 CPU 張量移動到 CUDA 裝置。

請參閱下面的範例。

注意

此方法會就地修改模組。

參數:

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

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

• tensor (torch.Tensor) – 張量，其資料類型和裝置是此模組中所有參數和緩衝區的所需資料類型和裝置

• 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) – 不是設定為零，而是將 grads 設定為 None。 有關詳細資訊，請參閱 torch.optim.Optimizer.zero_grad()。