torch.optim.Optimizer.register_state_dict_post_hook¶
- Optimizer.register_state_dict_post_hook(hook, prepend=False)[source][source]¶
注册一个状态字典后钩子,该钩子将在调用
state_dict()
之后被调用。它应该具有以下签名:
hook(optimizer, state_dict) -> state_dict or None
在生成
self
上的state_dict
之后,将以参数self
和state_dict
调用钩子。钩子可以就地修改状态字典或可选地返回一个新的状态字典。已注册的钩子可用于在返回之前对state_dict
执行后处理。- 参数:
hook(可调用对象)- 用户定义的将被注册的钩子。
prepend (bool) – 如果为 True,提供的后处理
hook
将在所有已注册的后处理钩子state_dict
之前触发。否则,提供的hook
将在所有已注册的后处理钩子之后触发。(默认:False)
- 返回值:
一个可以用来通过调用
handle.remove()
移除已添加钩子的句柄。- 返回类型:
torch.utils.hooks.RemoveableHandle