torch.optim.Optimizer.register_state_dict_post_hook¶
- Optimizer.register_state_dict_post_hook(hook, prepend=False)[原始碼][原始碼]¶
註冊一個 state dict 後處理 Hook,它將在
state_dict()
被呼叫後執行。它應該具有以下簽名:
hook(optimizer, state_dict) -> state_dict or None
這個 Hook 在於
self
上產生state_dict
之後,會被呼叫並帶有參數self
和state_dict
。這個 Hook 可以就地修改 state_dict,或者選擇性地返回一個新的 state_dict。註冊的 Hook 可用於在返回state_dict
之前,對它進行後處理。- 參數
hook (Callable) – 要註冊的使用者自定義 Hook。
prepend (bool) – 如果為 True,則提供的後處理
hook
將會在state_dict
上所有已註冊的後處理 Hook 之前被觸發。 否則,提供的hook
將在所有已註冊的後處理 Hook 之後被觸發。(預設:False)
- 返回值
一個 Handle,可用於透過呼叫
handle.remove()
來移除新增的 Hook- 返回類型
torch.utils.hooks.RemoveableHandle