torch.optim.Optimizer.register_state_dict_post_hook¶
- Optimizer.register_state_dict_post_hook(hook, prepend=False)[源代码]¶
注册一个状态字典后挂钩,该挂钩将在调用
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