torch.optim.Optimizer.register_state_dict_pre_hook#
- Optimizer.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