torch.optim.Optimizer.register_state_dict_pre_hook¶
- Optimizer.register_state_dict_pre_hook(hook, prepend=False)[原始碼][原始碼]¶
註冊一個 state dict 的 pre-hook,它會在呼叫
state_dict()
之前被呼叫。它應該具有以下簽名:
hook(optimizer) -> None
引數
optimizer
是正在使用的 optimizer 實例。 在self
上呼叫state_dict
之前,hook 會使用引數self
呼叫。 註冊的 hook 可用於在進行state_dict
呼叫之前執行前處理。- 引數
hook (Callable) – 要註冊的使用者定義 hook。
prepend (bool) – 如果為 True,則提供的 pre
hook
將在state_dict
上所有已註冊的 pre-hook 之前觸發。 否則,提供的hook
將在所有已註冊的 pre-hook 之後觸發。(預設值:False)
- 回傳
一個 handle,可用於透過呼叫
handle.remove()
來移除添加的 hook- 回傳型別
torch.utils.hooks.RemoveableHandle