// Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. #include "inc/Test.h" #include "inc/Helper/SimpleIniReader.h" #include "inc/Core/VectorIndex.h" #include "inc/Core/Common/CommonUtils.h" #include #include template void Build(SPTAG::IndexAlgoType algo, std::string distCalcMethod, std::shared_ptr& vec, std::shared_ptr& meta, const std::string out) { std::shared_ptr vecIndex = SPTAG::VectorIndex::CreateInstance(algo, SPTAG::GetEnumValueType()); BOOST_CHECK(nullptr != vecIndex); if (algo != SPTAG::IndexAlgoType::SPANN) { vecIndex->SetParameter("DistCalcMethod", distCalcMethod); vecIndex->SetParameter("NumberOfThreads", "16"); } else { vecIndex->SetParameter("IndexAlgoType", "BKT", "Base"); vecIndex->SetParameter("DistCalcMethod", distCalcMethod, "Base"); vecIndex->SetParameter("isExecute", "true", "SelectHead"); vecIndex->SetParameter("NumberOfThreads", "4", "SelectHead"); vecIndex->SetParameter("Ratio", "0.2", "SelectHead"); // vecIndex->SetParameter("Count", "200", "SelectHead"); vecIndex->SetParameter("isExecute", "true", "BuildHead"); vecIndex->SetParameter("RefineIterations", "3", "BuildHead"); vecIndex->SetParameter("NumberOfThreads", "4", "BuildHead"); vecIndex->SetParameter("isExecute", "true", "BuildSSDIndex"); vecIndex->SetParameter("BuildSsdIndex", "true", "BuildSSDIndex"); vecIndex->SetParameter("NumberOfThreads", "4", "BuildSSDIndex"); vecIndex->SetParameter("PostingPageLimit", "12", "BuildSSDIndex"); vecIndex->SetParameter("SearchPostingPageLimit", "12", "BuildSSDIndex"); vecIndex->SetParameter("InternalResultNum", "64", "BuildSSDIndex"); vecIndex->SetParameter("SearchInternalResultNum", "64", "BuildSSDIndex"); } BOOST_CHECK(SPTAG::ErrorCode::Success == vecIndex->BuildIndex(vec, meta)); BOOST_CHECK(SPTAG::ErrorCode::Success == vecIndex->SaveIndex(out)); } template void BuildWithMetaMapping(SPTAG::IndexAlgoType algo, std::string distCalcMethod, std::shared_ptr& vec, std::shared_ptr& meta, const std::string out) { std::shared_ptr vecIndex = SPTAG::VectorIndex::CreateInstance(algo, SPTAG::GetEnumValueType()); BOOST_CHECK(nullptr != vecIndex); if (algo != SPTAG::IndexAlgoType::SPANN) { vecIndex->SetParameter("DistCalcMethod", distCalcMethod); vecIndex->SetParameter("NumberOfThreads", "16"); } else { vecIndex->SetParameter("IndexAlgoType", "BKT", "Base"); vecIndex->SetParameter("DistCalcMethod", distCalcMethod, "Base"); vecIndex->SetParameter("isExecute", "true", "SelectHead"); vecIndex->SetParameter("NumberOfThreads", "4", "SelectHead"); vecIndex->SetParameter("Ratio", "0.2", "SelectHead"); // vecIndex->SetParameter("Count", "200", "SelectHead"); vecIndex->SetParameter("isExecute", "true", "BuildHead"); vecIndex->SetParameter("RefineIterations", "3", "BuildHead"); vecIndex->SetParameter("NumberOfThreads", "4", "BuildHead"); vecIndex->SetParameter("isExecute", "true", "BuildSSDIndex"); vecIndex->SetParameter("BuildSsdIndex", "true", "BuildSSDIndex"); vecIndex->SetParameter("NumberOfThreads", "4", "BuildSSDIndex"); vecIndex->SetParameter("PostingPageLimit", "12", "BuildSSDIndex"); vecIndex->SetParameter("SearchPostingPageLimit", "12", "BuildSSDIndex"); vecIndex->SetParameter("InternalResultNum", "64", "BuildSSDIndex"); vecIndex->SetParameter("SearchInternalResultNum", "64", "BuildSSDIndex"); } BOOST_CHECK(SPTAG::ErrorCode::Success == vecIndex->BuildIndex(vec, meta, true)); BOOST_CHECK(SPTAG::ErrorCode::Success == vecIndex->SaveIndex(out)); } template void Search(const std::string folder, T* vec, SPTAG::SizeType n, int k, std::string* truthmeta) { std::shared_ptr vecIndex; BOOST_CHECK(SPTAG::ErrorCode::Success == SPTAG::VectorIndex::LoadIndex(folder, vecIndex)); BOOST_CHECK(nullptr != vecIndex); for (SPTAG::SizeType i = 0; i < n; i++) { SPTAG::QueryResult res(vec, k, true); vecIndex->SearchIndex(res); std::unordered_set resmeta; for (int j = 0; j < k; j++) { resmeta.insert(std::string((char*)res.GetMetadata(j).Data(), res.GetMetadata(j).Length())); std::cout << res.GetResult(j)->Dist << "@(" << res.GetResult(j)->VID << "," << std::string((char*)res.GetMetadata(j).Data(), res.GetMetadata(j).Length()) << ") "; } std::cout << std::endl; for (int j = 0; j < k; j++) { BOOST_CHECK(resmeta.find(truthmeta[i * k + j]) != resmeta.end()); } vec += vecIndex->GetFeatureDim(); } vecIndex.reset(); } template void Add(const std::string folder, std::shared_ptr& vec, std::shared_ptr& meta, const std::string out) { std::shared_ptr vecIndex; BOOST_CHECK(SPTAG::ErrorCode::Success == SPTAG::VectorIndex::LoadIndex(folder, vecIndex)); BOOST_CHECK(nullptr != vecIndex); BOOST_CHECK(SPTAG::ErrorCode::Success == vecIndex->AddIndex(vec, meta)); BOOST_CHECK(SPTAG::ErrorCode::Success == vecIndex->SaveIndex(out)); vecIndex.reset(); } template void AddOneByOne(SPTAG::IndexAlgoType algo, std::string distCalcMethod, std::shared_ptr& vec, std::shared_ptr& meta, const std::string out) { std::shared_ptr vecIndex = SPTAG::VectorIndex::CreateInstance(algo, SPTAG::GetEnumValueType()); BOOST_CHECK(nullptr != vecIndex); vecIndex->SetParameter("DistCalcMethod", distCalcMethod); vecIndex->SetParameter("NumberOfThreads", "16"); auto t1 = std::chrono::high_resolution_clock::now(); for (SPTAG::SizeType i = 0; i < vec->Count(); i++) { SPTAG::ByteArray metaarr = meta->GetMetadata(i); std::uint64_t offset[2] = { 0, metaarr.Length() }; std::shared_ptr metaset(new SPTAG::MemMetadataSet(metaarr, SPTAG::ByteArray((std::uint8_t*)offset, 2 * sizeof(std::uint64_t), false), 1)); SPTAG::ErrorCode ret = vecIndex->AddIndex(vec->GetVector(i), 1, vec->Dimension(), metaset, true); if (SPTAG::ErrorCode::Success != ret) std::cerr << "Error AddIndex(" << (int)(ret) << ") for vector " << i << std::endl; } auto t2 = std::chrono::high_resolution_clock::now(); std::cout << "AddIndex time: " << (std::chrono::duration_cast(t2 - t1).count() / (float)(vec->Count())) << "us" << std::endl; Sleep(10000); BOOST_CHECK(SPTAG::ErrorCode::Success == vecIndex->SaveIndex(out)); } template void Delete(const std::string folder, T* vec, SPTAG::SizeType n, const std::string out) { std::shared_ptr vecIndex; BOOST_CHECK(SPTAG::ErrorCode::Success == SPTAG::VectorIndex::LoadIndex(folder, vecIndex)); BOOST_CHECK(nullptr != vecIndex); BOOST_CHECK(SPTAG::ErrorCode::Success == vecIndex->DeleteIndex((const void*)vec, n)); BOOST_CHECK(SPTAG::ErrorCode::Success == vecIndex->SaveIndex(out)); vecIndex.reset(); } template void Test(SPTAG::IndexAlgoType algo, std::string distCalcMethod) { SPTAG::SizeType n = 2000, q = 3; SPTAG::DimensionType m = 10; int k = 3; std::vector vec; for (SPTAG::SizeType i = 0; i < n; i++) { for (SPTAG::DimensionType j = 0; j < m; j++) { vec.push_back((T)i); } } std::vector query; for (SPTAG::SizeType i = 0; i < q; i++) { for (SPTAG::DimensionType j = 0; j < m; j++) { query.push_back((T)i*2); } } std::vector meta; std::vector metaoffset; for (SPTAG::SizeType i = 0; i < n; i++) { metaoffset.push_back((std::uint64_t)meta.size()); std::string a = std::to_string(i); for (size_t j = 0; j < a.length(); j++) meta.push_back(a[j]); } metaoffset.push_back((std::uint64_t)meta.size()); std::shared_ptr vecset(new SPTAG::BasicVectorSet( SPTAG::ByteArray((std::uint8_t*)vec.data(), sizeof(T) * n * m, false), SPTAG::GetEnumValueType(), m, n)); std::shared_ptr metaset(new SPTAG::MemMetadataSet( SPTAG::ByteArray((std::uint8_t*)meta.data(), meta.size() * sizeof(char), false), SPTAG::ByteArray((std::uint8_t*)metaoffset.data(), metaoffset.size() * sizeof(std::uint64_t), false), n)); Build(algo, distCalcMethod, vecset, metaset, "testindices"); std::string truthmeta1[] = { "0", "1", "2", "2", "1", "3", "4", "3", "5" }; Search("testindices", query.data(), q, k, truthmeta1); if (algo != SPTAG::IndexAlgoType::SPANN) { Add("testindices", vecset, metaset, "testindices"); std::string truthmeta2[] = { "0", "0", "1", "2", "2", "1", "4", "4", "3" }; Search("testindices", query.data(), q, k, truthmeta2); Delete("testindices", query.data(), q, "testindices"); std::string truthmeta3[] = { "1", "1", "3", "1", "3", "1", "3", "5", "3" }; Search("testindices", query.data(), q, k, truthmeta3); } BuildWithMetaMapping(algo, distCalcMethod, vecset, metaset, "testindices"); std::string truthmeta4[] = { "0", "1", "2", "2", "1", "3", "4", "3", "5" }; Search("testindices", query.data(), q, k, truthmeta4); if (algo != SPTAG::IndexAlgoType::SPANN) { Add("testindices", vecset, metaset, "testindices"); std::string truthmeta5[] = { "0", "1", "2", "2", "1", "3", "4", "3", "5" }; Search("testindices", query.data(), q, k, truthmeta5); AddOneByOne(algo, distCalcMethod, vecset, metaset, "testindices"); std::string truthmeta6[] = { "0", "1", "2", "2", "1", "3", "4", "3", "5" }; Search("testindices", query.data(), q, k, truthmeta6); } } BOOST_AUTO_TEST_SUITE (AlgoTest) BOOST_AUTO_TEST_CASE(KDTTest) { Test(SPTAG::IndexAlgoType::KDT, "L2"); } BOOST_AUTO_TEST_CASE(BKTTest) { Test(SPTAG::IndexAlgoType::BKT, "L2"); } BOOST_AUTO_TEST_CASE(SPANNTest) { Test(SPTAG::IndexAlgoType::SPANN, "L2"); } BOOST_AUTO_TEST_SUITE_END()