头文件列表说明
头文件名称 |
所在目录 |
用途 |
|---|---|---|
AscendCloner.h |
/mxIndex/include/faiss/ascend/ |
该头文件提供了将NPU上的检索Index资源拷贝到CPU侧Faiss的操作，拷贝过程发生在内存中，原始NPU的Index上加载的数据会被拷贝到CPU侧的内存中，方便用户在CPU上使用相同的底库执行检索。 |
AscendClonerOptions.h |
/mxIndex/include/faiss/ascend/ |
AscendClonerOptions提供。 |
AscendIndex.h |
/mxIndex/include/faiss/ascend/ |
AscendIndex作为特征检索组件中的大部分检索的Index的基类，向上承接Faiss，向下为特征检索中的其他Index定义接口。 |
AscendIndexBinaryFlat.h |
/mxIndex/include/faiss/ascend/ |
AscendIndexBinaryFlat.h是汉明距离的接口类，定义汉明距离对外接口。 |
AscendIndexCluster.h |
/mxIndex/include/faiss/ascend/ |
AscendIndexCluster对外接口。 |
AscendIndexFlat.h |
/mxIndex/include/faiss/ascend/ |
该类主要提供Flat-FP16的对外接口。 |
AscendIndexIVF.h |
/mxIndex/include/faiss/ascend/ |
AscendIndevIVF是近似检索的基类，不能直接使用。 |
AscendIndexIVFSP.h |
/mxIndex/include/faiss/ascend/ |
该类提供IVFSP对外的对外接口，核心接口包括add，add_with_ids，search和search_with_filter构造函数。 |
AscendIndexIVFSQ.h |
/mxIndex/include/faiss/ascend/ |
IVFSQ对外接口，包括train，copyto，copyfrom，构造函数。 |
AscendIndexInt8.h |
/mxIndex/include/faiss/ascend/ |
AscendIndex作为特征检索组件中的int8类型的Index的基类，向上承接Faiss，向下为特征检索中的IndexInt8Flat定义接口。 |
AscendIndexInt8Flat.h |
/mxIndex/include/faiss/ascend/ |
该类主要提供Flat-Int8的对外接口。 |
AscendIndexSQ.h |
/mxIndex/include/faiss/ascend/ |
SQ检索的对外接口定义。 |
AscendIndexTS.h |
/mxIndex/include/faiss/ascend/ |
时空库对外接口，包括了汉明、int8Flat、Fp16Flat三种算法。 |
AscendMultiIndexSearch.h |
/mxIndex/include/faiss/ascend/ |
提供多index检索的对外接口。 |
AscendNNInference.h |
/mxIndex/include/faiss/ascend/ |
神经网络降维对外接口。 |
AscendIndexIVFSQT.h |
/mxIndex/include/faiss/ascend/custom |
包含降维算法带有模糊聚类功能的三级检索IVFSQ算法，将每个聚类簇再进行聚类，先根据一级聚类结果选出nprobe个簇，再在这些簇的所有二级聚类簇中选出l2nprobe个簇，再进行精搜。 |
IReduction.h |
/mxIndex/include/faiss/ascend/custom |
IReduction是特征检索组件中降维方法的统一接口，目前支持PCAR和NN两种降维算法。 |
Version.h |
/mxIndex/include/faiss/ascend/utils |
获取版本信息接口。 |
ErrorCode.h |
/mxIndex/device/include |
包含Index SDK错误码信息。 |
IndexILFlat.h |
/mxIndex/device/include |
IndexILFlat对外接口定义。 |
IndexIL.h |
/mxIndex/device/include |
IndexILFlat的基类，不能直接使用。 |
AscendIndexGreat.h |
/mxIndex/include/faiss/ascend/ |
Great检索的对外接口定义。 |
AscendIndexVStar.h |
/mxIndex/include/faiss/ascend/ |
VStar检索的对外接口定义。 |
AscendIndexMixSearchParams.h |
/mxIndex/include/faiss/ascend/ |
Vstar和Great检索所需的参数结构体对外头文件。 |