NAdam¶
- class torch.optim.NAdam(params, lr=0.002, betas=(0.9, 0.999), eps=1e-08, weight_decay=0, momentum_decay=0.004, decoupled_weight_decay=False, *, foreach=None, maximize=False, capturable=False, differentiable=False)[source][source]¶
實現 NAdam 演算法。
有關該演算法的更多詳細資訊，請參閱 將 Nesterov 動量引入 Adam。
- 引數
params (iterable) – 要最佳化的引數的可迭代物件或 named_parameters，或定義引數組的字典的可迭代物件。使用 named_parameters 時，所有組中的所有引數都應命名
betas (Tuple[float, float], 可選) – 用於計算梯度及其平方的執行平均值的係數 (預設值: (0.9, 0.999))
eps (float, 可選) – 新增到分母中以提高數值穩定性的項 (預設值: 1e-8)
weight_decay (float, 可選) – 權重衰減 (L2 懲罰) (預設值: 0)
momentum_decay (float, 可選) – 動量衰減 (預設值: 4e-3)
decoupled_weight_decay (bool, 可選) – 是否像 AdamW 中那樣解耦權重衰減以獲得 NAdamW。如果為 True，演算法不會在動量或方差中累積權重衰減。(預設值: False)
foreach (bool, 可選) – 是否使用最佳化器的 foreach 實現。如果使用者未指定 (即 foreach 為 None)，我們將在 CUDA 上嘗試使用 foreach 實現而非 for-loop 實現，因為它通常效能顯著更高。請注意，foreach 實現比 for-loop 版本多佔用大約 sizeof(params) 的峰值記憶體，因為中間結果是一個 tensorlist 而不是一個 tensor。如果記憶體受限，請每次透過最佳化器的引數批次減少或將此標誌切換為 False (預設值: None)
maximize (bool, 可選) – 相對於引數最大化目標函式，而不是最小化 (預設值: False)
capturable (bool, 可選) – 此例項是否可以在 CUDA graph 中安全捕獲。傳遞 True 可能會影響未圖形化時的效能，因此如果您不打算對該例項進行圖形捕獲，請將其保留為 False (預設值: False)
differentiable (bool, 可選) – 在訓練期間，autograd 是否應穿過最佳化器步驟。否則，step() 函式將在 torch.no_grad() 上下文中執行。設定為 True 可能會影響效能，因此如果您不打算透過此例項執行 autograd，請將其保留為 False (預設值: False)
- add_param_group(param_group)[source][source]¶
向
Optimizer的 param_groups 新增一個引數組。這在微調預訓練網路時很有用，因為可以在訓練過程中使凍結的層變為可訓練並將其新增到
Optimizer中。- 引數
param_group (dict) – 指定哪些 Tensor 應該被最佳化，以及組特定的最佳化選項。
- load_state_dict(state_dict)[source]¶
載入最佳化器狀態。
- 引數
state_dict (dict) – 最佳化器狀態。應該是呼叫
state_dict()返回的物件。
注意
引數的名稱 (如果在
state_dict()中每個引數組的 “param_names” 鍵下存在) 不會影響載入過程。要在自定義情況下使用引數名稱 (例如，載入的狀態字典中的引數與最佳化器中初始化的引數不同時)，應實現自定義的register_load_state_dict_pre_hook來相應地調整載入的字典。如果在載入的狀態字典param_groups中存在param_names，它們將被儲存，並覆蓋最佳化器狀態中當前的名稱（如果存在）。如果在載入的狀態字典中不存在，最佳化器的param_names將保持不變。
- register_load_state_dict_post_hook(hook, prepend=False)[source]¶
註冊一個 load_state_dict 後置鉤子，它將在呼叫
load_state_dict()之後被呼叫。它應具有以下簽名hook(optimizer) -> None
optimizer引數是正在使用的最佳化器例項。鉤子將在對
self呼叫load_state_dict後，帶引數self被呼叫。註冊的鉤子可用於在load_state_dict載入state_dict後執行後處理。- 引數
hook (Callable) – 要註冊的使用者定義的鉤子。
prepend (bool) – 如果為 True，則提供的後置
hook將在所有已註冊的 load_state_dict 後置鉤子之前觸發。否則，提供的hook將在所有已註冊的後置鉤子之後觸發。(預設值: False)
- 返回值
一個控制代碼，可以透過呼叫
handle.remove()來移除新增的鉤子- 返回型別
torch.utils.hooks.RemoveableHandle
- register_load_state_dict_pre_hook(hook, prepend=False)[source]¶
註冊一個 load_state_dict 前置鉤子，它將在呼叫
load_state_dict()之前被呼叫。它應具有以下簽名hook(optimizer, state_dict) -> state_dict or None
optimizer引數是正在使用的最佳化器例項，state_dict引數是使用者傳入load_state_dict的state_dict的淺複製。鉤子可以就地修改 state_dict，或者可選地返回一個新的 state_dict。如果返回了 state_dict，它將用於載入到最佳化器中。鉤子將在對
self呼叫load_state_dict之前，帶引數self和state_dict被呼叫。註冊的鉤子可用於在進行load_state_dict呼叫之前執行預處理。- 引數
hook (Callable) – 要註冊的使用者定義的鉤子。
prepend (bool) – 如果為 True，則提供的前置
hook將在所有已註冊的 load_state_dict 前置鉤子之前觸發。否則，提供的前置hook將在所有已註冊的前置鉤子之後觸發。(預設值: False)
- 返回值
一個控制代碼，可以透過呼叫
handle.remove()來移除新增的鉤子- 返回型別
torch.utils.hooks.RemoveableHandle
- register_state_dict_post_hook(hook, prepend=False)[source]¶
註冊一個 state dict 後置鉤子，它將在呼叫
state_dict()之後被呼叫。它應具有以下簽名
hook(optimizer, state_dict) -> state_dict or None
鉤子將在對
self生成state_dict後，帶引數self和state_dict被呼叫。鉤子可以就地修改 state_dict，或者可選地返回一個新的 state_dict。註冊的鉤子可用於在返回 state_dict 之前執行後處理。- 引數
hook (Callable) – 要註冊的使用者定義的鉤子。
prepend (bool) – 如果為 True，則提供的後置
hook將在所有已註冊的 state_dict 後置鉤子之前觸發。否則，提供的後置hook將在所有已註冊的後置鉤子之後觸發。(預設值: False)
- 返回值
一個控制代碼，可以透過呼叫
handle.remove()來移除新增的鉤子- 返回型別
torch.utils.hooks.RemoveableHandle
- register_state_dict_pre_hook(hook, prepend=False)[source]¶
註冊一個 state dict 前置鉤子，它將在呼叫
state_dict()之前被呼叫。它應具有以下簽名
hook(optimizer) -> None
optimizer引數是正在使用的最佳化器例項。鉤子將在對self呼叫state_dict之前，帶引數self被呼叫。註冊的鉤子可用於在進行state_dict呼叫之前執行預處理。- 引數
hook (Callable) – 要註冊的使用者定義的鉤子。
prepend (bool) – 如果為 True，則提供的前置
hook將在所有已註冊的 state_dict 前置鉤子之前觸發。否則，提供的前置hook將在所有已註冊的前置鉤子之後觸發。(預設值: False)
- 返回值
一個控制代碼，可以透過呼叫
handle.remove()來移除新增的鉤子- 返回型別
torch.utils.hooks.RemoveableHandle
- register_step_post_hook(hook)[source]¶
註冊一個最佳化器步驟後置鉤子，它將在最佳化器步驟之後被呼叫。
它應具有以下簽名
hook(optimizer, args, kwargs) -> None
optimizer引數是正在使用的最佳化器例項。- 引數
hook (Callable) – 要註冊的使用者定義的鉤子。
- 返回值
一個控制代碼，可以透過呼叫
handle.remove()來移除新增的鉤子- 返回型別
torch.utils.hooks.RemovableHandle
- register_step_pre_hook(hook)[source]¶
註冊一個最佳化器步驟前置鉤子，它將在最佳化器步驟之前被呼叫。
它應具有以下簽名
hook(optimizer, args, kwargs) -> None or modified args and kwargs
optimizer引數是正在使用的最佳化器例項。如果 args 和 kwargs 被前置鉤子修改，則轉換後的值將作為包含 new_args 和 new_kwargs 的元組返回。- 引數
hook (Callable) – 要註冊的使用者定義的鉤子。
- 返回值
一個控制代碼，可以透過呼叫
handle.remove()來移除新增的鉤子- 返回型別
torch.utils.hooks.RemovableHandle
- state_dict()[source]¶
將最佳化器的狀態作為
dict返回。它包含兩個條目
state: 一個包含當前最佳化狀態的 Dict。其內容因最佳化器類的不同而異，但有一些共同的特點。例如，狀態按引數儲存，引數本身不儲存。
state是一個字典，將引數 ID 對映到包含對應每個引數狀態的 Dict。
param_groups: 一個包含所有引數組的 List，其中每個引數組都是一個 Dict。每個引數組都包含最佳化器特定的元資料，例如學習率和權重衰減，以及該組中引數的引數 ID 列表。如果引數組是使用
named_parameters()初始化的，名稱內容也將儲存在狀態字典中。
注意：引數 ID 可能看起來像索引，但它們只是將狀態與 param_group 關聯起來的 ID。從 state_dict 載入時，最佳化器將壓縮 param_group 的
params（整數 ID）和最佳化器的param_groups（實際的nn.Parameter）以便匹配狀態，無需額外驗證。返回的狀態字典可能看起來像這樣
{ 'state': { 0: {'momentum_buffer': tensor(...), ...}, 1: {'momentum_buffer': tensor(...), ...}, 2: {'momentum_buffer': tensor(...), ...}, 3: {'momentum_buffer': tensor(...), ...} }, 'param_groups': [ { 'lr': 0.01, 'weight_decay': 0, ... 'params': [0] 'param_names' ['param0'] (optional) }, { 'lr': 0.001, 'weight_decay': 0.5, ... 'params': [1, 2, 3] 'param_names': ['param1', 'layer.weight', 'layer.bias'] (optional) } ] }
- zero_grad(set_to_none=True)[source]¶
重置所有最佳化過的
torch.Tensor的梯度。- 引數
set_to_none (bool) – 不設定為零，而是將梯度設定為 None。這通常會減少記憶體佔用，並可適度提高效能。但是，它會改變某些行為。例如：1. 當用戶嘗試訪問梯度並對其執行手動操作時，None 屬性或全為 0 的 Tensor 的行為將不同。2. 如果使用者請求
zero_grad(set_to_none=True)，然後進行反向傳播，則對於未接收到梯度的引數，.grads 保證為 None。3. 如果梯度為 0 或 None，torch.optim最佳化器的行為不同 (在一種情況下，它會使用 0 梯度執行步驟，在另一種情況下，它會完全跳過該步驟)。
