search_additional_params
接口定义
def search_additional_params (adp_threshold: float, adp_refined: int, leaves_to_search: int) -> bool
接口用途
相比开源算法新增的接口,用于拓展ScaNN检索功能,提供额外的检索参数配置接口。应在索引构建后,检索前调用设置,接口参数具备缓存能力,一次设置,后续检索均生效。
参数说明
参数名称 |
描述 |
数据类型 |
取值范围 |
---|---|---|---|
adp_threshold |
决策阈值,典型值0.3。 |
float |
[0, 0.8] |
adp_refined |
简单query所采用的子空间个数,典型值0,为训练自适应值(75分位点)。 |
int |
[1, leaves_to_search],其中“leaves_to_search”表示复杂query所采用的子空间个数。 |
leaves_to_search |
复杂query所采用的子空间个数,应与实际检索(search*)接口参数一致。 |
int |
[1, num_leaves],其中“num_leaves”表示IVF(Inverted File)倒排索引分区总子空间个数。 |
返回值
数据类型 |
说明 |
---|---|
bool |
算法库加载成功,按设置功能激活时返回True;否则返回False。 |
父主题: KScaNN接口说明