migrating multi-hop tests from diskann-providers to diskann#928
migrating multi-hop tests from diskann-providers to diskann#928JordanMaples wants to merge 2 commits into
Conversation
5a59f22 to
5655eea
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #928 +/- ##
==========================================
+ Coverage 89.46% 90.60% +1.13%
==========================================
Files 458 459 +1
Lines 85530 85452 -78
==========================================
+ Hits 76522 77425 +903
+ Misses 9008 8027 -981
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
8105440 to
b7d238b
Compare
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Migrates a first set of multi-hop search traversal unit tests from diskann_async into the diskann crate’s graph test suite, and introduces shared search ground-truth utilities to support those tests.
Changes:
- Added
multihoptest cases underdiskann/src/graph/test/cases/and wired them into the test module. - Introduced
diskann::graph::test::search_utilswith ground-truth + assertion helpers for search verification. - Removed the migrated multi-hop test helpers/cases from
diskann-providers/src/index/diskann_async.rsand adjusteddiskann-providerstest utils module visibility/docs.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| diskann/src/graph/test/search_utils.rs | Adds ground-truth computation and assertion helpers for graph search tests. |
| diskann/src/graph/test/mod.rs | Exposes the new search_utils module in the graph test module. |
| diskann/src/graph/test/cases/multihop.rs | Adds migrated multi-hop traversal/filtering/termination/callback tests. |
| diskann/src/graph/test/cases/mod.rs | Registers the new multihop test module. |
| diskann-providers/src/test_utils/search_utils.rs | Updates/clarifies docs around duplicated ground-truth helpers for provider-side tests. |
| diskann-providers/src/test_utils/mod.rs | Makes search_utils publicly accessible from diskann-providers::test_utils. |
| diskann-providers/src/index/diskann_async.rs | Removes migrated multi-hop-related tests and supporting helpers. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
hildebrandmw
left a comment
There was a problem hiding this comment.
Thanks Jordan! This is moving the tests in the right direction, but we need to be careful about just moving the test infrastructure from diskann_async.rs as-is.
The utilities in search_utils.rs are extremely awkward for actually running tests, are very sensitive, and don't provide much useful information when they fire.
They've been used in diskann_async.rs because it was kind of the best thing we had back then.
My hope is that the new diskann can take a higher signal approach using baselines and VerboseEq.
Not only does this provide a really good way of viewing the expected results as a whole, it's also great for storing additional metrics.
For example, the stats, ids, and distances from multi-hop search can all be checked in as part of the baseline and get protected for free.
My ask is to not migrate the search_utils.rs as is - especially if it means including test methods that aren't actually used by diskann.
Also, use the baseline capturing mechanism to capture everything about both test setups and results.
We cannot rely solely on the baseline to protect against regression (someone could check-in a broken baseline in the future), but a baseline in combination with some invariant checks (returned items should be filtered/adjusted) will go a long way toward good tests.
|
converting back to draft as it needs some more human refinement |
|
@copilot would you mind taking another review over this pr as it has changed significantly from your previous review. |
Addressed in 9c85d26:
I re-reviewed the updated PR state and the major requested shifts are present (baseline-driven multihop tests + removal of migrated |
- Add unit tests for multihop search and NotInMutWithLabelCheck predicate - Add two-hop reachability test for multihop search - Extract shared helpers in multihop tests - Rework multihop tests with baselines, remove search_utils from providers - Remove stale duplication comment from diskann-providers search_utils - Revert cosmetic search_utils.rs changes and make mod private
8b6c08f to
ae4e60a
Compare
This is a first step in the effort to migrate unit tests from diskann_async to diskann #927. If you don't think tests that have been brought over should be moved, they probably shouldn't have been. Please point them out and I'll do my best to put them back where I found them.
of the inmem provider
Key differences from the original tests:
with PQ quantization — appropriate since these test traversal behavior, not quantization
post-processor), so reject_all_returns_zero_results asserts zero non-start-point results rather than zero total
results