From 6e8c617c6834075506d1ea16e72c88d40d51cb60 Mon Sep 17 00:00:00 2001 From: groot Date: Tue, 10 Mar 2020 12:25:38 +0800 Subject: [PATCH] typo Signed-off-by: groot --- core/src/utils/ValidationUtil.cpp | 6 +++--- sdk/include/MilvusApi.h | 18 +++++++++--------- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/core/src/utils/ValidationUtil.cpp b/core/src/utils/ValidationUtil.cpp index 616375f08e..50a6536fd2 100644 --- a/core/src/utils/ValidationUtil.cpp +++ b/core/src/utils/ValidationUtil.cpp @@ -174,14 +174,14 @@ ValidationUtil::ValidateIndexParams(const milvus::json& index_params, const engi case (int32_t)engine::EngineType::FAISS_IVFSQ8: case (int32_t)engine::EngineType::FAISS_IVFSQ8H: case (int32_t)engine::EngineType::FAISS_BIN_IVFFLAT: { - auto status = CheckParameterRange(index_params, knowhere::IndexParams::nlist, 0, 999999, false); + auto status = CheckParameterRange(index_params, knowhere::IndexParams::nlist, 1, 999999); if (!status.ok()) { return status; } break; } case (int32_t)engine::EngineType::FAISS_PQ: { - auto status = CheckParameterRange(index_params, knowhere::IndexParams::nlist, 0, 999999, false); + auto status = CheckParameterRange(index_params, knowhere::IndexParams::nlist, 1, 999999); if (!status.ok()) { return status; } @@ -254,7 +254,7 @@ ValidationUtil::ValidateSearchParams(const milvus::json& search_params, const en break; } case (int32_t)engine::EngineType::HNSW: { - auto status = CheckParameterRange(search_params, knowhere::IndexParams::ef, topk, 1000); + auto status = CheckParameterRange(search_params, knowhere::IndexParams::ef, topk, 4096); if (!status.ok()) { return status; } diff --git a/sdk/include/MilvusApi.h b/sdk/include/MilvusApi.h index 743248744c..50f012ff62 100644 --- a/sdk/include/MilvusApi.h +++ b/sdk/include/MilvusApi.h @@ -84,19 +84,19 @@ using TopKQueryResult = std::vector; ///< Topk query result * @brief Index parameters * Note: extra_params is extra parameters list, it must be json format * For different index type, parameter list is different accordingly, for example: - * FLAT/IVFLAT/SQ8: "{nlist: '16384'}" + * FLAT/IVFLAT/SQ8: {nlist: 16384} * ///< nlist range:[1, 999999] - * IVFPQ: "{nlist: '16384', m: "12"}" + * IVFPQ: {nlist: 16384, m: 12} * ///< nlist range:[1, 999999] * ///< m is decided by dim and have a couple of results. - * NSG: "{search_length: '45', out_degree:'50', candidate_pool_size:'300', "knng":'100'}" + * NSG: {search_length: 45, out_degree:50, candidate_pool_size:300, knng:100} * ///< search_length range:[10, 300] * ///< out_degree range:[5, 300] * ///< candidate_pool_size range:[50, 1000] * ///< knng range:[5, 300] - * HNSW "{M: '16', efConstruction:'500'}" + * HNSW {M: 16, efConstruction:300} * ///< M range:[5, 48] - * ///< efConstruction range:[topk, 4096] + * ///< efConstruction range:[100, 500] */ struct IndexParam { std::string collection_name; ///< Collection name for create index @@ -386,12 +386,12 @@ class Connection { * @param extra_params, extra search parameters according to different index type, must be json format. * Note: extra_params is extra parameters list, it must be json format, for example: * For different index type, parameter list is different accordingly - * FLAT/IVFLAT/SQ8/IVFPQ: "{nprobe: '32'}" + * FLAT/IVFLAT/SQ8/IVFPQ: {nprobe: 32} * ///< nprobe range:[1,999999] - * NSG: "{search_length:'100'} + * NSG: {search_length:100} * ///< search_length range:[10, 300] - * HNSW "{ef: '64'} - * ///< ef range:[k, 4096] + * HNSW {ef: 64} + * ///< ef range:[topk, 4096] * @param topk_query_result, result array. * * @return Indicate if query is successful.