tree
接口定义
def tree(num_leaves: int, num_leaves_to_search: int, training_sample_size: int, min_partition_size: int, training_iterations: int, spherical: bool, quantize_centroids: bool, random_init: bool, soar_lambda: float, overretrieve_factor: float, distance_measure: string) -> scann.scann_ops.py.scann_builder.ScannBuilder
接口用途
添加IVF（Inverted File）倒排索引分区的相关参数（与开源算法接口保持一致）。
参数说明
参数名称 |
描述 |
数据类型 |
取值范围 |
|---|---|---|---|
num_leaves |
IVF分区总子空间个数。 |
int |
大于等于1。 |
num_leaves_to_search |
默认搜索子空间个数。 |
int |
[1, num_leaves]，其中“num_leaves”为IVF倒排索引分区总子空间个数。 |
training_sample_size |
分区训练时底库抽样个数。 |
int |
[0, 底库数量] |
min_partition_size |
最小分区包含的底库向量个数。 |
int |
[0, 底库数量] |
training_iterations |
训练循环次数。 |
int |
大于等于1。 |
spherical |
分区类型是否为spherical。 |
布尔值 |
- |
quantize_centroids |
是否量化桶中心。 |
布尔值 |
- |
random_init |
训练时是否随机开始。 |
布尔值 |
- |
soar_lambda |
控制正交性的参数，仅对IP(dot_product)数据集生效。 |
float |
大于0，当值为-1时表示不开启此参数。 |
overretrieve_factor |
指定过检索因子，与“soar_lambda”一起使用，仅对IP(dot_product)数据集生效。 |
float |
[1,2]，当值为-1时表示不开启此参数。 |
distance_measure |
向量的距离类型。 |
字符串 |
“dot_product”或“squared_l2” |
返回值
数据类型 |
说明 |
|---|---|
scann.scann_ops.py.scann_builder.ScannBuilder |
ScannBuilder类用于接收构建参数。 |