API List (Atlas A2 training products /Atlas A2 inference products )
APIs for the
- √: supported
- x: not supported
- Deprecated: The API will be deprecated in later versions. For details, see Deprecated APIs and Return Codes.
Directory |
API |
|
|---|---|---|
System configuration |
aclInit |
√ |
aclFinalize |
√ |
|
aclrtGetVersion |
√ |
|
aclSetCompileopt |
√ |
|
aclGetRecentErrMsg |
√ |
|
aclAppLog |
√ |
|
aclDataTypeSize |
√ |
|
aclFloat16ToFloat |
√ |
|
aclFloatToFloat16 |
√ |
|
aclGenGraphAndDumpForOp |
√ |
|
Runtime Management > Device Management |
aclrtSetDevice |
√ |
aclrtResetDevice |
√ |
|
aclrtGetDevice |
√ |
|
aclrtGetRunMode |
√ |
|
aclrtSetTsDevice |
√ |
|
aclrtGetDeviceCount |
√ |
|
aclrtGetDeviceUtilizationRate |
√ |
|
aclrtSynchronizeDevice |
√ |
|
aclrtGetSocName |
√ |
|
aclrtSetDeviceSatMode |
√ |
|
aclrtGetDeviceSatMode |
√ |
|
Runtime Management > Context Management |
aclrtCreateContext |
√ |
aclrtDestroyContext |
√ |
|
aclrtSetCurrentContext |
√ |
|
aclrtGetCurrentContext |
√ |
|
aclrtCtxSetSysParamOpt |
√ |
|
aclrtCtxGetSysParamOpt |
√ |
|
aclrtGetOverflowStatus |
√ |
|
aclrtResetOverflowStatus |
√ |
|
Runtime Management > Stream Management |
aclrtCreateStream |
√ |
aclrtCreateStreamV2 |
☓ |
|
aclrtSetStreamConfigOpt |
☓ |
|
aclrtCreateStreamWithConfig |
√ |
|
aclrtDestroyStream |
√ |
|
aclrtDestroyStreamForce |
√ |
|
aclrtSetStreamOverflowSwitch |
√ |
|
aclrtGetStreamOverflowSwitch |
√ |
|
aclrtSetStreamFailureMode |
√ |
|
aclrtSynchronizeStream |
√ |
|
aclrtSynchronizeStreamWithTimeout |
√ |
|
Runtime Management > Event Management |
aclrtCreateEvent |
√ |
aclrtCreateEventWithFlag |
√ |
|
aclrtDestroyEvent |
√ |
|
aclrtRecordEvent |
√ |
|
aclrtResetEvent |
√ |
|
aclrtQueryEvent |
Deprecated |
|
aclrtQueryEventStatus |
√ |
|
aclrtQueryEventWaitStatus |
√ |
|
aclrtSynchronizeEvent |
√ |
|
aclrtSynchronizeEventWithTimeout |
√ |
|
aclrtEventElapsedTime |
√ |
|
aclrtStreamWaitEvent |
√ |
|
aclrtSetOpWaitTimeout |
√ |
|
Runtime Management > Memory Management |
aclrtMalloc |
√ |
aclrtMallocAlign32 |
√ |
|
aclrtMallocCached |
√ |
|
aclrtMemFlush |
√ |
|
aclrtMemInvalidate |
√ |
|
aclrtFree |
√ |
|
aclrtMallocHost |
√ |
|
aclrtFreeHost |
√ |
|
aclrtMemset |
√ |
|
aclrtMemsetAsync |
√ |
|
aclrtMemcpy |
√ |
|
aclrtMemcpyAsync |
√ |
|
aclrtGetMemInfo |
√ |
|
aclrtDeviceCanAccessPeer |
√ |
|
aclrtDeviceEnablePeerAccess |
√ |
|
aclrtDeviceDisablePeerAccess |
√ |
|
aclrtMemcpy2d |
√ |
|
aclrtMemcpy2dAsync |
√ |
|
aclrtAllocatorRegister |
√ |
|
aclrtAllocatorUnregister |
√ |
|
Runtime Management > Execution Control |
aclrtSubscribeReport |
√ |
aclrtLaunchCallback |
√ |
|
aclrtProcessReport |
√ |
|
aclrtUnSubscribeReport |
√ |
|
Runtime Management > Exception Handling |
aclrtSetExceptionInfoCallback |
√ |
aclrtGetTaskIdFromExceptionInfo |
√ |
|
aclrtGetStreamIdFromExceptionInfo |
√ |
|
aclrtGetThreadIdFromExceptionInfo |
√ |
|
aclrtGetDeviceIdFromExceptionInfo |
√ |
|
aclrtGetErrorCodeFromExceptionInfo |
√ |
|
Runtime Management > Group Management |
aclrtSetGroup |
☓ |
aclrtGetGroupCount |
☓ |
|
aclrtCreateGroupInfo |
☓ |
|
aclrtDestroyGroupInfo |
☓ |
|
aclrtGetAllGroupInfo |
☓ |
|
aclrtGetGroupInfoDetail |
☓ |
|
Model Inference > Model Loading |
aclmdlLoadFromFile |
√ |
aclmdlLoadFromMem |
√ |
|
aclmdlLoadFromFileWithMem |
√ |
|
aclmdlLoadFromMemWithMem |
√ |
|
aclmdlLoadFromFileWithQ |
√ |
|
aclmdlLoadFromMemWithQ |
√ |
|
aclmdlSetConfigOpt |
√ |
|
aclmdlLoadWithConfig |
√ |
|
Model Inference > Model Execution |
aclmdlExecute |
√ |
aclmdlExecuteAsync |
√ |
|
aclmdlSetExecConfigOpt |
√ |
|
aclmdlExecuteV2 |
√ |
|
aclmdlExecuteAsyncV2 |
☓ |
|
aclmdlUnload |
√ |
|
aclmdlQuerySize |
√ |
|
aclmdlQuerySizeFromMem |
√ |
|
aclmdlSetDynamicBatchSize |
√ |
|
aclmdlSetDynamicHWSize |
√ |
|
aclmdlSetInputAIPP |
☓ |
|
aclmdlGetFirstAippInfo |
☓ |
|
aclmdlGetAippType |
☓ |
|
aclmdlSetAIPPByInputIndex |
☓ |
|
aclmdlSetInputDynamicDims |
√ |
|
aclmdlCreateAndGetOpDesc |
√ |
|
aclmdlInitDump |
√ |
|
aclmdlSetDump |
√ |
|
aclmdlFinalizeDump |
√ |
|
Single-Operator Execution > Single-Operator API Execution |
Common APIs (AscendCL meta) NOTE:
These are dependent AscendCL meta APIs for defining operators. These APIs can be used to build the required data structures, such as aclTensor, aclScalar, and aclIntArray. |
√ |
NN operator APIs (aclnn) NOTE:
These are core functional APIs provided by aclnn. They can implement basic tensor computing (such as addition, subtraction, multiplication, and division) and NN-related operations (such as convolution, pooling, and activation functions). |
√ |
|
Single-Operator Execution > Single-Operator Model Execution |
aclopSetModelDir |
√ |
aclopLoad |
√ |
|
aclopSetCompileFlag |
Deprecated |
|
aclopCompile |
√ |
|
aclopExecute |
Deprecated |
|
aclopExecuteV2 |
√ |
|
aclopCompileAndExecute |
√ |
|
aclopCompileAndExecuteV2 |
√ |
|
aclopExecWithHandle |
√ |
|
aclopInferShape |
√ |
|
aclrtSetOpExecuteTimeOut |
√ |
|
aclopRegisterCompileFunc |
√ |
|
aclopUnregisterCompileFunc |
√ |
|
aclopCreateKernel |
√ |
|
aclopSetKernelArgs |
√ |
|
aclopSetKernelWorkspaceSizes |
√ |
|
aclopUpdateParams |
√ |
|
Single-Operator Execution > CBLAS |
aclblasGemvEx |
√ |
aclblasCreateHandleForGemvEx |
√ |
|
aclblasHgemv |
√ |
|
aclblasCreateHandleForHgemv |
√ |
|
aclblasS8gemv |
√ |
|
aclblasCreateHandleForS8gemv |
√ |
|
aclblasGemmEx |
√ |
|
aclblasCreateHandleForGemmEx |
√ |
|
aclblasHgemm |
√ |
|
aclblasCreateHandleForHgemm |
√ |
|
aclblasS8gemm |
√ |
|
aclblasCreateHandleForS8gemm |
√ |
|
aclopCast |
√ |
|
aclopCreateHandleForCast |
√ |
|
Media Data Processing V1 > Memory Allocation and Deallocation |
acldvppMalloc |
√ |
acldvppFree |
√ |
|
Media Data Processing V1 > Channel Creation and Destruction |
acldvppCreateChannel |
√ |
acldvppDestroyChannel |
√ |
|
aclvdecCreateChannel |
√ |
|
aclvdecDestroyChannel |
√ |
|
aclvencCreateChannel |
☓ |
|
aclvencDestroyChannel |
☓ |
|
Media Data Processing V1 > VPC |
acldvppVpcResizeAsync |
√ |
acldvppVpcCropAsync |
√ |
|
acldvppVpcCropResizeAsync |
√ |
|
acldvppVpcBatchCropAsync |
√ |
|
acldvppVpcBatchCropResizeAsync |
√ |
|
acldvppVpcCropAndPasteAsync |
√ |
|
acldvppVpcCropResizePasteAsync |
√ |
|
acldvppVpcBatchCropAndPasteAsync |
√ |
|
acldvppVpcBatchCropResizePasteAsync |
√ |
|
acldvppVpcBatchCropResizeMakeBorderAsync |
√ |
|
acldvppVpcConvertColorAsync |
√ |
|
acldvppVpcPyrDownAsync |
☓ |
|
acldvppVpcEqualizeHistAsync |
√ |
|
acldvppVpcMakeBorderAsync |
√ |
|
acldvppVpcCalcHistAsync |
√ |
|
Media Data Processing V1 > JPEGD |
acldvppJpegDecodeAsync |
√ |
acldvppJpegGetImageInfo |
√ |
|
acldvppJpegGetImageInfoV2 |
√ |
|
acldvppJpegPredictDecSize |
√ |
|
Media Data Processing V1 > JPEGE |
acldvppJpegEncodeAsync |
√ |
acldvppJpegPredictEncSize |
√ |
|
Media Data Processing V1 > PNGD |
acldvppPngDecodeAsync |
√ |
acldvppPngGetImageInfo |
√ |
|
acldvppPngPredictDecSize |
√ |
|
Media Data Processing V1 > VDEC |
aclvdecSendFrame |
√ |
aclvdecSendSkippedFrame |
√ |
|
aclvdecCallback |
√ |
|
Media Data Processing V1 > VENC |
aclvencSendFrame |
☓ |
aclvencCallback |
☓ |
|
Media Data Processing V2 > Common APIs |
hi_mpi_sys_init |
√ |
hi_mpi_sys_exit |
√ |
|
hi_mpi_dvpp_malloc |
√ |
|
hi_mpi_dvpp_free |
√ |
|
hi_mpi_dvpp_get_image_info |
√ |
|
hi_mpi_dvpp_get_version |
√ |
|
hi_mpi_sys_create_epoll |
√ |
|
hi_mpi_sys_ctl_epoll |
√ |
|
hi_mpi_sys_wait_epoll |
√ |
|
hi_mpi_sys_close_epoll |
√ |
|
hi_mpi_sys_set_chn_csc_matrix |
√ |
|
hi_mpi_sys_get_chn_csc_matrix |
√ |
|
hi_mpi_sys_get_image_align_info |
√ |
|
hi_mpi_sys_bind |
☓ |
|
hi_mpi_sys_unbind |
☓ |
|
Media Data Processing V2 > AI/AO |
All APIs in this section |
☓ |
Media Data Processing V2 > AENC/ADEC |
All APIs in this section |
☓ |
Media Data Processing V2 > Volume Adjustment |
Command words in this section |
☓ |
Media Data Processing V2 > ISP System Control and 3A Algorithm Registration |
All APIs in this section |
☓ |
Media Data Processing V2 > MIPI RX ioctl Command Words |
Command words in this section |
☓ |
Media Data Processing V2 > VI |
All APIs in this section |
☓ |
Media Data Processing V2 > Region Management |
All APIs in this section |
x |
Media Data Processing V2 > VPSS |
All APIs in this section |
x |
Media Data Processing V2 > VO |
All APIs in this section |
x |
Media Data Processing V2 > TDE Graphics Drawing |
All APIs in this section |
☓ |
Media Data Processing V2 > HiFB for Managing Overlaid Graphics Layers |
All APIs in this section |
☓ |
Media Data Processing V2 > HDMI Peripherals |
All APIs in this section |
☓ |
Media Data Processing V2 > VPC |
hi_mpi_vpc_create_chn |
√ |
hi_mpi_vpc_destroy_chn |
√ |
|
hi_mpi_vpc_resize |
√ |
|
hi_mpi_vpc_crop |
√ |
|
hi_mpi_vpc_crop_resize |
√ |
|
hi_mpi_vpc_crop_resize_paste |
√ |
|
hi_mpi_vpc_convert_color |
√ |
|
hi_mpi_vpc_convert_color_to_yuv420 |
√ |
|
hi_mpi_vpc_copy_make_border |
√ |
|
hi_mpi_vpc_pyrdown |
√ |
|
hi_mpi_vpc_calc_hist |
√ |
|
hi_mpi_vpc_equalize_hist |
√ |
|
hi_mpi_vpc_crop_resize_make_border |
√ |
|
hi_mpi_vpc_batch_crop_resize_paste |
√ |
|
hi_mpi_vpc_batch_crop_resize_make_border |
√ |
|
hi_mpi_vpc_get_process_result |
√ |
|
hi_mpi_vpc_sys_create_chn |
√ |
|
hi_mpi_vpc_set_roundview_stitching_param |
☓ |
|
hi_mpi_vpc_get_roundview_stitching_param |
☓ |
|
hi_mpi_vpc_roundview_stitching |
☓ |
|
hi_vpc_crop_resize_resize_paste |
☓ |
|
hi_mpi_vpc_set_chn_workspace |
√ |
|
hi_mpi_vpc_get_lut_mem_size |
√ |
|
hi_mpi_vpc_get_affine_lut |
√ |
|
hi_mpi_vpc_get_perspective_lut |
√ |
|
hi_mpi_vpc_get_remap_lut |
√ |
|
hi_mpi_vpc_lut_remap |
√ |
|
hi_mpi_vpc_median_blur |
√ |
|
hi_mpi_vpc_erode |
√ |
|
hi_mpi_vpc_dilate |
√ |
|
hi_mpi_vpc_blur |
√ |
|
hi_mpi_vpc_gaussian_blur |
√ |
|
hi_mpi_vpc_filter2d |
√ |
|
hi_mpi_vpc_rotate |
√ |
|
hi_mpi_vpc_draw_mosaic |
√ |
|
hi_mpi_vpc_draw_cover |
√ |
|
hi_mpi_vpc_draw_line |
√ |
|
hi_mpi_vpc_draw_osd |
√ |
|
hi_mpi_vpc_get_affine_transform |
√ |
|
hi_mpi_vpc_get_rotation_matrix |
√ |
|
hi_mpi_vpc_warp_affine |
√ |
|
hi_mpi_vpc_flip |
√ |
|
Media Data Processing V2 > VDEC/JPEGD |
hi_mpi_vdec_create_chn |
√ |
hi_mpi_vdec_destroy_chn |
√ |
|
hi_mpi_vdec_get_chn_attr |
√ |
|
hi_mpi_vdec_set_chn_attr |
√ |
|
hi_mpi_vdec_start_recv_stream |
√ |
|
hi_mpi_vdec_stop_recv_stream |
√ |
|
hi_mpi_vdec_query_status |
√ |
|
hi_mpi_vdec_reset_chn |
√ |
|
hi_mpi_vdec_set_chn_param |
√ |
|
hi_mpi_vdec_get_chn_param |
√ |
|
hi_mpi_vdec_set_protocol_param |
☓ |
|
hi_mpi_vdec_get_protocol_param |
√ |
|
hi_mpi_vdec_send_stream |
√ |
|
hi_mpi_vdec_get_frame |
√ |
|
hi_mpi_vdec_release_frame |
√ |
|
hi_mpi_vdec_get_fd |
√ |
|
hi_mpi_vdec_close_fd |
☓ |
|
hi_vdec_get_pic_buf_size |
√ |
|
hi_vdec_get_tmv_buf_size |
√ |
|
hi_mpi_vdec_set_jpegd_precision_mode |
√ |
|
hi_mpi_vdec_get_jpegd_output_info |
√ |
|
hi_mpi_vdec_set_display_mode |
√ |
|
hi_mpi_vdec_get_display_mode |
√ |
|
Media Data Processing V2 > VENC/JPEGE |
hi_mpi_venc_create_chn |
√ |
hi_mpi_venc_destroy_chn |
√ |
|
hi_mpi_venc_start_chn |
√ |
|
hi_mpi_venc_stop_chn |
√ |
|
hi_mpi_venc_query_status |
√ |
|
hi_mpi_venc_get_stream |
√ |
|
hi_mpi_venc_release_stream |
√ |
|
hi_mpi_venc_send_frame |
√ |
|
hi_mpi_venc_set_mod_param |
√ |
|
hi_mpi_venc_get_mod_param |
√ |
|
hi_mpi_venc_request_idr |
√ |
|
hi_mpi_venc_get_fd |
√ |
|
hi_mpi_venc_close_fd |
☓ |
|
hi_mpi_venc_set_jpeg_param |
√ |
|
hi_mpi_venc_get_jpeg_param |
√ |
|
hi_mpi_venc_set_chn_param |
√ |
|
hi_mpi_venc_set_scene_mode |
☓ |
|
hi_mpi_venc_get_scene_mode |
√ |
|
hi_mpi_venc_set_rc_param |
√ |
|
hi_mpi_venc_get_rc_param |
√ |
|
hi_mpi_venc_set_jpeg_huffman_param |
√ |
|
hi_mpi_venc_get_jpeg_huffman_param |
√ |
|
hi_mpi_venc_compact_jpeg_tables |
√ |
|
hi_mpi_venc_send_jpege_frame |
√ |
|
hi_mpi_venc_get_jpege_predicted_size |
√ |
|
hi_mpi_venc_set_roi_attr |
☓ |
|
hi_mpi_venc_get_roi_attr |
☓ |
|
hi_mpi_venc_set_ref_param |
☓ |
|
hi_mpi_venc_get_ref_param |
☓ |
|
hi_mpi_venc_set_h264_vui |
√ |
|
hi_mpi_venc_get_h264_vui |
√ |
|
hi_mpi_venc_set_h265_vui |
√ |
|
hi_mpi_venc_get_h265_vui |
√ |
|
hi_mpi_venc_set_cu_pred |
☓ |
|
hi_mpi_venc_get_cu_pred |
☓ |
|
hi_mpi_venc_set_intra_refresh |
☓ |
|
hi_mpi_venc_get_intra_refresh |
☓ |
|
hi_mpi_venc_set_chn_attr |
☓ |
|
hi_mpi_venc_get_chn_attr |
☓ |
|
Media Data Processing V2 > PNGD |
hi_mpi_pngd_create_chn |
√ |
hi_mpi_pngd_destroy_chn |
√ |
|
hi_mpi_pngd_send_stream |
√ |
|
hi_mpi_pngd_get_image_data |
√ |
|
hi_mpi_png_get_image_info |
√ |
|
Profiling AscendCL API for Extension (Extension APIs) |
aclprofInit |
√ |
aclprofSetConfig |
√ |
|
aclprofStart |
√ |
|
aclprofStop |
√ |
|
aclprofFinalize |
√ |
|
Profiling AscendCL API for Extension (Extension APIs) |
aclprofCreateStamp |
√ |
aclprofSetStampTraceMessage |
√ |
|
aclprofMark |
√ |
|
aclprofPush |
√ |
|
aclprofPop |
√ |
|
aclprofRangeStart |
√ |
|
aclprofRangeStop |
√ |
|
aclprofDestroyStamp |
√ |
|
Profiling AscendCL APIs for Subscription (Subscribing to Operator Information) |
aclprofModelSubscribe |
√ |
aclprofModelUnSubscribe |
√ |
|
aclprofGetOpDescSize |
√ |
|
aclprofGetOpNum |
√ |
|
aclprofGetOpTypeLen |
√ |
|
aclprofGetOpType |
√ |
|
aclprofGetOpNameLen |
√ |
|
aclprofGetOpName |
√ |
|
aclprofGetOpStart |
√ |
|
aclprofGetOpEnd |
√ |
|
aclprofGetOpDuration |
√ |
|
aclprofGetModelId |
√ |
|
Profiling AscendCL API (setting iteration time in pytorch scenario) |
aclprofGetStepTimestamp |
√ |
Data Transmission > Tensor Data Transmission |
acltdtCreateChannel |
☓ |
acltdtSendTensor |
√ |
|
acltdtReceiveTensor |
√ |
|
acltdtStopChannel |
√ |
|
acltdtDestroyChannel |
√ |
|
acltdtCreateChannelWithCapacity |
√ |
|
acltdtQueryChannelSize |
√ |
|
Data Transmission > Shared Queue Management |
acltdtCreateQueue |
√ |
acltdtDestroyQueue |
√ |
|
acltdtEnqueueData |
√ |
|
acltdtDequeueData |
√ |
|
acltdtEnqueue |
☓ |
|
acltdtDequeue |
☓ |
|
acltdtBindQueueRoutes |
√ |
|
acltdtUnbindQueueRoutes |
√ |
|
acltdtQueryQueueRoutes |
√ |
|
acltdtGrantQueue |
☓ |
|
acltdtAttachQueue |
☓ |
|
Data Transmission > Shared Buffer Management |
acltdtAllocBuf |
√ |
acltdtFreeBuf |
√ |
|
acltdtGetBufData |
√ |
|
acltdtSetBufUserData |
☓ |
|
acltdtGetBufUserData |
☓ |
|
acltdtSetBufDataLen |
☓ |
|
acltdtGetBufDataLen |
☓ |
|
acltdtCopyBufRef |
☓ |
|
acltdtAppendBufChain |
☓ |
|
acltdtGetBufChainNum |
☓ |
|
acltdtGetBufFromChain |
☓ |
|
Feature Vector Search |
All APIs in this section |
☓ |