Skip to content

Add primary-only LeanVec storage kinds to C++ runtime #338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ibhati wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add primary-only LeanVec storage kinds to C++ runtime #338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions bindings/cpp/include/svs/runtime/api_defs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,10 @@ enum class StorageKind {
LeanVec4x4,
LeanVec4x8,
LeanVec8x8,
// Primary-only LeanVec variants: only the lossy primary tier is stored, no
// secondary (reranking) tier. Trades reranking accuracy for ~50% less memory.
LeanVecLVQ4PrimaryOnly,
LeanVecLVQ8PrimaryOnly,
};

enum class ErrorCode {
Expand Down
12 changes: 12 additions & 0 deletions bindings/cpp/src/dynamic_vamana_index_leanvec_impl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,18 @@ struct DynamicVamanaIndexLeanVecImpl : public DynamicVamanaIndexImpl {
storage::StorageType<StorageKind::LeanVec8x8, allocator_type>{},
std::forward<Args>(args)...
);
case StorageKind::LeanVecLVQ4PrimaryOnly:
return f(
storage::
StorageType<StorageKind::LeanVecLVQ4PrimaryOnly, allocator_type>{},
std::forward<Args>(args)...
);
case StorageKind::LeanVecLVQ8PrimaryOnly:
return f(
storage::
StorageType<StorageKind::LeanVecLVQ8PrimaryOnly, allocator_type>{},
std::forward<Args>(args)...
);
default:
throw StatusException{
ErrorCode::INVALID_ARGUMENT, "SVS LeanVec storage kind required"};
Expand Down
23 changes: 22 additions & 1 deletion bindings/cpp/src/svs_runtime_utils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,8 @@ inline constexpr bool is_lvq_storage(StorageKind kind) {

inline constexpr bool is_leanvec_storage(StorageKind kind) {
return kind == StorageKind::LeanVec4x4 || kind == StorageKind::LeanVec4x8 ||
kind == StorageKind::LeanVec8x8;
kind == StorageKind::LeanVec8x8 || kind == StorageKind::LeanVecLVQ4PrimaryOnly ||
kind == StorageKind::LeanVecLVQ8PrimaryOnly;
}

inline bool is_supported_storage_kind(StorageKind kind) {
Expand Down Expand Up @@ -344,6 +345,24 @@ template <typename Alloc> struct StorageType<StorageKind::LeanVec8x8, Alloc> {
using type = LeanDatasetType<8, 8, allocator_type>;
};

// Primary-only LeanVec: secondary tier type is `void`.
template <
size_t I1,
typename Alloc,
size_t LeanVecDims = svs::Dynamic,
size_t Extent = svs::Dynamic>
using LeanDatasetPrimaryOnlyType =
svs::leanvec::LeanDataset<svs::leanvec::UsingLVQ<I1>, void, LeanVecDims, Extent, Alloc>;

template <typename Alloc> struct StorageType<StorageKind::LeanVecLVQ4PrimaryOnly, Alloc> {
using allocator_type = rebind_extracted_allocator_t<std::byte, Alloc>;
using type = LeanDatasetPrimaryOnlyType<4, allocator_type>;
};
template <typename Alloc> struct StorageType<StorageKind::LeanVecLVQ8PrimaryOnly, Alloc> {
using allocator_type = rebind_extracted_allocator_t<std::byte, Alloc>;
using type = LeanDatasetPrimaryOnlyType<8, allocator_type>;
};

template <svs::leanvec::IsLeanDataset LeanVecStorageType>
struct StorageFactory<LeanVecStorageType> {
using StorageType = LeanVecStorageType;
Expand Down Expand Up @@ -394,6 +413,8 @@ auto dispatch_storage_kind(StorageKind kind, F&& f, Args&&... args) {
SVS_DISPATCH_STORAGE_KIND(LeanVec4x4);
SVS_DISPATCH_STORAGE_KIND(LeanVec4x8);
SVS_DISPATCH_STORAGE_KIND(LeanVec8x8);
SVS_DISPATCH_STORAGE_KIND(LeanVecLVQ4PrimaryOnly);
SVS_DISPATCH_STORAGE_KIND(LeanVecLVQ8PrimaryOnly);
default:
throw StatusException(
ErrorCode::INVALID_ARGUMENT, "Unknown or unsupported SVS storage kind"
Expand Down
12 changes: 12 additions & 0 deletions bindings/cpp/src/vamana_index_impl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -555,6 +555,18 @@ struct VamanaIndexLeanVecImpl : public VamanaIndexImpl {
storage::StorageType<StorageKind::LeanVec8x8, allocator_type>{},
std::forward<Args>(args)...
);
case StorageKind::LeanVecLVQ4PrimaryOnly:
return f(
storage::
StorageType<StorageKind::LeanVecLVQ4PrimaryOnly, allocator_type>{},
std::forward<Args>(args)...
);
case StorageKind::LeanVecLVQ8PrimaryOnly:
return f(
storage::
StorageType<StorageKind::LeanVecLVQ8PrimaryOnly, allocator_type>{},
std::forward<Args>(args)...
);
default:
throw StatusException{
ErrorCode::INVALID_ARGUMENT, "SVS LeanVec storage kind required"};
Expand Down
50 changes: 50 additions & 0 deletions bindings/cpp/tests/runtime_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,56 @@ CATCH_TEST_CASE("WriteAndReadIndexSVSVamanaLeanVec4x4", "[runtime]") {
);
}

CATCH_TEST_CASE("WriteAndReadIndexSVSVamanaLeanVecLVQ4PrimaryOnly", "[runtime]") {
const auto& test_data = get_test_data();
auto build_func = [](svs::runtime::v0::DynamicVamanaIndex** index) {
svs::runtime::v0::VamanaIndex::BuildParams build_params{64};
svs::runtime::v0::VamanaIndex::DynamicIndexParams dynamic_index_params{19};
return svs::runtime::v0::DynamicVamanaIndexLeanVec::build(
index,
test_d,
svs::runtime::v0::MetricType::L2,
svs::runtime::v0::StorageKind::LeanVecLVQ4PrimaryOnly,
32,
build_params,
{},
dynamic_index_params
);
};
write_and_read_index<svs::runtime::v0::DynamicVamanaIndex>(
build_func,
test_data,
test_n,
test_d,
svs::runtime::v0::StorageKind::LeanVecLVQ4PrimaryOnly
);
}

CATCH_TEST_CASE("WriteAndReadIndexSVSVamanaLeanVecLVQ8PrimaryOnly", "[runtime]") {
const auto& test_data = get_test_data();
auto build_func = [](svs::runtime::v0::DynamicVamanaIndex** index) {
svs::runtime::v0::VamanaIndex::BuildParams build_params{64};
svs::runtime::v0::VamanaIndex::DynamicIndexParams dynamic_index_params{19};
return svs::runtime::v0::DynamicVamanaIndexLeanVec::build(
index,
test_d,
svs::runtime::v0::MetricType::L2,
svs::runtime::v0::StorageKind::LeanVecLVQ8PrimaryOnly,
32,
build_params,
{},
dynamic_index_params
);
};
write_and_read_index<svs::runtime::v0::DynamicVamanaIndex>(
build_func,
test_data,
test_n,
test_d,
svs::runtime::v0::StorageKind::LeanVecLVQ8PrimaryOnly
);
}

CATCH_TEST_CASE("LeanVecWithTrainingData", "[runtime]") {
const auto& test_data = get_test_data();
// Build LeanVec index with explicit training
Expand Down
Loading