AscendIndexIVFSQFuzzy

API Definition

AscendIndexIVFSQFuzzy(int dims, int nlist, faiss::ScalarQuantizer::QuantizerType qtype = ScalarQuantizer::QuantizerType::QT_8bit, faiss::MetricType metric = MetricType::METRIC_INNER_PRODUCT, AscendIndexIVFSQFuzzyConfig config = AscendIndexIVFSQFuzzyConfig())

Function

Constructor of AscendIndexIVFSQFuzzy, which is used to generate AscendIndexIVFSQFuzzy. The NPU resources are set based on the value configured in config.

Input

int dims: dimensions of a group of feature vectors managed by AscendIndexIVFSQFuzzy.

int nlist: number of cluster centroids, which corresponds to coarse_centroid_num in the operator generation script.

faiss::ScalarQuantizer::QuantizerType qtype: quantizer type of AscendIndexIVFSQFuzzy.

faiss::MetricType metric: distance measurement type used by AscendIndexIVFSQFuzzy when it retrieves feature vector similarity.

AscendIndexIVFSQFuzzyConfig config: resource configuration on the NPU.

Output

N/A

Return Value

N/A

Restrictions

  • dim ∈ {64, 128, 256, 384, 512, 1024, 2048}
  • nlist ∈ {1024, 2048, 4096, 8192, 16384, 32768}
  • qtype = ScalarQuantizer::QuantizerType::QT_8bit (Currently, only ScalarQuantizer::QuantizerType::QT_8bit is supported.)
  • metric = faiss::MetricType::METRIC_INNER_PRODUCT (Currently, only faiss::MetricType::METRIC_INNER_PRODUCT is supported.)