MultiStep¶

class torchrl.data.MultiStep(gamma: float, n_steps: int)[source]¶

多步獎勵轉換。

於以下文獻中提出：

Sutton, R. S. 1988. Learning to predict by the methods of temporal differences. Machine learning 3(1):9–44.

此模組將「下一個」觀察值對應到 t + n「下一個」觀察值。當 n_steps 為 0 時，它是一個恆等轉換。

參數:

gamma (float) – 用於報酬計算的折扣因子
n_steps (integer) – 最大前瞻步數。

注意

此類別旨在於 DataCollector 中使用。它只會處理在收集結束時傳遞給它的資料，並忽略該收集之前的資料或下一個批次中的資料。因此，批次最後幾步的結果可能容易受到軌跡早期截斷的影響。為了減輕這種影響，請在重播緩衝區中使用 MultiStepTransform。

範例

>>> from torchrl.collectors import SyncDataCollector, RandomPolicy
>>> from torchrl.data.postprocs import MultiStep
>>> from torchrl.envs import GymEnv, TransformedEnv, StepCounter
>>> env = TransformedEnv(GymEnv("CartPole-v1"), StepCounter())
>>> env.set_seed(0)
>>> collector = SyncDataCollector(env, policy=RandomPolicy(env.action_spec),
...     frames_per_batch=10, total_frames=2000, postproc=MultiStep(n_steps=4, gamma=0.99))
>>> for data in collector:
...     break
>>> print(data["step_count"])
tensor([[0],
        [1],
        [2],
        [3],
        [4],
        [5],
        [6],
        [7],
        [8],
        [9]])
>>> # the next step count is shifted by 3 steps in the future
>>> print(data["next", "step_count"])
tensor([[ 5],
        [ 6],
        [ 7],
        [ 8],
        [ 9],
        [10],
        [10],
        [10],
        [10],
        [10]])

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(tensordict: TensorDictBase) → TensorDictBase[原始碼]¶

根據多步轉換重新編寫 tensordict。

參數:

tensordict –

tensordict.TensorDictBase 實例，具有 [*Batch x Time-steps] 形狀。 TensorDict 必須包含 ``("next", "reward") 和 ("next", "done")`` 鍵。所有包含在 “next” 巢狀 tensordict 中的鍵都將移動（最多）n_steps 幀。 TensorDict 也將使用新的鍵值對進行更新

gamma：表示用於下一個獎勵的折扣；
nonterminal：布林值，表示某個步驟是否為非終端 (未完成或不是軌跡的最後一步)；
original_reward：環境中收集的先前獎勵 (即，在多步之前)；
“reward” 值將被新計算的獎勵取代。

"done" 鍵可以具有 tensordict 的形狀，或 tensordict 的形狀後跟單例維度，或 tensordict 的形狀後跟其他維度。在後一種情況下，tensordict *必須*與遵循 done 形狀的 reshape 相容 (即，它包含的每個張量的 leading 維度必須與 "done" 條目的形狀相符)。 "reward" 張量可以具有 tensordict (或 done 狀態) 的形狀，或此形狀後跟單例維度。

傳回值:

輸入 tensordict 的原地轉換。

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

傳回值:: 要在模組 state_dict 中儲存的任何額外狀態
傳回類型:: object

get_parameter(target: str) → Parameter¶

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

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

參數:: target – 要尋找的參數的完整字串名稱。(請參閱 get_submodule 以了解如何指定完整字串。)
傳回值:: 由 target 引用的參數
傳回類型:: torch.nn.Parameter
引發:: AttributeError – 如果目標字串引用無效路徑或解析為非 nn.Parameter 的內容

get_submodule(target: str) → Module¶

如果存在，則傳回由 target 給定的子模組，否則拋出錯誤。

例如，假設您有一個 nn.Module A，如下所示

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
        )
        (linear): Linear(in_features=100, out_features=200, bias=True)
    )
)

(此圖顯示一個 nn.Module A。 A 有一個巢狀子模組 net_b，它本身有兩個子模組 net_c 和 linear。然後 net_c 有一個子模組 conv。)

若要檢查我們是否有 linear 子模組，我們會呼叫 get_submodule("net_b.linear")。若要檢查我們是否有 conv 子模組，我們會呼叫 get_submodule("net_b.net_c.conv")。

get_submodule 的執行時間受限於 target 中模組巢狀的程度。針對 named_modules 的查詢可以達到相同的結果，但它在傳遞模組的數量上是 O(N)。因此，對於簡單的檢查以查看是否存在某些子模組，應始終使用 get_submodule。

參數:: target – 要尋找的子模組的完整字串名稱。（有關如何指定完整字串，請參閱上面的範例。）
傳回值:: 由 target 引用的子模組
傳回類型:: torch.nn.Module
引發:: AttributeError – 如果目標字串引用無效路徑或解析為非 nn.Module 的物件。

half() → T¶

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

注意

此方法會就地修改模組。

傳回值:: self
傳回類型:: Module

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

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

這也會使相關聯的參數和緩衝區成為不同的物件。因此，如果在優化時模組將駐留在 IPU 上，則應在建構優化器之前呼叫它。

注意

此方法會就地修改模組。

參數:: device (int, optional) – 如果指定，所有參數都將複製到該裝置
傳回值:: self
傳回類型:: Module

load_state_dict(state_dict: Mapping[str, Any], strict: bool = True, assign: bool = False)¶

將參數和緩衝區從 state_dict 複製到此模組及其子模組。

如果 strict 為 True，則 state_dict 的鍵必須與此模組的 state_dict() 函數傳回的鍵完全匹配。

警告

如果 assign 為 True，則必須在呼叫 load_state_dict 後建立優化器，除非 get_swap_module_params_on_conversion() 為 True。

參數:

state_dict (dict) – 包含參數和持久緩衝區的字典。
strict (bool, optional) – 是否嚴格強制 state_dict 中的鍵與此模組的 state_dict() 函數傳回的鍵匹配。預設值：True
assign (bool, optional) – 當 False 時，保留目前模組中張量的屬性，而當 True 時，保留 state dict 中張量的屬性。唯一的例外是 requires_grad 欄位。 Default: ``False`

傳回值:

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

傳回類型:

具有 missing_keys 和 unexpected_keys 欄位的 NamedTuple

注意

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

modules() → Iterator[Module]¶

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

產生:: Module – 網路中的模組

注意

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

範例

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

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

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

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

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

注意

此方法會就地修改模組。

參數:: device (int, optional) – 如果指定，所有參數都將複製到該裝置
傳回值:: self
傳回類型:: Module

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

回傳一個遍歷模組緩衝區的迭代器，同時產生緩衝區的名稱和緩衝區本身。

參數:

prefix (str) – 要添加到所有緩衝區名稱前面的前綴。
recurse (bool, optional) – 如果為 True，則產生此模組和所有子模組的緩衝區。否則，僅產生屬於此模組直接成員的緩衝區。預設為 True。
remove_duplicate (bool, optional) – 是否刪除結果中重複的緩衝區。預設為 True。

產生:

(str, torch.Tensor) – 包含名稱和緩衝區的元組

範例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())

named_children() → Iterator[Tuple[str, Module]]¶

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

產生:: (str, Module) – 包含名稱和子模組的元組

範例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, module in model.named_children():
>>>     if name in ['conv4', 'conv5']:
>>>         print(module)

named_modules(memo: Optional[Set[Module]] = None, prefix: str = '', remove_duplicate: bool = True)¶

回傳一個遍歷網路中所有模組的迭代器，同時產生模組的名稱和模組本身。

參數:

memo – 一個記憶體，用於儲存已新增到結果中的模組集合
prefix – 將添加到模組名稱的前綴
remove_duplicate – 是否刪除結果中重複的模組實例

產生:

(str, Module) – 名稱和模組的元組

注意

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

範例

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

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

named_parameters(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) → Iterator[Tuple[str, Parameter]]¶

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

參數:

prefix (str) – 要添加到所有參數名稱前面的前綴。
recurse (bool) – 如果為 True，則產生此模組和所有子模組的參數。否則，僅產生屬於此模組直接成員的參數。
remove_duplicate (bool, optional) – 是否刪除結果中重複的參數。預設為 True。

產生:

(str, Parameter) – 包含名稱和參數的元組

範例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())

parameters(recurse: bool = True) → Iterator[Parameter]¶

回傳一個遍歷模組參數的迭代器。

這通常會傳遞給優化器。

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

範例

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

register_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]]) → RemovableHandle¶

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

此函數已被棄用，建議使用 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 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() 來移除已添加的鉤子

傳回類型:

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 中傳回一個元組或一個單一的修改後的值。如果傳回單一值，我們會將該值包裝到一個元組中 (除非該值已經是一個元組)。這個 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() 來移除已添加的鉤子

傳回類型:

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，也就是說，只有在計算模組輸出的梯度時，才會執行此 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 應用於模組時，其 forward 函數將接收傳遞給模組的每個 Tensor 的視圖。類似地，呼叫者將接收模組的 forward 函數返回的每個 Tensor 的視圖。

警告

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

參數:

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() 來移除已添加的鉤子

傳回類型:

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 hooks 時，不允許就地修改輸入，並且會引發錯誤。

參數:

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() 來移除已添加的鉤子

傳回類型:

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 是一個包含遺失鍵的 str list，而 unexpected_keys 是一個包含意外鍵的 str list。

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

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

傳回值:: 一個句柄，可用於通過調用 handle.remove() 來移除已添加的鉤子
傳回類型:: 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

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

requires_grad_(requires_grad: bool = True) → T¶

更改 autograd 是否應記錄此模組中參數上的操作。

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

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

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

參數:: requires_grad (bool) – autograd 是否應該記錄此模組中參數上的運算。預設值：True。
傳回值:: self
傳回類型:: Module

set_extra_state(state: Any) → None¶

設定載入的 state_dict 中包含的額外狀態。

此函數從 load_state_dict() 呼叫，以處理在 state_dict 中找到的任何額外狀態。如果您需要將額外狀態儲存在其 state_dict 中，請為您的模組實作此函數和對應的 get_extra_state()。

參數:: state (dict) – 來自 state_dict 的額外狀態

set_submodule(target: str, module: Module) → None¶

如果存在，則設定由 target 給定的子模組，否則拋出錯誤。

例如，假設您有一個 nn.Module A，如下所示

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
        )
        (linear): Linear(in_features=100, out_features=200, bias=True)
    )
)

(此圖顯示一個 nn.Module A。 A 有一個巢狀子模組 net_b，它本身有兩個子模組 net_c 和 linear。然後 net_c 有一個子模組 conv。)

要使用新的子模組 Linear 覆蓋 Conv2d，您可以呼叫 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

參數:

target – 要尋找的子模組的完整字串名稱。（有關如何指定完整字串，請參閱上面的範例。）
module – 用於設定子模組的模組。

引發:

ValueError – 如果目標字串為空
AttributeError – 如果目標字串引用無效路徑或解析為非 nn.Module 的物件。

share_memory() → T¶: 請參閱 torch.Tensor.share_memory_()。

state_dict(*args, destination=None, prefix='', keep_vars=False)¶

傳回一個字典，其中包含對模組整個狀態的引用。

包括參數和持久緩衝區（例如，移動平均值）。鍵是相應的參數和緩衝區名稱。設定為 None 的參數和緩衝區不包括在內。

注意

傳回的物件是一個淺拷貝。它包含對模組的參數和緩衝區的引用。

警告

目前，state_dict() 也接受 destination、prefix 和 keep_vars 的位置引數。但是，此做法已被棄用，並且將在未來的版本中強制執行關鍵字引數。

警告

請避免使用引數 destination，因為它不是為最終使用者設計的。

參數:

destination (dict, optional) – 如果提供，模組的狀態將更新到 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 Tensor 移動到 CUDA 裝置。

請參閱以下範例。

注意

此方法會就地修改模組。

參數:

device (torch.device) – 此模組中參數和緩衝區的目標裝置
dtype (torch.dtype) – 此模組中參數和緩衝區的目標浮點數或複數 dtype
tensor (torch.Tensor) – Tensor，其 dtype 和 device 是此模組中所有參數和緩衝區的目標 dtype 和 device
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()。

MultiStep¶

文件

教學

資源