pyacl Conventions

API Naming Conventions

The APIs are named according to the following rules:

  1. acl+API class+Operation verb+Object noun.
  2. The Operation verb and Object noun fields are written with the first letter capitalized.

API Classes

API Class

Abbreviation

Description

CBLAS

blas

Basic Linear Algebra Subprograms (BLAS)

model

mdl

Model inference

OP

op

Operator execution

  • 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.