train

API definition

void train(idx_t n, const float *x) override;

Function

Trains AscendIndexIVFSQ. It inherits related APIs in AscendIndex and provides specific implementation.

Input

idx_t n: number of feature vectors in the training dataset.

const float *x: feature vector data.

Output

N/A

Return value

N/A

Restrictions

  • K-means clustering is used for training. If the training dataset is small, the query precision may be affected.
  • Range of n: 0 < n < 1e9.
  • x must be a non-null pointer with a length of dims × n. Otherwise, an out-of-bounds read/write error may occur, causing program breakdown.