昇腾社区首页
中文
注册

tft_register_stop_handler

接口功能

注册在恢复过程中,停止训练的回调函数。

对于MindSpeed-LLM和MindSpeed训练框架,回调函数已由MindIO TFT完成适配;其他框架,回调函数的安全性需由用户保证。

接口格式

mindio_ttp.framework_ttp.tft_register_stop_handler(func: Callable, ctx = None)

接口参数

参数

是否必选

说明

取值要求

func

必选

停止训练的回调函数,完成停止训练的功能,并抛出FORCE STOP异常将训练主线程控制权交由装饰器接管。

回调函数,不为空,回调函数入参要求请参见表1,约定该回调函数无返回值,执行失败抛出异常。

ctx

可选

回调函数上下文。

默认为空。

表1 回调函数参数

参数

是否必选

说明

取值要求

args

-

tft_set_step_args设置的参数。

由注册方决定。

ctx

-

回调函数上下文。

由注册方决定。

返回值

无返回值,出错会打印ERROR日志、抛出异常。