表达约定

接口命名规则

接口命名同时满足如下规则:

  1. 规则1:acl+接口类别缩写+操作动词+对象
  2. 规则2:操作动词和对象均采用首字母大写

媒体数据处理V2版本下的接口命名规则例外,这一类接口命名以“hi_mpi”开头。

接口类别

接口类别

缩写

描述

runtime

rt

表示运行管理类的接口。

DVPP

dvpp或vdec或venc

表示媒体数据处理类的接口

AIPP

aipp

表示aipp(AI Preprocessing)类的接口

CBLAS

blas

表示blas类接口

model

mdl

表示模型推理类的接口

graph

grph

表示graph类的接口

driver

drv

表示驱动类的接口

OP

op

表示算子执行类的接口

注:

1. 缩写原则上不超过4个字母。

2. 在接口命名中,如果类别与操作对象重叠时,操作动词后的对象将省略。

如:aclmdlLoadFromFileWithMem,表示model类接口,这个接口表示含义是load model from file,因此在接口命名中Load后面 mdl将被省略。

变量命名

本文代码示例中涉及的变量,其中,命名带下划线的变量(例如:deviceId_)表示类的私有变量。