aclfvInit

Applicability

Product

Supported

Atlas A3 training products / Atlas A3 inference products

Atlas A2 training products / Atlas A2 inference products

Atlas 200I/500 A2 inference products

Atlas inference products

Atlas training products

Description

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

Atlas inference accelerator modules : This API is not supported.

Prototype

aclError aclfvInit(aclfvInitPara *initPara)

Parameters

Parameter

Input/Output

Description

initPara

Input

Pointer to the initialization parameters for feature vector search.

  • Call aclfvCreateInitPara to create data of the aclfvInitPara type in advance.
  • In 1:N mode, call aclfvSet1NTopNum to set the maximum number of results (topK) to return. If it is not set, top 4800 results are returned by default.
  • In N:M mode, call aclfvSetNMTopNum to set the maximum number of results (topK) to return. If it is not set, top 500 results are returned by default.

Returns

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

See Also

For details about the API call sequence and sample code, see Feature Vector Search.