// Copyright (C) 2019-2020 Zilliz. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software distributed under the License // is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express // or implied. See the License for the specific language governing permissions and limitations under the License #include #include #include #include #include #include "knowhere/comp/index_param.h" #include "query/SearchBruteForce.h" #include "segcore/Reduce.h" #include "index/IndexFactory.h" #include "common/QueryResult.h" #include "segcore/Types.h" #include "test_utils/indexbuilder_test_utils.h" #include "test_utils/DataGen.h" #include "test_utils/Timer.h" #include "storage/Util.h" using namespace boost::filesystem; using namespace milvus; using namespace milvus::segcore; namespace { template auto generate_data(int N) { std::vector raw_data; std::vector timestamps; std::vector uids; std::default_random_engine er(42); std::uniform_real_distribution<> distribution(0.0, 1.0); std::default_random_engine ei(42); for (int i = 0; i < N; ++i) { uids.push_back(10 * N + i); timestamps.push_back(0); // append vec std::vector vec(DIM); for (auto& x : vec) { x = distribution(er); } raw_data.insert(raw_data.end(), std::begin(vec), std::end(vec)); } return std::make_tuple(raw_data, timestamps, uids); } } // namespace Status merge_into(int64_t queries, int64_t topk, float* distances, int64_t* uids, const float* new_distances, const int64_t* new_uids) { for (int64_t qn = 0; qn < queries; ++qn) { auto base = qn * topk; auto src2_dis = distances + base; auto src2_uids = uids + base; auto src1_dis = new_distances + base; auto src1_uids = new_uids + base; std::vector buf_dis(topk); std::vector buf_uids(topk); auto it1 = 0; auto it2 = 0; for (auto buf = 0; buf < topk; ++buf) { if (src1_dis[it1] <= src2_dis[it2]) { buf_dis[buf] = src1_dis[it1]; buf_uids[buf] = src1_uids[it1]; ++it1; } else { buf_dis[buf] = src2_dis[it2]; buf_uids[buf] = src2_uids[it2]; ++it2; } } std::copy_n(buf_dis.data(), topk, src2_dis); std::copy_n(buf_uids.data(), topk, src2_uids); } return Status::OK(); } /* TEST(Indexing, SmartBruteForce) { int64_t N = 1000; auto [raw_data, timestamps, uids] = generate_data(N); constexpr int64_t queries = 3; auto total_count = queries * K; auto raw = (const float*)raw_data.data(); EXPECT_NE(raw, nullptr); auto query_data = raw; std::vector final_uids(total_count, -1); std::vector final_dis(total_count, std::numeric_limits::max()); for (int beg = 0; beg < N; beg += TestChunkSize) { std::vector buf_uids(total_count, -1); std::vector buf_dis(total_count, std::numeric_limits::max()); faiss::float_maxheap_array_t buf = {queries, K, buf_uids.data(), buf_dis.data()}; auto end = beg + TestChunkSize; if (end > N) { end = N; } auto nsize = end - beg; auto src_data = raw + beg * DIM; faiss::knn_L2sqr(query_data, src_data, DIM, queries, nsize, &buf, nullptr); for (auto& x : buf_uids) { x = uids[x + beg]; } merge_into(queries, K, final_dis.data(), final_uids.data(), buf_dis.data(), buf_uids.data()); } for (int qn = 0; qn < queries; ++qn) { for (int kn = 0; kn < K; ++kn) { auto index = qn * K + kn; std::cout << final_uids[index] << "->" << final_dis[index] << std::endl; } std::cout << std::endl; } } */ TEST(Indexing, BinaryBruteForce) { int64_t N = 100000; int64_t num_queries = 10; int64_t topk = 5; int64_t round_decimal = 3; int64_t dim = 8192; Config search_params_ = {}; auto metric_type = knowhere::metric::JACCARD; auto result_count = topk * num_queries; auto schema = std::make_shared(); auto vec_fid = schema->AddDebugField( "vecbin", DataType::VECTOR_BINARY, dim, metric_type); auto i64_fid = schema->AddDebugField("age", DataType::INT64); auto dataset = DataGen(schema, N, 10); auto bin_vec = dataset.get_col(vec_fid); auto query_data = 1024 * dim / 8 + bin_vec.data(); query::dataset::SearchDataset search_dataset{ metric_type, // num_queries, // topk, // round_decimal, dim, // query_data // }; auto sub_result = query::BruteForceSearch( search_dataset, bin_vec.data(), N, knowhere::Json(), nullptr); SearchResult sr; sr.total_nq_ = num_queries; sr.unity_topK_ = topk; sr.seg_offsets_ = std::move(sub_result.mutable_seg_offsets()); sr.distances_ = std::move(sub_result.mutable_distances()); auto json = SearchResultToJson(sr); std::cout << json.dump(2); #ifdef __linux__ auto ref = json::parse(R"( [ [ [ "1024->0.000000", "48942->0.642000", "18494->0.644000", "68225->0.644000", "93557->0.644000" ], [ "1025->0.000000", "73557->0.641000", "53086->0.643000", "9737->0.643000", "62855->0.644000" ], [ "1026->0.000000", "62904->0.644000", "46758->0.644000", "57969->0.645000", "98113->0.646000" ], [ "1027->0.000000", "92446->0.638000", "96034->0.640000", "92129->0.644000", "45887->0.644000" ], [ "1028->0.000000", "22992->0.643000", "73903->0.644000", "19969->0.645000", "65178->0.645000" ], [ "1029->0.000000", "19776->0.641000", "15166->0.642000", "85470->0.642000", "16730->0.643000" ], [ "1030->0.000000", "55939->0.640000", "84253->0.643000", "31958->0.644000", "11667->0.646000" ], [ "1031->0.000000", "89536->0.637000", "61622->0.638000", "9275->0.639000", "91403->0.640000" ], [ "1032->0.000000", "69504->0.642000", "23414->0.644000", "48770->0.645000", "23231->0.645000" ], [ "1033->0.000000", "33540->0.636000", "25310->0.640000", "18576->0.640000", "73729->0.642000" ] ] ] )"); #else // for mac auto ref = json::parse(R"( [ [ [ "1024->0.000000", "59169->0.645000", "98548->0.646000", "3356->0.646000", "90373->0.647000" ], [ "1025->0.000000", "61245->0.638000", "95271->0.639000", "31087->0.639000", "31549->0.640000" ], [ "1026->0.000000", "65225->0.648000", "35750->0.648000", "14971->0.649000", "75385->0.649000" ], [ "1027->0.000000", "70158->0.640000", "27076->0.640000", "3407->0.641000", "59527->0.641000" ], [ "1028->0.000000", "45757->0.645000", "3356->0.645000", "77230->0.646000", "28690->0.647000" ], [ "1029->0.000000", "13291->0.642000", "24960->0.643000", "83770->0.643000", "88244->0.643000" ], [ "1030->0.000000", "96807->0.641000", "39920->0.643000", "62943->0.644000", "12603->0.644000" ], [ "1031->0.000000", "65769->0.648000", "60493->0.648000", "48738->0.648000", "4353->0.648000" ], [ "1032->0.000000", "57827->0.637000", "8213->0.638000", "22221->0.639000", "23328->0.640000" ], [ "1033->0.000000", "676->0.645000", "91430->0.646000", "85353->0.646000", "6014->0.646000" ] ] ] )"); #endif auto json_str = json.dump(2); auto ref_str = ref.dump(2); ASSERT_EQ(json_str, ref_str); } TEST(Indexing, Naive) { constexpr int N = 10000; constexpr int TOPK = 10; auto [raw_data, timestamps, uids] = generate_data(N); milvus::index::CreateIndexInfo create_index_info; create_index_info.field_type = DataType::VECTOR_FLOAT; create_index_info.metric_type = knowhere::metric::L2; create_index_info.index_type = knowhere::IndexEnum::INDEX_FAISS_IVFPQ; auto index = milvus::index::IndexFactory::GetInstance().CreateIndex( create_index_info, nullptr); auto build_conf = knowhere::Json{ {knowhere::meta::METRIC_TYPE, knowhere::metric::L2}, {knowhere::meta::DIM, std::to_string(DIM)}, {knowhere::indexparam::NLIST, "100"}, {knowhere::indexparam::M, "4"}, {knowhere::indexparam::NBITS, "8"}, }; auto search_conf = knowhere::Json{ {knowhere::meta::METRIC_TYPE, knowhere::metric::L2}, {knowhere::indexparam::NPROBE, 4}, }; std::vector datasets; std::vector> ftrashs; auto raw = raw_data.data(); for (int beg = 0; beg < N; beg += TestChunkSize) { auto end = beg + TestChunkSize; if (end > N) { end = N; } std::vector ft(raw + DIM * beg, raw + DIM * end); auto ds = knowhere::GenDataSet(end - beg, DIM, ft.data()); datasets.push_back(ds); ftrashs.push_back(std::move(ft)); } for (auto& ds : datasets) { index->BuildWithDataset(ds, build_conf); } auto bitmap = BitsetType(N, false); // exclude the first for (int i = 0; i < N / 2; ++i) { bitmap.set(i); } BitsetView view = bitmap; auto query_ds = knowhere::GenDataSet(1, DIM, raw_data.data()); milvus::SearchInfo searchInfo; searchInfo.topk_ = TOPK; searchInfo.metric_type_ = knowhere::metric::L2; searchInfo.search_params_ = search_conf; auto vec_index = dynamic_cast(index.get()); auto result = vec_index->Query(query_ds, searchInfo, view); for (int i = 0; i < TOPK; ++i) { if (result->seg_offsets_[i] < N / 2) { std::cout << "WRONG: "; } std::cout << result->seg_offsets_[i] << "->" << result->distances_[i] << std::endl; } } using Param = std::pair; class IndexTest : public ::testing::TestWithParam { protected: void SetUp() override { storage_config_ = get_default_storage_config(); auto param = GetParam(); index_type = param.first; metric_type = param.second; NB = 10000; if (index_type == knowhere::IndexEnum::INDEX_HNSW) { NB = 270000; } build_conf = generate_build_conf(index_type, metric_type); load_conf = generate_load_conf(index_type, metric_type, NB); search_conf = generate_search_conf(index_type, metric_type); range_search_conf = generate_range_search_conf(index_type, metric_type); std::map is_binary_map = { {knowhere::IndexEnum::INDEX_FAISS_IDMAP, false}, {knowhere::IndexEnum::INDEX_FAISS_IVFPQ, false}, {knowhere::IndexEnum::INDEX_FAISS_IVFFLAT, false}, {knowhere::IndexEnum::INDEX_FAISS_IVFSQ8, false}, {knowhere::IndexEnum::INDEX_FAISS_BIN_IVFFLAT, true}, {knowhere::IndexEnum::INDEX_FAISS_BIN_IDMAP, true}, {knowhere::IndexEnum::INDEX_HNSW, false}, {knowhere::IndexEnum::INDEX_DISKANN, false}, }; is_binary = is_binary_map[index_type]; if (is_binary) { vec_field_data_type = milvus::DataType::VECTOR_BINARY; } else { vec_field_data_type = milvus::DataType::VECTOR_FLOAT; } auto dataset = GenDataset(NB, metric_type, is_binary); if (!is_binary) { xb_data = dataset.get_col(milvus::FieldId(100)); xb_dataset = knowhere::GenDataSet(NB, DIM, xb_data.data()); xq_dataset = knowhere::GenDataSet( NQ, DIM, xb_data.data() + DIM * query_offset); } else { xb_bin_data = dataset.get_col(milvus::FieldId(100)); xb_dataset = knowhere::GenDataSet(NB, DIM, xb_bin_data.data()); xq_dataset = knowhere::GenDataSet( NQ, DIM, xb_bin_data.data() + DIM * query_offset); } } void TearDown() override { } protected: std::string index_type, metric_type; bool is_binary; milvus::Config build_conf; milvus::Config load_conf; milvus::Config search_conf; milvus::Config range_search_conf; milvus::DataType vec_field_data_type; knowhere::DataSetPtr xb_dataset; std::vector xb_data; std::vector xb_bin_data; knowhere::DataSetPtr xq_dataset; int64_t query_offset = 100; int64_t NB = 10000; StorageConfig storage_config_; }; INSTANTIATE_TEST_CASE_P( IndexTypeParameters, IndexTest, ::testing::Values( std::pair(knowhere::IndexEnum::INDEX_FAISS_IDMAP, knowhere::metric::L2), std::pair(knowhere::IndexEnum::INDEX_FAISS_IVFPQ, knowhere::metric::L2), std::pair(knowhere::IndexEnum::INDEX_FAISS_IVFFLAT, knowhere::metric::L2), std::pair(knowhere::IndexEnum::INDEX_FAISS_IVFSQ8, knowhere::metric::L2), std::pair(knowhere::IndexEnum::INDEX_FAISS_BIN_IVFFLAT, knowhere::metric::JACCARD), std::pair(knowhere::IndexEnum::INDEX_FAISS_BIN_IDMAP, knowhere::metric::JACCARD), #ifdef BUILD_DISK_ANN std::pair(knowhere::IndexEnum::INDEX_DISKANN, knowhere::metric::L2), #endif std::pair(knowhere::IndexEnum::INDEX_HNSW, knowhere::metric::L2))); TEST_P(IndexTest, BuildAndQuery) { milvus::index::CreateIndexInfo create_index_info; create_index_info.index_type = index_type; create_index_info.metric_type = metric_type; create_index_info.field_type = vec_field_data_type; index::IndexBasePtr index; milvus::storage::FieldDataMeta field_data_meta{1, 2, 3, 100}; milvus::storage::IndexMeta index_meta{3, 100, 1000, 1}; auto chunk_manager = milvus::storage::CreateChunkManager(storage_config_); auto file_manager = milvus::storage::CreateFileManager( index_type, field_data_meta, index_meta, chunk_manager); index = milvus::index::IndexFactory::GetInstance().CreateIndex( create_index_info, file_manager); ASSERT_NO_THROW(index->BuildWithDataset(xb_dataset, build_conf)); milvus::index::IndexBasePtr new_index; milvus::index::VectorIndex* vec_index = nullptr; auto binary_set = index->Upload(); index.reset(); new_index = milvus::index::IndexFactory::GetInstance().CreateIndex( create_index_info, file_manager); vec_index = dynamic_cast(new_index.get()); std::vector index_files; for (auto& binary : binary_set.binary_map_) { index_files.emplace_back(binary.first); } load_conf["index_files"] = index_files; ASSERT_NO_THROW(vec_index->Load(load_conf)); EXPECT_EQ(vec_index->Count(), NB); EXPECT_EQ(vec_index->GetDim(), DIM); milvus::SearchInfo search_info; search_info.topk_ = K; search_info.metric_type_ = metric_type; search_info.search_params_ = search_conf; auto result = vec_index->Query(xq_dataset, search_info, nullptr); EXPECT_EQ(result->total_nq_, NQ); EXPECT_EQ(result->unity_topK_, K); EXPECT_EQ(result->distances_.size(), NQ * K); EXPECT_EQ(result->seg_offsets_.size(), NQ * K); if (!is_binary) { EXPECT_EQ(result->seg_offsets_[0], query_offset); } search_info.search_params_ = range_search_conf; vec_index->Query(xq_dataset, search_info, nullptr); } TEST_P(IndexTest, Mmap) { milvus::index::CreateIndexInfo create_index_info; create_index_info.index_type = index_type; create_index_info.metric_type = metric_type; create_index_info.field_type = vec_field_data_type; index::IndexBasePtr index; milvus::storage::FieldDataMeta field_data_meta{1, 2, 3, 100}; milvus::storage::IndexMeta index_meta{3, 100, 1000, 1}; auto chunk_manager = milvus::storage::CreateChunkManager(storage_config_); auto file_manager = milvus::storage::CreateFileManager( index_type, field_data_meta, index_meta, chunk_manager); index = milvus::index::IndexFactory::GetInstance().CreateIndex( create_index_info, file_manager); ASSERT_NO_THROW(index->BuildWithDataset(xb_dataset, build_conf)); milvus::index::IndexBasePtr new_index; milvus::index::VectorIndex* vec_index = nullptr; auto binary_set = index->Upload(); index.reset(); new_index = milvus::index::IndexFactory::GetInstance().CreateIndex( create_index_info, file_manager); if (!new_index->IsMmapSupported()) { return; } vec_index = dynamic_cast(new_index.get()); std::vector index_files; for (auto& binary : binary_set.binary_map_) { index_files.emplace_back(binary.first); } load_conf["index_files"] = index_files; load_conf["mmap_filepath"] = "mmap/test_index_mmap_" + index_type; vec_index->Load(load_conf); EXPECT_EQ(vec_index->Count(), NB); EXPECT_EQ(vec_index->GetDim(), DIM); milvus::SearchInfo search_info; search_info.topk_ = K; search_info.metric_type_ = metric_type; search_info.search_params_ = search_conf; auto result = vec_index->Query(xq_dataset, search_info, nullptr); EXPECT_EQ(result->total_nq_, NQ); EXPECT_EQ(result->unity_topK_, K); EXPECT_EQ(result->distances_.size(), NQ * K); EXPECT_EQ(result->seg_offsets_.size(), NQ * K); if (!is_binary) { EXPECT_EQ(result->seg_offsets_[0], query_offset); } search_info.search_params_ = range_search_conf; vec_index->Query(xq_dataset, search_info, nullptr); } TEST_P(IndexTest, GetVector) { milvus::index::CreateIndexInfo create_index_info; create_index_info.index_type = index_type; create_index_info.metric_type = metric_type; create_index_info.field_type = vec_field_data_type; index::IndexBasePtr index; milvus::storage::FieldDataMeta field_data_meta{1, 2, 3, 100}; milvus::storage::IndexMeta index_meta{3, 100, 1000, 1}; auto chunk_manager = milvus::storage::CreateChunkManager(storage_config_); auto file_manager = milvus::storage::CreateFileManager( index_type, field_data_meta, index_meta, chunk_manager); index = milvus::index::IndexFactory::GetInstance().CreateIndex( create_index_info, file_manager); ASSERT_NO_THROW(index->BuildWithDataset(xb_dataset, build_conf)); milvus::index::IndexBasePtr new_index; milvus::index::VectorIndex* vec_index = nullptr; if (index_type == knowhere::IndexEnum::INDEX_DISKANN) { // TODO ::diskann.query need load first, ugly auto binary_set = index->Serialize(milvus::Config{}); index.reset(); new_index = milvus::index::IndexFactory::GetInstance().CreateIndex( create_index_info, file_manager); vec_index = dynamic_cast(new_index.get()); std::vector index_files; for (auto& binary : binary_set.binary_map_) { index_files.emplace_back(binary.first); } load_conf["index_files"] = index_files; vec_index->Load(binary_set, load_conf); EXPECT_EQ(vec_index->Count(), NB); } else { vec_index = dynamic_cast(index.get()); } EXPECT_EQ(vec_index->GetDim(), DIM); EXPECT_EQ(vec_index->Count(), NB); if (!vec_index->HasRawData()) { return; } auto ids_ds = GenRandomIds(NB); auto results = vec_index->GetVector(ids_ds); EXPECT_TRUE(results.size() > 0); if (!is_binary) { std::vector result_vectors(results.size() / (sizeof(float))); memcpy(result_vectors.data(), results.data(), results.size()); EXPECT_TRUE(result_vectors.size() == xb_data.size()); for (size_t i = 0; i < NB; ++i) { auto id = ids_ds->GetIds()[i]; for (size_t j = 0; j < DIM; ++j) { EXPECT_TRUE(result_vectors[i * DIM + j] == xb_data[id * DIM + j]); } } } else { EXPECT_TRUE(results.size() == xb_bin_data.size()); const auto data_bytes = DIM / 8; for (size_t i = 0; i < NB; ++i) { auto id = ids_ds->GetIds()[i]; for (size_t j = 0; j < data_bytes; ++j) { EXPECT_TRUE(results[i * data_bytes + j] == xb_bin_data[id * data_bytes + j]); } } } } #ifdef BUILD_DISK_ANN TEST(Indexing, SearchDiskAnnWithInvalidParam) { int64_t NB = 10000; IndexType index_type = knowhere::IndexEnum::INDEX_DISKANN; MetricType metric_type = knowhere::metric::L2; milvus::index::CreateIndexInfo create_index_info; create_index_info.index_type = index_type; create_index_info.metric_type = metric_type; create_index_info.field_type = milvus::DataType::VECTOR_FLOAT; int64_t collection_id = 1; int64_t partition_id = 2; int64_t segment_id = 3; int64_t field_id = 100; int64_t build_id = 1000; int64_t index_version = 1; StorageConfig storage_config = get_default_storage_config(); milvus::storage::FieldDataMeta field_data_meta{ collection_id, partition_id, segment_id, field_id}; milvus::storage::IndexMeta index_meta{ segment_id, field_id, build_id, index_version}; auto chunk_manager = storage::CreateChunkManager(storage_config); auto file_manager = milvus::storage::CreateFileManager( index_type, field_data_meta, index_meta, chunk_manager); auto index = milvus::index::IndexFactory::GetInstance().CreateIndex( create_index_info, file_manager); auto build_conf = Config{ {knowhere::meta::METRIC_TYPE, metric_type}, {knowhere::meta::DIM, std::to_string(DIM)}, {milvus::index::DISK_ANN_MAX_DEGREE, std::to_string(48)}, {milvus::index::DISK_ANN_SEARCH_LIST_SIZE, std::to_string(128)}, {milvus::index::DISK_ANN_PQ_CODE_BUDGET, std::to_string(0.001)}, {milvus::index::DISK_ANN_BUILD_DRAM_BUDGET, std::to_string(2)}, {milvus::index::DISK_ANN_BUILD_THREAD_NUM, std::to_string(2)}, }; // build disk ann index auto dataset = GenDataset(NB, metric_type, false); std::vector xb_data = dataset.get_col(milvus::FieldId(field_id)); knowhere::DataSetPtr xb_dataset = knowhere::GenDataSet(NB, DIM, xb_data.data()); ASSERT_NO_THROW(index->BuildWithDataset(xb_dataset, build_conf)); // serialize and load disk index, disk index can only be search after loading for now auto binary_set = index->Upload(); index.reset(); auto new_index = milvus::index::IndexFactory::GetInstance().CreateIndex( create_index_info, file_manager); auto vec_index = dynamic_cast(new_index.get()); std::vector index_files; for (auto& binary : binary_set.binary_map_) { index_files.emplace_back(binary.first); } auto load_conf = generate_load_conf(index_type, metric_type, NB); load_conf["index_files"] = index_files; vec_index->Load(load_conf); EXPECT_EQ(vec_index->Count(), NB); // search disk index with search_list == limit int query_offset = 100; knowhere::DataSetPtr xq_dataset = knowhere::GenDataSet(NQ, DIM, xb_data.data() + DIM * query_offset); milvus::SearchInfo search_info; search_info.topk_ = K; search_info.metric_type_ = metric_type; search_info.search_params_ = milvus::Config{ {knowhere::meta::METRIC_TYPE, metric_type}, {milvus::index::DISK_ANN_QUERY_LIST, K - 1}, }; EXPECT_THROW(vec_index->Query(xq_dataset, search_info, nullptr), std::runtime_error); } #endif