Conventions
API Naming Conventions
The ACL APIs are named according to the following rules:
- 1: acl+ classname + OperationVerb + ObjectNoun
- 2: The OperationVerb and ObjectNoun fields are written in mixed case with the first letter of each internal word capitalized.
API Class
API Class |
Abbreviation |
Definition |
---|---|---|
runtime |
rt |
Runtime |
DVPP |
media |
Data preprocessing using Digital Vision Pre-Processing (DVPP) |
AIPP |
aipp |
Data preprocessing using AI Pre-Processing (AIPP) |
CBLAS |
blas |
Basic Linear Algebra Subprograms (BLAS) |
model |
mdl |
Model inference |
graph |
grph |
Graph |
driver |
drv |
Driver |
OP |
op |
Operator execution |
fv |
fv |
Feature vector retrieval |
Notes:
1. The abbreviation of each class name contains a maximum of four letters.
2. If the class name coincides with the operation object name, the object name is omitted.
For example, acl.mdl.load_from_file_with_mem is a model API for loading model from file and mdl is omitted after Load in the API name.
Variable Naming Conventions
In the code examples provided in this guide, a variable with an underscore (_) suffix (for example, _deviceId_) is private to the corresponding class.