RegisterCallBackFunc
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 Summary and Checkpoint callback APIs specified by users. If the graph sent to the GE contains the Summary and Checkpoint operators, the GE calls the registered callback function.
Prototype
1 | 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. For details, see RunCallBack in the table below. |
1 | using RunCallback = std::function<Status(uint32_t graph_id, const std::map<AscendString, gert::Tensor> ¶ms_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. |
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