[MOD-8244] fix TieredFactory::EstimateInitialSize #567
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ssing, leading to a miss computation of the components memory size estimation)
…rocessorsContainerMemory)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #567 +/- ##
==========================================
- Coverage 96.97% 96.94% -0.04%
==========================================
Files 100 100
Lines 5287 5297 +10
==========================================
+ Hits 5127 5135 +8
- Misses 160 162 +2 ☔ View full report in Codecov by Sentry. |
meiravgri
changed the title
alonre24
previously approved these changes
Dec 12, 2024
| @@ -129,7 +129,7 @@ TYPED_TEST(HNSWTieredIndexTest, testSizeEstimation) { | |||
|
|
|||
| HNSWParams hnsw_params = {.type = TypeParam::get_index_type(), | |||
| .dim = dim, | |||
| .metric = VecSimMetric_L2, | |||
| .metric = VecSimMetric_Cosine, | |||
There was a problem hiding this comment.
Does changing the metric in this test enough to cover all the PR changes?
There was a problem hiding this comment.
It covers the second fix.
I'll add a test that validates the attributes of the tiered index indexes to validate the first.
There was a problem hiding this comment.
Actually, it was not a problem in the actual indexes, only in the estimation function
I don't have a way to test it.
I already added a test for the components, and it won't harm to have one so I'm keeping it
checkes tierred index indexes attributes and componenets
alonre24
reviewed
Dec 12, 2024
tests/unit/test_hnsw_tiered.cpp
Outdated
Comment on lines
162
to
164
| // CosinePreprocessor<TEST_DATA_T> cosine_pp = | ||
| // dynamic_cast<MultiPreprocessorsContainer<TEST_DATA_T, 1> | ||
| // *>(bf_preprocessors)->preprocessors[0]; |
alonre24
approved these changes
Dec 13, 2024
github-actions bot
pushed a commit
that referenced
this pull request
Dec 13, 2024
* initailize all bf params in tiered EstimateInitialSize (metric was missing, leading to a miss computation of the components memory size estimation) * add is_normalized to EstimateComponentsMemory (passed to EstimatePreprocessorsContainerMemory) * addHNSWTieredIndexTest:: testIndexesAttributes checkes tierred index indexes attributes and componenets * remove comment (cherry picked from commit a586edf)
|
Successfully created backport PR for |
github-merge-queue bot
pushed a commit
that referenced
this pull request
Dec 15, 2024
[MOD-8244] fix TieredFactory::EstimateInitialSize (#567) * initailize all bf params in tiered EstimateInitialSize (metric was missing, leading to a miss computation of the components memory size estimation) * add is_normalized to EstimateComponentsMemory (passed to EstimatePreprocessorsContainerMemory) * addHNSWTieredIndexTest:: testIndexesAttributes checkes tierred index indexes attributes and componenets * remove comment (cherry picked from commit a586edf) Co-authored-by: meiravgri <109056284+meiravgri@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses two bugs affecting the initial size estimation of the tiered index.
1. Missing Initialization of
BFParamsmembers inTieredFactory::EstimateInitialSizeBefore this fix, the
TieredHNSWFactory::EstimateInitialSizewas responsible for initializing specific members of theBFParamsstruct as follows:However, all other members of
BFParams,including metric, were left uninitialized, defaulting to zero. As a result, the metric defaulted toVecSimMetric_L2the default value forVecSimMetric.This caused the memory size of the brute-force index components to be calculated as if it were a
VecSimMetric_L2index. Consequently, if the actual metric of the index wasVecSimMetric_Cosine,the size of the cosine preprocessor was omitted from the estimation.After properly initializing all
BFParamsmembers, the size estimation for the frontend index of a tiered index using a cosine metric now includes the memory of the cosine preprocessor.As expected, this change caused the tiered index size estimation test for the cosine index to fail, as seen in the first commit’s checks.
2. Accounting for Cosine Preprocessor Size in
TieredHNSWFactory::EstimateInitialSizeFor an HNSW index within a tiered index using the
VecSimMetric_Cosinemetric, the cosine preprocessor is typically absent, as normalization is expected to be performed by the frontend index. This behavior was not accounted for in the initial size estimation logic.We now pass a
bool is_normalizedargument to the size estimation functions of the HNSW and brute-force indices. This argument ensures that the logic for size estimation mirrors the logic used during index construction.The
is_normalizedargument is propagated to theEstimateComponentsMemorymethod, which adds the memory size of the cosine preprocessor only if:VecSimMetric_Cosine,andis_normalized == false