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) – 要應用於每個子模組的函式
返回:: 自身
返回型別:: 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() 編譯此模組的 forward 方法。

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

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

cpu() → T¶

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

注意

此方法會原地修改模組。

返回:: 自身
返回型別:: Module

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

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

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

注意

此方法會原地修改模組。

引數:: device (int, 可選) – 如果指定，所有引數將被複制到該裝置
返回:: 自身
返回型別:: Module

double() → T¶

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

注意

此方法會原地修改模組。

返回:: 自身
返回型別:: Module

eval() → T¶

將模組設定為評估模式。

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

這等同於 self.train(False)。

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

返回:: 自身
返回型別:: Module

extra_repr() → str¶

返回模組的額外表示。

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

float() → T¶

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

注意

此方法會原地修改模組。

返回:: 自身
返回型別:: Module

forward(tensordict: TensorDictBase) → TensorDictBase[source]¶

根據多步變換重新寫入 tensordict。

引數:

tensordict –

形狀為 [*Batch x Time-steps] 的 tensordict.TensorDictBase 例項。該 TensorDict 必須包含 ("next", "reward") 和 ("next", "done") 鍵。所有包含在“next”巢狀 tensordict 中的鍵都將最多偏移 n_steps 幀。該 TensorDict 也將更新為新的鍵值對

gamma: 指示用於下一個獎勵的折扣因子;
nonterminal: 布林值，指示一個步驟是否是非終止的（未完成或不是軌跡的最後一步）;
original_reward: 在環境中收集到的前一個獎勵（即多步變換之前）;
“reward”值將被新計算出的獎勵替換。

"done" 鍵的形狀可以是 tensordict 的形狀，或者 tensordict 形狀後跟一個單維，或者 tensordict 形狀後跟其他維度。在後一種情況下，tensordict 必須與跟隨 done 形狀的 reshape 相容（即它包含的每個張量的 leading dimensions 必須與 "done" 條目的形狀匹配）。"reward" 張量的形狀可以是 tensordict（或 done 狀態）的形狀，或者該形狀後跟一個單維。

返回:

對輸入 tensordict 進行原地變換。

get_buffer(target: str) → Tensor¶

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

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

引數:: target – 要查詢的緩衝區的完整限定字串名稱。（有關如何指定完整限定字串，請參閱 get_submodule。）
返回:: 由 target 引用的緩衝區
返回型別:: torch.Tensor
丟擲:: AttributeError – 如果目標字串引用了無效路徑或解析到的不是緩衝區

get_extra_state() → Any¶

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

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

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

返回:: 要儲存在模組 state_dict 中的任何額外狀態
返回型別:: object

get_parameter(target: str) → Parameter¶

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

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

引數:: 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) 的。因此，對於簡單的檢查是否存在某個子模組，應始終使用 get_submodule。

引數:: target – 要查詢的子模組的完整限定字串名稱。（有關如何指定完整限定字串，請參閱上面的示例。）
返回:: 由 target 引用的子模組
返回型別:: torch.nn.Module
丟擲:: AttributeError – 如果目標字串引用了無效路徑或解析到的不是 nn.Module

half() → T¶

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

注意

此方法會原地修改模組。

返回:: 自身
返回型別:: Module

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

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

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

注意

此方法會原地修改模組。

引數:: device (int, 可選) – 如果指定，所有引數將被複制到該裝置
返回:: 自身
返回型別:: 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, 可選) – 是否嚴格執行 state_dict 中的鍵必須與此模組 state_dict() 函式返回的鍵匹配。預設值：True
assign (bool, 可選) – 設定為 False 時，保留當前模組中張量的屬性，而設定為 True 時保留 state dict 中張量的屬性。唯一的例外是的 requires_grad 欄位。預設值： ``False`

返回:

missing_keys 是一個包含任何預期鍵的 str 列表
此模組預期但提供的 state_dict 中缺少的鍵。
unexpected_keys 是一個包含未被預期
此模組預期但存在於提供的 state_dict 中的鍵的 str 列表。

返回型別:

包含 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, 可選) – 如果指定，所有引數將被複制到該裝置
返回:: 自身
返回型別:: 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, Tensor]]¶

返回模組引數的迭代器，同時產出引數的名稱和引數本身。

引數:

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，前向傳播鉤子將接收傳遞給前向傳播函式的 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 將接收傳遞給前向傳播函式的 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，前向傳播預鉤子將接收傳遞給前向傳播函式的 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 將接收傳遞給前向傳播函式的 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。

出於技術原因，當此鉤子應用於模組時，其前向傳播函式將接收傳遞給模組的每個 Tensor 的檢視 (view)。同樣，呼叫者也將接收模組前向傳播函式返回的每個 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。

出於技術原因，當此鉤子應用於模組時，其前向傳播函式將接收傳遞給模組的每個 Tensor 的檢視 (view)。同樣，呼叫者也將接收模組前向傳播函式返回的每個 Tensor 的檢視。

警告

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

引數:

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¶

更改自動求導是否應記錄此模組中引數的操作。

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

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

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

引數:: requires_grad (bool) – 自動求導是否應記錄此模組中引數的操作。預設值：True。
返回:: 自身
返回型別:: 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_b 本身有兩個子模組 net_c 和 linear。net_c 然後有一個子模組 conv。）

要將 Conv2d 替換為一個新的子模組 Linear，您可以呼叫 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

引數:

target – 要查詢的子模組的完整限定字串名稱。（有關如何指定完整限定字串，請參閱上面的示例。）
module – 要將子模組設定為何值。

丟擲:

ValueError – 如果目標字串為空。
AttributeError – 如果目標字串引用了無效路徑或解析到的不是 nn.Module

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

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

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

引數和持久緩衝區（例如執行平均值）都包含在內。鍵是相應的引數和緩衝區名稱。設定為 None 的引數和緩衝區不包含在內。

注意

返回的物件是淺複製。它包含對模組引數和緩衝區的引用。

警告

目前 state_dict() 也接受位置引數，順序為 destination、prefix 和 keep_vars。然而，這已被棄用，未來的版本將強制使用關鍵字引數。

警告

請避免使用引數 destination，因為它不適用於終端使用者。

引數:

destination (dict, optional) – 如果提供，模組的狀態將更新到該字典中，並返回同一個物件。否則，將建立一個 OrderedDict 並返回。預設值：None。
prefix (str, optional) – 新增到引數和緩衝區名稱以組成 state_dict 中的鍵的字首。預設值：''。
keep_vars (bool, optional) – 預設情況下，state dict 中返回的 Tensor 會從自動求導中分離。如果設定為 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 引數和緩衝區的期望記憶體格式（僅限關鍵字引數）。

返回:

自身

返回型別:

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, 可選) – 如果指定，所有引數將被複制到該裝置
返回:: 自身
返回型別:: Module

zero_grad(set_to_none: bool = True) → None¶

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

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

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

MultiStep¶

文件

教程

資源