tft_register_rename_handler

注册框架侧rename回调函数。

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

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

参数	是否必选	说明	取值要求
func	必选	rename函数，将保存成功的临终CheckPoint修改命名，与原生框架CheckPoint命名规则一致。	回调函数，不为空，回调函数入参要求请参见表回调函数参数，约定该回调函数无返回值，执行失败抛出异常。
ctx	可选	回调函数上下文。	默认为空。

表1 MindSpore回调函数参数
参数	是否必选	说明	取值要求
step	-	dump优化器数据时对应的step。	正整数。
ctx	-	回调函数上下文。	由注册方决定。

表2 非MindSpore回调函数参数
参数	是否必选	说明	取值要求
step	-	dump优化器数据时对应的step。	正整数。
args	-	tft_set_step_args设置的参数。	由注册方决定。

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

父主题： API接口参考