Uh oh!
There was an error while loading. Please reload this page.
Updating the benchmark README to use diskann-benchmark - #709
Conversation
Also updated the location of the test data in the example json file.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@## main #709 +/- ##
=======================================
Coverage 86.70% 86.70% =======================================
Files 398 398 Lines 74238 74238 =======================================
Hits 64371 64371 Misses 9867 9867 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR updates the diskann-benchmark README documentation to consistently reference the correct package name diskann-benchmark instead of just benchmark in all cargo commands. It also fixes an outdated file path in the disk-index.json example configuration.
Changes:
- Updated all cargo command examples in README.md to use
--package diskann-benchmarkinstead of--package benchmark - Fixed the load_path in disk-index.json from the old
disk-index/tests/data/directory structure to the currenttest_data/structure
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| diskann-benchmark/README.md | Updated 8 cargo command examples to use the correct package name diskann-benchmark |
| diskann-benchmark/example/disk-index.json | Fixed outdated test data path to match current repository structure |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Mark Hildebrand (hildebrandmw)
commented
Feb 3, 2026
Thanks Bryan Tower (@bryantower)! We're about to finish migrating to the OSS repo, after which I'll merge this PR. |
Uh oh!
There was an error while loading. Please reload this page.
## What's Changed ### API Breaking Changes * Remove the `experimental_avx512` feature. by @hildebrandmw in #732 * Use VirtualStorageProvider::new_overlay(test_data_root()) in tests by @Copilot in #726 * save and load max_record_size and leaf_page_size for bftrees by @backurs in #724 * [multi-vector] Verify `Standard` won't overflow in its constructor. by @hildebrandmw in #757 * VirtualStorageProvider: Make new() private, add new_physical by @Copilot in #764 * [minmax] Refactor full query by @arkrishn94 in #770 * Bump diskann-quantization to edition 2024. by @hildebrandmw in #772 ### Additions * [multi-vector] Enable cloning of `Mat` and friends. by @hildebrandmw in #759 * adding bftreepaths in mod.rs by @backurs in #775 * [quantization] Add `as_raw_ptr`. by @hildebrandmw in #774 ### Bug Fixes * Fix `diskann` compilation without default-features and add CI tests. by @hildebrandmw in #722 ### Docs and Comments * Updating the benchmark README to use diskann-benchmark by @bryantower in #709 * Fix doc comment: Windows line endings are \r\n not \n\r by @Copilot in #717 * Fix spelling errors in streaming API documentation by @Copilot in #715 * Add performance diagnostic to `diskann-benchmark` by @hildebrandmw in #744 * Add agents.md onboarding guide for coding agents by @Copilot in #765 * [doc] Fix lots of little typos in `diskann-wide` by @hildebrandmw in #771 ### Performance * [diskann-wide] Optimize `load_simd_first` for 8-bit and 16-bit element types. by @hildebrandmw in #747 ### Dependencies * Bump bytes from 1.11.0 to 1.11.1 by @dependabot[bot] in #723 * [diskann] Add note on the selection of `PruneKind` in `graph::config::Builder`. by @hildebrandmw in #734 * [diskann-providers] Remove the LRU dependency and make `vfs` and `serde_json` optional. by @hildebrandmw in #733 ### Infrastructure * Add initial QEMU tests for `diskann-wide`. by @hildebrandmw in #719 * [CI] Skip coverage for Dependabot. by @hildebrandmw in #725 * Add miri test coverage to CI workflow by @Copilot in #729 * [CI] Add minimal ARM checks by @hildebrandmw in #745 * Enable CodeQL security analysis by @Copilot in #754 ## New Contributors * @backurs made their first contribution in #724 * @arkrishn94 made their first contribution in #770 **Full Changelog**: 0.45.0...0.46.0
Reference Issues/PRs
What does this implement/fix? Briefly explain your changes.
The README was just referencing benchmark, but it should say diskann-benchmark
Also updated the location of the test data in one of the example json files.
There may be other locations that need to be updated.
Any other comments?