[diskann] Add note on the selection of PruneKind in graph::config::Builder.#734
Merged
hildebrandmw merged 2 commits intomainfrom Feb 6, 2026
Merged
[diskann] Add note on the selection of PruneKind in graph::config::Builder.#734hildebrandmw merged 2 commits intomainfrom
PruneKind in graph::config::Builder.#734hildebrandmw merged 2 commits intomainfrom
Conversation
metajack
approved these changes
Feb 6, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds developer-facing documentation to diskann::graph::config::Builder::new() to warn that selecting the wrong PruneKind for a given distance metric can significantly harm graph quality/recall, and shows an example of deriving PruneKind from diskann_vector::distance::Metric.
Changes:
- Add a rustdoc “Note” section to
Builder::new()explaining thatPruneKindselection depends on the distance function. - Add a rustdoc example showing how to convert
MetricintoPruneKindwhen constructing aconfig::Builder.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #734 +/- ##
==========================================
+ Coverage 89.01% 90.31% +1.30%
==========================================
Files 428 428
Lines 78294 78294
==========================================
+ Hits 69692 70710 +1018
+ Misses 8602 7584 -1018
🚀 New features to boost your workflow:
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
suhasjs
approved these changes
Feb 6, 2026
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
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.
Add a note to
diskann::graph::config::Builder::new()highlighting the conversion fromdiskann_vector::distance::Metrictodiskann::graph::config::PruneKind.Incorrectly selecting
PruneKindcan have a profoundly negative impact on recall.