Fix alpha pruning documentation - #1351
Merged
Mark Hildebrand (hildebrandmw) merged 1 commit intoAug 25, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates DiskANN graph pruning documentation to correct how the alpha parameter affects robust pruning behavior, aligning the rustdoc comments with the pruning implementation semantics.
Changes:
- Clarifies that higher
alphagenerally makes pruning less aggressive and yields denser graphs. - Updates
alphabuilder method documentation to match the corrected meaning. - Refines explanatory text around pruning behavior in the
PruneKindrustdoc.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1351 +/- ##
==========================================
- Coverage 91.55% 91.55% -0.01%
==========================================
Files 521 521
Lines 100347 100347
==========================================
- Hits 91877 91870 -7
- Misses 8470 8477 +7
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
juchen-ms (partychen)
approved these changes
Aug 24, 2026
Mark Hildebrand (hildebrandmw)
approved these changes
Aug 24, 2026
Mark Hildebrand (hildebrandmw)
left a comment
Contributor
There was a problem hiding this comment.
Thanks! Please wait for Magdalen Dobson Manohar (@magdalendobson) to sign-off.
Magdalen Dobson Manohar (magdalendobson)
approved these changes
Aug 25, 2026
Mark Hildebrand (hildebrandmw)
deleted the
wxy/fix-alpha-pruning-comments
branch
August 25, 2026 17:29
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.
Reference Issues/PRs
What does this implement/fix? Briefly explain your changes.
Corrects comments describing alpha during robust pruning. Higher alpha values make pruning less aggressive and generally retain more edges, producing denser graphs.
Any other comments?
Documentation-only change; no runtime behavior is modified.