V1.1.0 or Later

The following table lists the AscendCL APIs supported by different versions.

√: supported

x: not supported
Deprecated: The API will be deprecated in later versions. For details, see Deprecated APIs and Return Codes.

Directory	API	Atlas 200/300/500 Inference Product	Atlas Training Series Product
System configuration	aclInit	√	√
	aclFinalize	√	√
	aclrtGetVersion	√	√
	aclSetCompileopt	√	√
	aclGetRecentErrMsg	√	√
	aclAppLog	√	√
	aclDataTypeSize	√	√
	aclFloat16ToFloat	√	√
	aclFloatToFloat16	√	√
	aclGenGraphAndDumpForOp	√	√
Runtime Management > Device Management	aclrtSetDevice	√	√
	aclrtResetDevice	√	√
	aclrtGetDevice	√	√
	aclrtGetRunMode	√	√
	aclrtSetTsDevice	√	√
	aclrtGetDeviceCount	√	√
	aclrtSynchronizeDevice	√	√
	aclrtGetSocName	√	√
Runtime Management > Context Management	aclrtCreateContext	√	√
	aclrtDestroyContext	√	√
	aclrtSetCurrentContext	√	√
	aclrtGetCurrentContext	√	√
Runtime Management > Stream Management	aclrtCreateStream	√	√
	aclrtDestroyStream	√	√
	aclrtSynchronizeStream	√	√
Runtime Management > Event Management	aclrtCreateEvent	√	√
	aclrtCreateEventWithFlag	√	√
	aclrtDestroyEvent	√	√
	aclrtRecordEvent	√	√
	aclrtResetEvent	√	√
	aclrtQueryEvent	Deprecated	Deprecated
	aclrtQueryEventStatus	√	√
	aclrtQueryEventWaitStatus	√	√
	aclrtSynchronizeEvent	√	√
	aclrtEventElapsedTime	√	√
	aclrtStreamWaitEvent	√	√
	aclrtSetOpWaitTimeout	√	√
Runtime Management > Memory Management	aclrtMalloc	√	√
	aclrtMallocCached	√	√
	aclrtMemFlush	√	√
	aclrtMemInvalidate	√	√
	aclrtFree	√	√
	aclrtMallocHost	√	√
	aclrtFreeHost	√	√
	aclrtMemset	√	√
	aclrtMemsetAsync	√	√
	aclrtMemcpy	√	√
	aclrtMemcpyAsync	√	√
	aclrtGetMemInfo	√	√
	aclrtDeviceCanAccessPeer	x	√
	aclrtDeviceEnablePeerAccess	x	√
	aclrtDeviceDisablePeerAccess	x	√
	aclrtMemcpy2d	√	√
	aclrtMemcpy2dAsync	√	√
Runtime Management > Execution Control	aclrtSubscribeReport	√	√
	aclrtLaunchCallback	√	√
	aclrtProcessReport	√	√
	aclrtUnSubscribeReport	√	√
Runtime Management > Exception Handling	aclrtSetExceptionInfoCallback	√	√
	aclrtGetTaskIdFromExceptionInfo	√	√
	aclrtGetStreamIdFromExceptionInfo	√	√
	aclrtGetThreadIdFromExceptionInfo	√	√
	aclrtGetDeviceIdFromExceptionInfo	√	√
Runtime Management > Group Management	aclrtSetGroup	x	x
	aclrtGetGroupCount	x	x
	aclrtCreateGroupInfo	x	x
	aclrtDestroyGroupInfo	x	x
	aclrtGetAllGroupInfo	x	x
	aclrtGetGroupInfoDetail	x	x
Model Inference > Model Loading	aclmdlLoadFromFile	√	√
	aclmdlLoadFromMem	√	√
	aclmdlLoadFromFileWithMem	√	√
	aclmdlLoadFromMemWithMem	√	√
	aclmdlLoadFromFileWithQ	x	x
	aclmdlLoadFromMemWithQ	x	x
	aclmdlSetConfigOpt	√	√
	aclmdlLoadWithConfig	√	√
Model Inference > Model Execution	aclmdlExecute	√	√
	aclmdlExecuteAsync	√	√
	aclmdlUnload	√	√
	aclmdlQuerySize	√	√
	aclmdlQuerySizeFromMem	√	√
	aclmdlSetDynamicBatchSize	√	√
	aclmdlSetDynamicHWSize	√	√
	aclmdlSetInputAIPP	√	x
	aclmdlGetFirstAippInfo	√	x
	aclmdlGetAippType	√	x
	aclmdlSetAIPPByInputIndex	√	x
	aclmdlSetInputDynamicDims	√	√
	aclmdlCreateAndGetOpDesc	√	√
	aclmdlInitDump	√	√
	aclmdlSetDump	√	√
	aclmdlFinalizeDump	√	√
Single-Operator Execution > Single-Operator Model Execution	aclopSetModelDir	√	√
	aclopLoad	√	√
	aclopSetCompileFlag	x	√
	aclopCompile	x	√
	aclopExecute	Deprecated	Deprecated
	aclopExecuteV2	√	√
	aclopCompileAndExecute	√	√
	aclopExecWithHandle	√	√
	aclopInferShape	√	√
	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	x	x
	acldvppVpcConvertColorAsync	x	x
	acldvppVpcPyrDownAsync	x	x
	acldvppVpcEqualizeHistAsync	x	x
	acldvppVpcMakeBorderAsync	x	x
	acldvppVpcCalcHistAsync	x	x
Media Data Processing V1 > JPEGD	acldvppJpegDecodeAsync	√	√
	acldvppJpegGetImageInfo	√	√
	acldvppJpegGetImageInfoV2	√	√
	acldvppJpegPredictDecSize	√	√
Media Data Processing V1 > JPEGE	acldvppJpegEncodeAsync	√	√
Media Data Processing V1 > JPEGE	acldvppJpegPredictEncSize	√	√
Media Data Processing V1 > PNGD	acldvppPngDecodeAsync	√	√
	acldvppPngGetImageInfo	√	√
	acldvppPngPredictDecSize	√	√
Media Data Processing V1 > VDEC	aclvdecSendFrame	√	√
	aclvdecSendSkippedFrame	√	√
	aclvdecCallback	√	√
Media Data Processing V1 > VENC	aclvencSendFrame	√	x
Media Data Processing V1 > VENC	aclvencCallback	√	x
Media Data Processing V2 > Common APIs	hi_mpi_sys_init	x	x
	hi_mpi_sys_exit	x	x
	hi_mpi_dvpp_malloc	x	x
	hi_mpi_dvpp_free	x	x
	hi_mpi_dvpp_get_image_info	x	x
	hi_mpi_dvpp_get_version	x	x
	hi_mpi_sys_create_epoll	x	x
	hi_mpi_sys_ctl_epoll	x	x
	hi_mpi_sys_wait_epoll	x	x
	hi_mpi_sys_close_epoll	x	x
	hi_mpi_sys_set_chn_csc_matrix	x	x
	hi_mpi_sys_get_chn_csc_matrix	x	x
Media Data Processing V2 > VPC	hi_mpi_vpc_create_chn	x	x
	hi_mpi_vpc_destroy_chn	x	x
	hi_mpi_vpc_resize	x	x
	hi_mpi_vpc_crop	x	x
	hi_mpi_vpc_crop_resize	x	x
	hi_mpi_vpc_crop_resize_paste	x	x
	hi_mpi_vpc_convert_color	x	x
	hi_mpi_vpc_convert_color_to_yuv420	x	x
	hi_mpi_vpc_copy_make_border	x	x
	hi_mpi_vpc_pyrdown	x	x
	hi_mpi_vpc_calc_hist	x	x
	hi_mpi_vpc_equalize_hist	x	x
	hi_mpi_vpc_crop_resize_make_border	x	x
	hi_mpi_vpc_batch_crop_resize_paste	x	x
	hi_mpi_vpc_batch_crop_resize_make_border	x	x
	hi_mpi_vpc_get_process_result	x	x
	hi_mpi_vpc_sys_create_chn	x	x
Media Data Processing V2 > VDEC/JPEGD	hi_mpi_vdec_create_chn	x	x
	hi_mpi_vdec_destroy_chn	x	x
	hi_mpi_vdec_get_chn_attr	x	x
	hi_mpi_vdec_set_chn_attr	x	x
	hi_mpi_vdec_start_recv_stream	x	x
	hi_mpi_vdec_stop_recv_stream	x	x
	hi_mpi_vdec_query_status	x	x
	hi_mpi_vdec_reset_chn	x	x
	hi_mpi_vdec_set_chn_param	x	x
	hi_mpi_vdec_get_chn_param	x	x
	hi_mpi_vdec_set_protocol_param	x	x
	hi_mpi_vdec_get_protocol_param	x	x
	hi_mpi_vdec_send_stream	x	x
	hi_mpi_vdec_get_frame	x	x
	hi_mpi_vdec_release_frame	x	x
	hi_mpi_vdec_get_fd	x	x
	hi_mpi_vdec_close_fd	x	x
	hi_vdec_get_pic_buf_size	x	x
	hi_vdec_get_tmv_buf_size	x	x
Media Data Processing V2 > VENC/JPEGE	hi_mpi_venc_create_chn	x	x
	hi_mpi_venc_destroy_chn	x	x
	hi_mpi_venc_start_chn	x	x
	hi_mpi_venc_stop_chn	x	x
	hi_mpi_venc_query_status	x	x
	hi_mpi_venc_get_stream	x	x
	hi_mpi_venc_release_stream	x	x
	hi_mpi_venc_send_frame	x	x
	hi_mpi_venc_set_mod_param	x	x
	hi_mpi_venc_get_mod_param	x	x
	hi_mpi_venc_request_idr	x	x
	hi_mpi_venc_get_fd	x	x
	hi_mpi_venc_close_fd	x	x
	hi_mpi_venc_set_jpeg_param	x	x
	hi_mpi_venc_get_jpeg_param	x	x
	hi_mpi_venc_set_chn_param	x	x
	hi_mpi_venc_set_scene_mode	x	x
	hi_mpi_venc_set_rc_param	x	x
	hi_mpi_venc_get_rc_param	x	x
	hi_mpi_venc_set_jpeg_huffman_param	x	x
	hi_mpi_venc_get_jpeg_huffman_param	x	x
	hi_mpi_venc_compact_jpeg_tables	x	x
Media Data Processing V2 > PNGD	hi_mpi_pngd_create_chn	x	x
	hi_mpi_pngd_destroy_chn	x	x
	hi_mpi_pngd_send_stream	x	x
	hi_mpi_pngd_get_image_data	x	x
	hi_mpi_png_get_image_info	x	x
Profile Data Collection > Profiling AscendCL APIs (Collecting and Flushing Profile Data)	aclprofInit	√	√
	aclprofStart	√	√
	aclprofStop	√	√
	aclprofFinalize	√	√
Profiling AscendCL API for extension (extension APIs)	aclprofCreateStamp	√	√
	aclprofSetStampTraceMessage	√	√
	aclprofMark	√	√
	aclprofPush	√	√
	aclprofPop	√	√
	aclprofRangeStart	√	√
	aclprofRangeStop	√	√
	aclprofDestroyStamp	√	√
Profiling AscendCL APIs for subscription (subscription 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	x	√
	acltdtSendTensor	x	√
	acltdtReceiveTensor	x	√
	acltdtStopChannel	x	√
	acltdtDestroyChannel	x	√
	acltdtCreateChannelWithCapacity	x	√
	acltdtQueryChannelSize	x	√
Data Transmission > Shared Queue Management	acltdtCreateQueue	√	√
	acltdtDestroyQueue	√	√
	acltdtEnqueueData	√	√
	acltdtDequeueData	√	√
	acltdtEnqueue	x	x
	acltdtDequeue	x	x
	acltdtBindQueueRoutes	√	√
	acltdtUnbindQueueRoutes	√	√
	acltdtQueryQueueRoutes	√	√
	acltdtGrantQueue	x	x
	acltdtAttachQueue	x	x
Data Transmission > Shared Buffer Management	acltdtAllocBuf	√	√
	acltdtFreeBuf	√	√
	acltdtGetBufData	√	√
Feature vector search	aclfvInit	x	x
	aclfvRelease	x	x
	aclfvRepoAdd	x	x
	aclfvRepoDel	x	x
	aclfvDel	x	x
	aclfvModify	x	x
	aclfvSearch	x	x

Parent topic: API List