Migrate disk PQ flat scan to flat API - #1341
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
a802e20 to
4d78a62
Compare
There was a problem hiding this comment.
Pull request overview
This PR migrates the disk PQ “flat scan” path onto the shared diskann::flat API, introducing a dedicated disk PQ FlatSearchStrategy + visitor that scans PQ-compressed rows and then reuses the existing full-precision reranking + filtering pipeline. It also factors PQ query preprocessing into a reusable owned query-computer (TransposedQueryComputer) so both graph and flat PQ search can share the same preprocessing approach.
Changes:
- Update
FlatIndex::knn_searchto return a lifetime-boundSendFutureso it can borrow strategy/context/output across.await. - Add
TransposedQueryComputer(+ error type) to build per-query PQ lookup tables for transposed PQ tables. - Route disk flat scan through
FlatIndexusing a new disk-specific flat strategy/visitor, and remove now-unused PQ scratch batching API.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| diskann/src/flat/index.rs | Adjusts knn_search signature/lifetimes to support borrowed-provider flat search entrypoints. |
| diskann-quantization/src/product/tables/transposed/query.rs | Introduces an owned PQ query computer for transposed tables (L2/IP), with unit tests. |
| diskann-quantization/src/product/tables/transposed/mod.rs | Wires the new transposed query module into the transposed table submodule exports. |
| diskann-quantization/src/product/tables/mod.rs | Re-exports the new transposed query computer + error at the tables module boundary. |
| diskann-quantization/src/product/mod.rs | Re-exports the new transposed query types at the product module boundary. |
| diskann-disk/src/search/provider/disk_provider.rs | Implements disk PQ flat scan via diskann::flat (DiskFlatProvider/DiskFlatSearchStrategy/DiskFlatVisitor) while preserving scan-time filtering and rerank behavior. |
| diskann-disk/src/search/pq/pq_scratch.rs | Removes PQScratch::max_vectors and updates tests accordingly (no longer needed after migration). |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
Aditya Krishnan (@arkrishn94) I ended up making a few design changes beyond the
One related detail: filtering happens in These were the main areas where the migration required broader architectural choices, so feedback on them would be helpful before finalizing the approach. |
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #1341 +/- ##
==========================================
- Coverage 91.56% 91.54% -0.02%
==========================================
Files 521 521
Lines 99527 99872 +345
==========================================
+ Hits 91132 91431 +299
- Misses 8395 8441 +46
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Mark Hildebrand (hildebrandmw)
left a comment
There was a problem hiding this comment.
As usual, I will defer to the maintainers of diskann-disk to make the judgement calls here, but what immediately stands out to me is that trying to fit the flat scan into the diskann flat-scan API is essentially recreating the custom flat-scan implementation but with significantly more code. That is, this appears to be working hard to fit the API (and indeed changing the API in diskann) without materially benefiting from doing so.
To me, this indicates two things:
- There is an ergonomic gap in the flat API that needs to be fixed. For example - it requires a
QueryComputerwhich is causing some of the churn in this PR [1]. I don't think that's a good direction since it separates the compute engine from the internal of theFlatAccessor, when closer coupling (e.g. howSearchAccessorworks now for the graph index) allows for safer optimization. - We're missing even lower-level infrastructure (e.g. generic batch PQ computation independent of
diskann-disk) that would help with reusability. Think: a more generally reuseable version ofcompute_pq_distance.
There are parts that look good. Extracting rerank_and_filter to a synchronous function (instead of the current unfortunate bounce through async) is a good improvement. Simplifying PQ scratch initialization is good - though I might suggest keeping it in DiskSearchScratch fusing it with the DiskSearchScratch's pooled API to avoid the multi-stage initialization that is currently done.
[1] The graph portion of diskann used to work this way and it turns out to be way better for a huge number of reasons to not.
I agree that the current migration is adapting around the flat API rather than benefiting from it. The disk PQ implementation exposed a limitation in the current abstraction: separating the visitor from Following the principle established in PR #1067, I propose passing the query when constructing the flat visitor and making the visitor responsible for producing distances. The generic flat layer would still own top-k selection and post-processing; only backend-specific query execution moves behind the visitor. For disk PQ, this allows graph and flat search to share one pooled I also checked the visible consumers of this API. Outside DiskANN’s own benchmarks and tests, I could not find an independent public implementation; the other matches are forks or vendored copies. That suggests the migration cost is currently limited, while changing it now avoids establishing the separated-computer model as a long-term public contract. The main trade-off is a public trait change, but we can minimize it by keeping the existing trait and method names: let mut visitor = strategy.create_visitor(provider, context, query)?;
visitor.distances_unordered(callback).await?;I have a local prototype of this design. It preserves the existing flat-search behavior and removes the additional query-computer machinery rather than replacing it with another abstraction. Would this direction better match what you had in mind when referencing PR #1067? Mark Hildebrand (@hildebrandmw) |
Summary
FlatVisitorwith batchedDistancesUnorderedscanningPQQueryComputerbetween graph and flat PQ search preprocessingValidation
Closes #1104