RegisterCallBackFunc

Applicability

Product	Supported
Atlas 350 Accelerator Card	√
Atlas A3 training product/Atlas A3 inference product	√
Atlas A2 training product/Atlas A2 inference product	√
Atlas 200I/500 A2 inference product	x
Atlas inference product	√
Atlas training product	√

Header File/Library File

Header file: #include <ge/ge_api_v2.h>
Library file: libge_runner_v2.so

Function Usage

Registers a callback function.

Registers the specified Summary and Checkpoint callback function, which will be called by GE if the graph sent to GE contains Summary and Checkpoint operators.

Prototype

Status RegisterCallBackFunc(const char *key, const RunCallBack &callback)

Parameters

Parameter

Input/Output

Description

key

Input

Keyword of the callback function to be registered, indicating the callback function type. The value is a string or character, for example, Summary and Save.

callback

Input

Information to be returned by the callback function.

typedef uint32_t session::(*RunCallBack)(uint32_t graph_id, const std::map<AscendString, gert::Tensor> &params_list);

Returns

Parameter	Type	Description
-	Status	GE_SESSION_MANAGER_NOT_INIT: Session management is not initialized. SUCCESS: The callback function is successfully registered. FAILED: The callback function fails to be registered.

Parameter

Type

Description

Status

GE_SESSION_MANAGER_NOT_INIT: Session management is not initialized.

SUCCESS: The callback function is successfully registered.

FAILED: The callback function fails to be registered.

Restrictions

The callback function type can only be Summary or Save.
If the function fails to be registered and the sent graph contains Summary and Checkpoint operators, an error will be reported.
Currently, the callback function can be called only once after a graph is executed.

Parent topic: GESession