Rename async to graph-index in diskann-benchmark#1009
Rename async to graph-index in diskann-benchmark#1009harsha-simhadri wants to merge 2 commits intomainfrom
Conversation
Replace misleading 'async' prefix with 'graph-index' across all benchmark registration names, display strings, JSON config files, and documentation. - Rename src/inputs/async_.rs to graph_index.rs and update module references - Rename 7 input tags (e.g. async-index-build -> graph-index-build) - Rename ~25 backend registration names across benchmarks.rs, product.rs, scalar.rs, spherical.rs - Fix bug: scalar.rs stub used 'async-pq' (copy-paste from product.rs), corrected to 'graph-index-sq' - Rename 10 JSON example/perf_test files and update their type fields - Update 3 test function names and file references in main.rs - Update README.md benchmark documentation Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
fd227a7 to
3618c15
Compare
Codecov Report❌ Patch coverage is
❌ Your patch status has failed because the patch coverage (77.14%) is below the target coverage (90.00%). You can increase the patch coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #1009 +/- ##
=======================================
Coverage 89.49% 89.49%
=======================================
Files 448 448
Lines 84118 84122 +4
=======================================
+ Hits 75282 75286 +4
Misses 8836 8836
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
| // Stub implementation | ||
| #[cfg(not(feature = "scalar-quantization"))] | ||
| imp::register("async-pq", benchmarks); | ||
| imp::register("graph-index-sq", benchmarks); |
There was a problem hiding this comment.
changed to Sq
There was a problem hiding this comment.
Pull request overview
This PR renames the diskann-benchmark crate’s graph-index benchmark inputs, benchmark names, example files, and docs from the old async terminology to graph-index so the public-facing labels better reflect that these jobs benchmark the graph index rather than async I/O.
Changes:
- Renames graph-index input tags and benchmark registration names from
async-*tograph-index-*. - Updates imports, module wiring, tests, example JSONs, and perf-test inputs to use the renamed graph-index module and tags.
- Refreshes README commands and examples to reference the new graph-index names and files.
Reviewed changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
diskann-benchmark/src/main.rs |
Renames integration tests and example file paths to the new graph-index filenames. |
diskann-benchmark/src/inputs/mod.rs |
Switches the registered input module from async_ to graph_index. |
diskann-benchmark/src/inputs/graph_index.rs |
Renames user-facing input tags, display strings, and comments for graph-index jobs. |
diskann-benchmark/src/backend/index/streaming/full_precision.rs |
Updates imports to the renamed graph-index input module. |
diskann-benchmark/src/backend/index/spherical.rs |
Updates spherical benchmark registration/imports to the new graph-index names. |
diskann-benchmark/src/backend/index/search/range.rs |
Retargets range-search input imports to graph_index. |
diskann-benchmark/src/backend/index/search/knn.rs |
Retargets k-NN input imports to graph_index. |
diskann-benchmark/src/backend/index/scalar.rs |
Renames scalar-quantized benchmark registrations and stub name, plus import paths. |
diskann-benchmark/src/backend/index/product.rs |
Renames product-quantized benchmark registrations/stub name and import paths. |
diskann-benchmark/src/backend/index/build.rs |
Updates build-path imports to the renamed graph-index module. |
diskann-benchmark/src/backend/index/benchmarks.rs |
Renames full-precision and dynamic benchmark registrations and graph-index imports. |
diskann-benchmark/perf_test_inputs/graph_index_scalar_oai_large.json |
Updates perf-test job types to the new graph-index SQ tag. |
diskann-benchmark/example/spherical.json |
Updates spherical example job types to the new graph-index tag. |
diskann-benchmark/example/spherical-filter.json |
Updates filtered spherical example job types to the new graph-index tag. |
diskann-benchmark/example/scalar.json |
Updates scalar example job types to the new graph-index SQ tag. |
diskann-benchmark/example/product.json |
Updates product example job type to the new graph-index PQ tag. |
diskann-benchmark/example/graph-index.json |
Renames the core graph-index example job type from async-index-build to graph-index-build. |
diskann-benchmark/example/graph-index-range.json |
Updates the range-search graph-index example tag. |
diskann-benchmark/example/graph-index-no-filter-ground-truth.json |
Updates the no-filter ground-truth example tag. |
diskann-benchmark/example/graph-index-multihop-filter-ground-truth-small.json |
Updates the multihop filter ground-truth example tag. |
diskann-benchmark/example/graph-index-filter.json |
Updates the filtered graph-index example tag. |
diskann-benchmark/example/graph-index-filter-ground-truth.json |
Updates the filter ground-truth example tag. |
diskann-benchmark/example/graph-index-filter-ground-truth-small.json |
Updates the small filter ground-truth example tag. |
diskann-benchmark/example/graph-index-dynamic.json |
Updates the dynamic graph-index example to the renamed dynamic input tag. |
diskann-benchmark/README.md |
Updates documented input kinds, benchmark names, commands, and terminology to graph-index. |
Comments suppressed due to low confidence (1)
diskann-benchmark/src/inputs/graph_index.rs:658
- Renaming this registered input tag is a breaking change for existing benchmark JSON files.
Jobs::parserejects unknown tags, and the input registry only supports a single tag per type, so any existingasync-index-buildconfigs will stop loading unless we keep a compatibility alias or provide an explicit migration path.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```json | ||
| { | ||
| "type": "async_index_build", | ||
| "type": "graph-index-build", |
Summary
Renames all
asyncreferences in thediskann-benchmarkcrate tograph-index, since these benchmarks exercise the graph index (not async I/O). This improves clarity for users reading benchmark names and configs.Changes
Source code
src/inputs/async_.rs->src/inputs/graph_index.rs(module declaration updated)async-index-build->graph-index-build)benchmarks.rs,product.rs,scalar.rs,spherical.rsinputs::async_::->inputs::graph_index::Bug fix
scalar.rs: stub registered as"async-pq"(from product.rs) instead of"graph-index-sq"JSON configs
async.json->graph-index.json)"type"fields inside JSON files to match new namesTests and docs
main.rsREADME.mdbenchmark references and example commandsVerification
cargo check -p diskann-benchmark --all-targetspasses cleanlyasyncreferences remain (only Rust keyword usage and unrelated API types)