Fix alpha pruning documentation - #1351
Conversation
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.
| @@ -51,8 +51,8 @@ use crate::utils::IntoUsize; | |||
| /// entirely as a neighbor candidate (achieved by settings its occlusion factor to | |||
| @@ -51,8 +51,8 @@ use crate::utils::IntoUsize; | |||
| /// entirely as a neighbor candidate (achieved by settings its occlusion factor to | |||
| /// `f32::MAX`. | |||
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:
|
Mark Hildebrand (hildebrandmw)
left a comment
Mark Hildebrand (hildebrandmw)
left a comment
There was a problem hiding this comment.
Thanks! Please wait for Magdalen Dobson Manohar (@magdalendobson) to sign-off.
| /// A higher occlusion factor means that `j` and `k` are "more similar" than `i` and `k`. | ||
| /// The pruning rules are heuristics established such that using higher values of `alpha` | ||
| /// yields sparser graphs. | ||
| /// makes pruning less aggressive and generally yields denser graphs. |
There was a problem hiding this comment.
Magdalen Dobson Manohar (@magdalendobson) - can you quickly sanity check this as well. I was the one who got it wrong in the first place, so someone other than me should eyeball it :laugh:
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.