pyacl Conventions
API Naming Conventions
The APIs are named according to the following rules:
- acl+API class+Operation verb+Object noun.
- The Operation verb and Object noun fields are written with the first letter capitalized.
API Classes
API Classes |
Abbreviation |
Description |
|---|---|---|
runtime |
rt |
Runtime |
Profiling |
prof |
Profiling configurations |
- The abbreviation of each class name contains a maximum of four letters.
- 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 after Load is omitted 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.
Parent topic: Runtime API(Python)