aclfvInit

Product	Supported
Atlas 350 Accelerator Card	☓
Atlas A3 training product/Atlas A3 inference product	☓
Atlas A2 training product/Atlas A2 inference product	☓
Atlas 200I/500 A2 inference product	☓
Atlas inference product	√
Atlas training product	☓

Initializes the feature search module. aclfvInit can be called only once in a process and must be used together with aclfvRelease.

Atlas inference accelerator module does not support this API.

aclError aclfvInit(aclfvInitPara *initPara)

Parameter	Input/Output	Description
initPara	Input	Pointer to the initialization parameter for feature vector search. For details about the type definition, see aclfvInitPara. Call the aclfvCreateInitPara API to create data of the aclfvInitPara type. In the 1:N scenario, invoke the aclfvSet1NTopNum interface to set the maximum number of returned topK results. If this parameter is not set, the maximum number of returned topK results is 4800 by default. In the N:M scenario, invoke the aclfvSetNMTopNum interface to set the maximum number of returned topK results. If the aclfvSetNMTopNum interface is not set, the maximum number of returned topK results is 500 by default.

Parameter

Input/Output

Description

initPara

Input

Pointer to the initialization parameter for feature vector search. For details about the type definition, see aclfvInitPara.

Call the aclfvCreateInitPara API to create data of the aclfvInitPara type.
In the 1:N scenario, invoke the aclfvSet1NTopNum interface to set the maximum number of returned topK results. If this parameter is not set, the maximum number of returned topK results is 4800 by default.
In the N:M scenario, invoke the aclfvSetNMTopNum interface to set the maximum number of returned topK results. If the aclfvSetNMTopNum interface is not set, the maximum number of returned topK results is 500 by default.

0 on success; otherwise, failure. For details, see aclError.

Parent topic: API for feature vector search (C)