返回頂部

API#

class onnxruntime.training.ORTModule(module: Module, debug_options: Optional[DebugOptions] = None)[source]#

基類：Module

擴充套件使用者的 torch.nn.Module 模型，以利用 ONNX Runtime 的超快速訓練引擎。

ORTModule 對使用者的 torch.nn.Module 模型進行專門化，提供 forward()、backward() 以及所有其他 torch.nn.Module 的 API。

引數:

module (torch.nn.Module) – ORTModule 進行專門化的使用者 PyTorch 模組
debug_options (DebugOptions, optional) – ORTModule 的除錯選項。

初始化內部模組狀態，nn.Module 和 ScriptModule 共享此狀態。

forward(*inputs, **kwargs)[source]#

將 PyTorch 訓練的 forward() 傳遞委託給 ONNX Runtime。

對 forward 的第一次呼叫會執行設定和檢查步驟。在此呼叫期間，ORTModule 會確定該模組是否可以使用 ONNX Runtime 進行訓練。因此，第一次 forward 呼叫執行所需的時間比後續呼叫要長。如果 ONNX Runtime 無法處理模型進行訓練，則執行會中斷。

引數:

inputs – PyTorch 模組 forward 方法的位置引數和可變位置引數輸入。
kwargs – PyTorch 模組 forward 方法的關鍵字引數和可變關鍵字引數。

返回:

使用者 PyTorch 模組定義的 forward 方法的預期輸出。支援的輸出值包括張量、巢狀的張量序列和巢狀的張量值字典。

add_module(name: str, module: Optional[Module]) → None[source]#: 由於 ORTModule 不支援向其新增模組，因此會引發 ORTModuleTorchModelException 異常

property module#

此模組包裝的原始 torch.nn.Module。

此屬性提供對原始模組上的方法和屬性的訪問。

apply(fn: Callable[[Module], None]) → T[source]#: 覆蓋 apply()，將執行委託給 ONNX Runtime

train(mode: bool = True) → T[source]#: 覆蓋 train()，將執行委託給 ONNX Runtime

state_dict(destination=None, prefix='', keep_vars=False)[source]#: 覆蓋 state_dict()，將執行委託給 ONNX Runtime

load_state_dict(state_dict: OrderedDict[str, Tensor], strict: bool = True)[source]#: 覆蓋 load_state_dict()，將執行委託給 ONNX Runtime

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

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

get_parameter(target: str) → Parameter#: 覆蓋 get_parameter()

get_buffer(target: str) → Tensor#: 覆蓋 get_buffer()

parameters(recurse: bool = True) → Iterator[Parameter]#: 覆蓋 parameters()

named_parameters(prefix: str = '', recurse: bool = True) → Iterator[Tuple[str, Parameter]]#: 覆蓋 named_parameters()

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

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

named_children() → Iterator[Module]#: 覆蓋 named_children()

modules() → Iterator[Module]#: 覆蓋 modules()

named_modules(*args, **kwargs)#: 覆蓋 named_modules()

bfloat16() → T#

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

注意

此方法會就地修改模組。

返回:: self
返回型別:: Module

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

get_extra_state() → Any#

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

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

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

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

get_submodule(target: str) → Module#

如果存在，則返回由 target 指定的子模組，否則丟擲錯誤。

例如，假設您有一個 nn.Module A，它看起來像這樣

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

（圖表顯示了一個 nn.Module A。A 有一個巢狀的子模組 net_b，它本身有兩個子模組 net_c 和 linear。然後 net_c 有一個子模組 conv。）

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

get_submodule 的執行時受限於 target 中的模組巢狀深度。對 named_modules 的查詢也能達到相同的結果，但在傳遞模組數量上是 O(N) 的。因此，對於檢查某個子模組是否存在這樣簡單的操作，應該始終使用 get_submodule。

引數:: target – 要查詢的子模組的完全限定字串名稱。（有關如何指定完全限定字串的資訊，請參見上面的示例。）
返回:: 由 target 引用的子模組
返回型別:: torch.nn.Module
丟擲:: AttributeError – 如果沿著 target 字串形成的路徑的任何一點，（子）路徑解析為不存在的屬性名稱或不是 nn.Module 例項的物件。

half() → T#

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

注意

此方法會就地修改模組。

返回:: self
返回型別:: Module

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

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

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

注意

此方法會就地修改模組。

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

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

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

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

注意

此方法會就地修改模組。

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

register_backward_hook(hook: Callable[[Module, Union[tuple[torch.Tensor, ...], Tensor], Union[tuple[torch.Tensor, ...], Tensor], Union[None, tuple[torch.Tensor, ...], Tensor]]) → RemovableHandle#

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

此函式已棄用，推薦使用 register_full_backward_hook()。此函式的行為在未來版本中將發生變化。

返回:: 一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子
返回型別:: torch.utils.hooks.RemovableHandle

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.Module 上的所有現有 forward 鉤子之前觸發。否則，提供的 hook 將在此 torch.nn.Module 上的所有現有 forward 鉤子之後觸發。請注意，使用 register_module_forward_hook() 註冊的全域性 forward 鉤子將在透過此方法註冊的所有鉤子之前觸發。預設值: False
with_kwargs (bool) – 如果為 True，鉤子將獲得傳遞給 forward 函式的 kwargs。預設值: False
always_call (bool) – 如果為 True，無論呼叫模組時是否丟擲異常，鉤子都將執行。預設值: 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.Module 上的所有現有 forward_pre 鉤子之前觸發。否則，提供的 hook 將在此 torch.nn.Module 上的所有現有 forward_pre 鉤子之後觸發。請注意，使用 register_module_forward_pre_hook() 註冊的全域性 forward_pre 鉤子將在透過此方法註冊的所有鉤子之前觸發。預設值: False
with_kwargs (bool) – 如果為 true，鉤子將獲得傳遞給 forward 函式的 kwargs。預設值: False

返回:

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

返回型別:

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook: Callable[[Module, Union[tuple[torch.Tensor, ...], Tensor], Union[tuple[torch.Tensor, ...], Tensor], Union[None, tuple[torch.Tensor, ...], Tensor]], prepend: bool = False) → RemovableHandle#

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

每次計算模組的梯度時，都會呼叫此鉤子，即，僅當計算模組輸出的梯度時，此鉤子才會執行。鉤子應具有以下簽名

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

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

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

警告

在使用反向鉤子時，不允許在原地修改輸入或輸出，否則會丟擲錯誤。

引數:

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

返回:

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

返回型別:

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook: Callable[[Module, Union[tuple[torch.Tensor, ...], Tensor]], Union[None, tuple[torch.Tensor, ...], Tensor]], prepend: bool = False) → RemovableHandle#

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

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

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

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

警告

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

引數:

hook (Callable) – 要註冊的使用者定義的鉤子。
prepend (bool) – 如果為 True，提供的 `hook` 將在此 torch.nn.Module 上所有現有 `backward_pre` 鉤子之前觸發。否則，提供的 `hook` 將在此 torch.nn.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` 列表，`unexpected_keys` 是一個包含意外部索引鍵的 `str` 列表。

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

請注意，如預期一樣，使用 `strict=True` 呼叫 load_state_dict() 時執行的檢查會受到鉤子對 `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) – 在載入 state dict 之前將被呼叫的可呼叫鉤子。

register_module(name: str, module: Optional[Module]) → None#: `add_module()` 的別名。

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 訓練）。

請參閱 Locally disabling gradient computation，瞭解 `.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, strict: bool = False) → None#

設定由 `target` 指定的子模組（如果存在），否則丟擲錯誤。

注意

如果 `strict` 設定為 `False`（預設值），該方法將替換現有子模組或在父模組存在時建立新的子模組。如果 `strict` 設定為 `True`，該方法將僅嘗試替換現有子模組，並在子模組不存在時丟擲錯誤。

例如，假設您有一個 nn.Module A，它看起來像這樣

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(3, 3, 3)
        )
        (linear): Linear(3, 3)
    )
)

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

要將 `Conv2d` 覆蓋為一個新的子模組 `Linear`，您可以呼叫 set_submodule("net_b.net_c.conv", nn.Linear(1, 1))，其中 `strict` 可以是 `True` 或 `False`

要向現有的 `net_b` 模組新增一個新的子模組 `Conv2d`，您可以呼叫 set_submodule("net_b.conv", nn.Conv2d(1, 1, 1))。

在上述示例中，如果您設定 `strict=True` 並呼叫 set_submodule("net_b.conv", nn.Conv2d(1, 1, 1), strict=True)，將引發 AttributeError，因為 `net_b` 沒有名為 `conv` 的子模組。

引數:

target – 要查詢的子模組的完全限定字串名稱。（有關如何指定完全限定字串的資訊，請參見上面的示例。）
module – 要將子模組設定為何值。
strict – 如果為 `False`，該方法將替換現有子模組或在父模組存在時建立新的子模組。如果為 `True`，該方法將僅嘗試替換現有子模組，並在子模組尚不存在時丟擲錯誤。

丟擲:

ValueError – 如果 `target` 字串為空或 `module` 不是 `nn.Module` 的例項。
AttributeError – 如果在 `target` 字串形成的路徑中的任何位置，(子)路徑解析為不存在的屬性名稱或不是 `nn.Module` 例項的物件。

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

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

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

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

注意

此方法會就地修改模組。

引數:: dst_type (type or 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) – 不設定為零，而是將梯度設定為 None。有關詳細資訊，請參閱 torch.optim.Optimizer.zero_grad()。