函数:create_init_para
函数:modify
| C函数原型 | aclError aclfvModify(aclfvFeatureInfo *featureInfo) |
|---|---|
| Python函数 | ret = acl.fv.modify(feature_info) |
| 函数功能 | 修改底库中某个特征,一次只能修改底库中一个特征,不允许修改底库中不存在的特征。N:M场景下不涉及这个接口。同步接口。 Atlas 200/500 A2推理产品不支持该接口。 |
| 输入说明 | feature_info:int,指针地址,指定特征描述信息。需提前调用acl.fv.create_feature_info接口创建aclfvFeatureInfo类型的数据。 |
| 返回值说明 | ret:int,错误码。 - 返回0表示成功。 - 返回其它值表示失败。 |
| 约束说明 | - 调用本接口,内部会默认创建一个Stream,用于接口内任务同步执行,在接口执行完成后,该Stream资源会被自动释放。 受硬件限制,Stream总数有限,请参见函数:create_stream处的说明。 |
父主题: 特征向量检索
函数:search
| C函数原型 | aclError **aclfvSearch(**aclfvSearchType type, aclfvSearchInput *searchInput, aclfvSearchResult *searchRst) |
|---|---|
| Python函数 | ret = acl.fv.search(type, search_input, search_result) |
| 函数功能 | 特征1:N或N:M检索。同步接口。 Atlas 200/500 A2推理产品不支持该接口。 |
| 输入说明 | - type:int,指定特征描述信息,请参见aclfvSearchType处说明。 - search_input:int,指针地址,检索输入信息。 需提前调用acl.fv.create_search_input接口创建aclfvSearchInput类型的数据。 - search_result:int,指针地址,检索输出结果。 需提前调用acl.fv.create_search_result接口创建aclfvSearchResult类型的数据,该数据中queryCnt参数应与检索输入信息searchInput中的queryCnt参数相同。 检索输出返回的结果数量通过acl.fv.create_search_input接口的topk参数设置,但与调用acl.fv.init接口进行初始化时设置的topK结果数量最大值有关,若调用acl.fv.create_search_input接口设置的topk参数值大于或等于初始化时设置的topK结果数量最大值,则在返回检索输出结果时,按初始化时设置的topK结果数量最大值返回检索结果,若调用acl.fv.create_search_input接口设置的topk参数值小于初始化时设置的topK结果数量最大值,则在返回检索输出结果时,按实际通过acl.fv.create_search_input接口设置的topk参数值返回检索结果。 |
| 返回值说明 | ret:int,错误码。 - 返回0表示成功。 - 返回其它值表示失败。 |
| 约束说明 | - 非线程安全,N:M场景不允许多线程同时添加\检索\删除。 - N:M场景或1:N场景,不添加底库,调用acl.fv.search接口检索时,返回结果数量为0。 - 调用本接口,内部会默认创建一个Stream,用于接口内任务同步执行,在接口执行完成后,该Stream资源会被自动释放。 受硬件限制,Stream总数有限,请参见函数:create_stream处的说明。 |
父主题: 特征向量检索
函数:create_init_para
| C函数原型 | aclfvInitPara *aclfvCreateInitPara(uint64_t fsNum) |
|---|---|
| Python函数 | init_para = acl.fv.create_init_para(fs_num) |
| 函数功能 | 创建aclfvInitPara类型的数据,表示创建特征向量检索的初始化参数。同步接口。 如需销毁aclfvInitPara类型的数据,请参见函数:destroy_init_para。 Atlas 200/500 A2推理产品不支持该接口。 |
| 输入说明 | fs_num:int,底库特征个数,用于系统内部给特征检索模块申请内存资源,取值范围:[1,500000000]。 |
| 返回值说明 | init_para :int。 - 返回aclfvInitPara类型,表示成功。 - 返回0,表示失败。 |
| 约束说明 | 无 |
父主题: 特征向量检索
函数:destroy_init_para
| C函数原型 | aclError aclfvDestroyInitPara(aclfvInitPara *initPara) |
|---|---|
| Python函数 | ret = acl.fv.destroy_init_para(init_para) |
| 函数功能 | 销毁通过acl.fv.create_init_para接口创建的aclfvInitPara类型的数据。同步接口。 Atlas 200/500 A2推理产品不支持该接口。 |
| 输入说明 | init_para:int,待销毁的aclfvInitPara类型。 |
| 返回值说明 | ret:int,错误码。 - 返回0表示成功。 - 返回其它值表示失败。 |
| 约束说明 | 无 |
父主题: 特征向量检索
函数:destory_init_para
| C函数原型 | aclError aclfvDestroyInitPara(aclfvInitPara *initPara) |
|---|---|
| Python函数 | ret = acl.fv.destory_init_para(init_para) |
| 函数功能 | 销毁通过acl.fv.create_init_para接口创建的aclfvInitPara类型的数据。同步接口。 Atlas 200/500 A2推理产品不支持该接口。 |
| 输入说明 | init_para:int,待销毁的aclfvInitPara类型。 |
| 返回值说明 | ret:int,错误码。 - 返回0表示成功。 - 返回其它值表示失败。 |
| 约束说明 | 无 |
父主题: 特征向量检索
函数:set_1n_top_num
| C函数原型 | aclError **aclfvSet1NTopNum(**aclfvInitPara *initPara, uint32_t maxTopNumFor1N) |
|---|---|
| Python函数 | ret = acl.fv.set_1n_top_num(init_para, max_top_num_for_1n) |
| 函数功能 | 设置1:N场景下返回的topK结果数量的最大值,如果不设置,默认topK结果数量的最大值为4800。同步接口。 Atlas 200/500 A2推理产品不支持该接口。 |
| 输入说明 | - init_para:int,指定特征向量检索的初始化参数。 需提前调用acl.fv.create_init_para接口创建aclfvInitPara类型的数据。 - max_top_num_for_1n:int,1:N场景下返回的topK结果的最大值,取值范围:[2, 4800]。 |
| 返回值说明 | ret:int,错误码。 - 返回0表示成功。 - 返回其它值表示失败。 |
| 约束说明 | 无 |
父主题: 特征向量检索
在线提单