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