Skip to content

Conversation

@bryantower
Copy link
Contributor

@bryantower bryantower commented Jan 28, 2026

  • Does this PR have a descriptive title that could go in our release notes?
  • Does this PR add any new dependencies?
  • Does this PR modify any existing APIs?
  • Is the change to the API backwards compatible?
  • Should this result in any changes to our documentation, either updating existing docs or adding new ones?

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?

Also updated the location of the test data in the example json file.
@codecov-commenter
Copy link

codecov-commenter commented Jan 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.70%. Comparing base (528fd06) to head (606a81f).

Additional details and impacted files

Impacted file tree graph

@@           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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-benchmark instead of --package benchmark
  • Fixed the load_path in disk-index.json from the old disk-index/tests/data/ directory structure to the current test_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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants