AscendIndexIVFSQ接口

AscendIndexIVFSQ(const faiss::IndexIVFScalarQuantizer *index, AscendIndexIVFSQConfig config = AscendIndexIVFSQConfig());

AscendIndexIVFSQ的构造函数，基于一个已有的index创建Ascend上的检索Index。

const faiss::IndexIVFScalarQuantizer *index：CPU侧资源配置。

AscendIndexIVFSQConfig config：Device侧资源配置。

无

无

“index”需要为合法有效的CPU index指针。

AscendIndexIVFSQ(int dims, int nlist, faiss::ScalarQuantizer::QuantizerType qtype = ScalarQuantizer::QuantizerType::QT_8bit, faiss::MetricType metric = MetricType::METRIC_L2, bool encodeResidual = true, AscendIndexIVFSQConfig config = AscendIndexIVFSQConfig());

AscendIndexIVFSQ的构造函数，生成AscendIndexIVFSQ，此时根据“config”中配置的值设置Device侧资源。

int dims：AscendIndexIVFSQ管理的一组特征向量的维度。

int nlist：聚类中心的个数，与算子生成脚本中的“coarse_centroid_num”参数对应。

faiss::ScalarQuantizer::QuantizerType qtype：AscendIndexIVFSQ的量化器类型。

faiss::MetricType metric：AscendIndex在执行特征向量相似度检索的时候使用的距离度量类型。

bool encodeResidual：表示是否对残差编码。

AscendIndexIVFSQConfig config：Device侧资源配置。

无

无

• dims ∈ {64, 128, 256, 384, 512}
• nlist ∈ {1024, 2048, 4096, 8192, 16384, 32768}
• qtype = ScalarQuantizer::QuantizerType::QT_8bit，当前仅支持“ScalarQuantizer::QuantizerType::QT_8bit”。
• metric ∈ {faiss::MetricType::METRIC_L2, faiss::MetricType::METRIC_INNER_PRODUCT}
  说明：

  当前“encodeResidual”在“metric=faiss::MetricType::METRIC_INNER_PRODUCT”下，仅支持“false”取值，即当前并不支持对残差编码的IVFSQ方法，当取值为“true”时能够运行成功但存在精度问题。

AscendIndexIVFSQ(int dims, int nlist, faiss::MetricType metric, AscendIndexIVFSQConfig config);

AscendIndexIVFSQ的构造函数，生成AscendIndexIVFSQ，此时根据“config”中配置的值设置Device侧资源。此接口不执行初始化，由子类执行初始化相关功能，后续会废弃此接口，请勿使用。

int dims：AscendIndexIVFSQ管理的一组特征向量的维度。

int nlist：聚类中心的个数，与算子生成脚本中的“coarse_centroid_num”参数对应。

faiss::MetricType metric：AscendIndex在执行特征向量相似度检索的时候使用的距离度量类型。

AscendIndexIVFSQConfig config：Device侧资源配置。

无

无

• dims ∈ {64, 128, 256, 384, 512}
• nlist ∈ {1024, 2048, 4096, 8192, 16384, 32768}
• metric ∈ {faiss::MetricType::METRIC_L2, faiss::MetricType::METRIC_INNER_PRODUCT}

AscendIndexIVFSQ(const AscendIndexIVFSQ&) = delete;

声明此index拷贝构造函数为空，即不可拷贝类型。

const AscendIndexIVFSQ&：常量AscendIndexIVFSQ。

无

无

无