tft_register_stop_handler

Function

Registers the callback function for stopping training during recovery.

For MindSpeed-LLM, the callback function has been adapted by MindIO TFT. For other frameworks, you need to ensure the security of the callback function.

Format

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

Parameters

Parameter	Mandatory/Optional	Description	Value
func	Mandatory	Callback function for stopping training. After training is stopped, it throws the FORCE STOP exception and hands over the control of the main training thread to the decorator.	The callback function cannot be empty. For details about the input parameters of the callback function, see Table 1. The callback function has no return value. If the execution fails, an exception is thrown.
ctx	Optional	Callback function context.	This parameter is left empty by default.

**Table 1** Parameters of the callback function
Parameter	Mandatory/Optional	Description	Value
args	-	Parameter set by tft_set_step_args.	Determined by the registration party.
ctx	-	Callback function context.	Determined by the registration party.

Return Value

No return value. If an error occurs, an error log is recorded and an exception is thrown.

Parent topic: API Reference