[fix][index] Refactor ivf_flat and ivf_pq default param check.

yuhaijun999 · Dec 6, 2023 · b286a63 · b286a63
1 parent 4279d5e
commit b286a63
Showing 1 changed file with 23 additions and 17 deletions.
diff --git a/src/vector/vector_index_utils.cc b/src/vector/vector_index_utils.cc
@@ -798,10 +798,11 @@ butil::Status VectorIndexUtils::ValidateVectorIndexParameter(
     // check ivf_flat_parameter.ncentroids
     // The number of centroids (clusters) used in the product quantization. This parameter affects the memory usage
     // of the index and the accuracy of the search. This parameter must be greater than 0.
-    if (ivf_flat_parameter.ncentroids() < 0) {
-      DINGO_LOG(ERROR) << "ivf_flat_parameter.ncentroids is illegal " << ivf_flat_parameter.ncentroids();
-      return butil::Status(pb::error::Errno::EILLEGAL_PARAMTETERS, "ivf_flat_parameter.ncentroids is illegal " +
-                                                                       std::to_string(ivf_flat_parameter.ncentroids()));
+    if (ivf_flat_parameter.ncentroids() <= 0) {
+      std::string s = fmt::format("ivf_flat_parameter.ncentroids is illegal : {}  default : {}",
+                                  ivf_flat_parameter.ncentroids(), Constant::kCreateIvfFlatParamNcentroids);
+      DINGO_LOG(ERROR) << s;
+      return butil::Status(pb::error::Errno::EILLEGAL_PARAMTETERS, s);
     }
   }
 
@@ -835,19 +836,21 @@ butil::Status VectorIndexUtils::ValidateVectorIndexParameter(
     // check ivf_pq_parameter.nlist
     // The number of inverted lists (buckets) used in the index. This parameter affects the memory usage of the
     // index and the accuracy of the search. This parameter must be greater than 0.
-    if (ivf_pq_parameter.ncentroids() < 0) {
-      DINGO_LOG(ERROR) << "ivf_pq_parameter.ncentroids is illegal " << ivf_pq_parameter.ncentroids();
-      return butil::Status(pb::error::Errno::EILLEGAL_PARAMTETERS,
-                           "ivf_pq_parameter.ncentroids is illegal " + std::to_string(ivf_pq_parameter.ncentroids()));
+    if (ivf_pq_parameter.ncentroids() <= 0) {
+      std::string s = fmt::format("ivf_pq_parameter.ncentroids is illegal : {} default : {}",
+                                  ivf_pq_parameter.ncentroids(), Constant::kCreateIvfPqParamNcentroids);
+      DINGO_LOG(ERROR) << s;
+      return butil::Status(pb::error::Errno::EILLEGAL_PARAMTETERS, s);
     }
 
     // check ivf_pq_parameter.nsubvector
     // The number of subvectors used in the product quantization. This parameter affects the memory usage of the
     // index and the accuracy of the search. This parameter must be greater than 0.
-    if (ivf_pq_parameter.nsubvector() < 0) {
-      DINGO_LOG(ERROR) << "ivf_pq_parameter.nsubvector is illegal " << ivf_pq_parameter.nsubvector();
-      return butil::Status(pb::error::Errno::EILLEGAL_PARAMTETERS,
-                           "ivf_pq_parameter.nsubvector is illegal " + std::to_string(ivf_pq_parameter.nsubvector()));
+    if (ivf_pq_parameter.nsubvector() <= 0) {
+      std::string s = fmt::format("ivf_pq_parameter.nsubvector is illegal : {} default : {}",
+                                  ivf_pq_parameter.nsubvector(), Constant::kCreateIvfPqParamNsubvector);
+      DINGO_LOG(ERROR) << s;
+      return butil::Status(pb::error::Errno::EILLEGAL_PARAMTETERS, s);
     }
 
     // check ivf_pq_parameter.bucket_init_size
@@ -871,11 +874,6 @@ butil::Status VectorIndexUtils::ValidateVectorIndexParameter(
     }
 
     int32_t nsubvector = ivf_pq_parameter.nsubvector();
-    if (0 == nsubvector) {
-      nsubvector = Constant::kCreateIvfPqParamNsubvector;
-      DINGO_LOG(INFO) << "ivf_pq_parameter vector_index_parameter nsubvector = 0, use default "
-                      << Constant::kCreateIvfPqParamNsubvector;
-    }
 
     uint32_t dimension = ivf_pq_parameter.dimension();
     if (0 != (dimension % nsubvector)) {
@@ -886,6 +884,14 @@ butil::Status VectorIndexUtils::ValidateVectorIndexParameter(
       return butil::Status(pb::error::Errno::EILLEGAL_PARAMTETERS, s);
     }
 
+    int32_t nbits_per_idx = ivf_pq_parameter.nbits_per_idx();
+    if (nbits_per_idx <= 0 || nbits_per_idx > 8) {
+      std::string s = fmt::format("ivf_pq_parameter.nbits_per_idx is illegal : {} nbits_per_idx valid : (0, 8]",
+                                  ivf_pq_parameter.nbits_per_idx());
+      DINGO_LOG(ERROR) << s;
+      return butil::Status(pb::error::Errno::EILLEGAL_PARAMTETERS, s);
+    }
+
     // If all checks pass, return a butil::Status object with no error.
     return butil::Status::OK();
   }