Skip to content

Add a small streaming runbook and groundtruth to test_data#1127

Open
magdalendobson wants to merge 12 commits into
mainfrom
users/magdalen/add_streaming_runbook_and_gt
Open

Add a small streaming runbook and groundtruth to test_data#1127
magdalendobson wants to merge 12 commits into
mainfrom
users/magdalen/add_streaming_runbook_and_gt

Conversation

@magdalendobson
Copy link
Copy Markdown
Contributor

Currently we don't have a way to benchmark streaming algorithms using the existing test data. This PR adds a streaming runbook and groundtruth for the 256-point slice of sift that already exists in test_data. It also updates the example dynamic index in diskann-benchmark to use these files, and to be able to run correctly. This will help the existing and future dynamic benchmarks stay in sync with any changes, and allow us to run small tests.

@magdalendobson magdalendobson marked this pull request as ready for review June 2, 2026 19:45
@magdalendobson magdalendobson requested review from a team and Copilot June 2, 2026 19:45
Copy link
Copy Markdown
Contributor

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 adds a small “streaming” runbook + corresponding groundtruth files to the existing test_data/disk_index_search dataset, and updates the diskann-benchmark dynamic graph-index example to use the in-repo test data instead of external Big ANN Benchmarks paths. This makes it possible to run small, self-contained dynamic/streaming benchmark runs that stay aligned with future code changes.

Changes:

  • Added a streaming runbook YAML under test_data/disk_index_search/.
  • Added per-step groundtruth artifacts under test_data/disk_index_search/example_runbook_gt/.
  • Updated diskann-benchmark/example/graph-index-dynamic.json to use the in-repo SIFT-small-256 slice + new runbook/GT directory.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
test_data/disk_index_search/example_runbook.yaml Adds the streaming runbook (Git LFS-tracked) for the small SIFT slice.
test_data/disk_index_search/example_runbook_gt/step2.gt10 Adds runbook step groundtruth (Git LFS-tracked).
test_data/disk_index_search/example_runbook_gt/step4.gt10 Adds runbook step groundtruth (Git LFS-tracked).
test_data/disk_index_search/example_runbook_gt/step6.gt10 Adds runbook step groundtruth (Git LFS-tracked).
test_data/disk_index_search/example_runbook_gt/step8.gt10 Adds runbook step groundtruth (Git LFS-tracked).
diskann-benchmark/example/graph-index-dynamic.json Switches the dynamic example to test_data/disk_index_search and wires it to the new runbook + GT directory.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.87%. Comparing base (68cc3c4) to head (2ec71c9).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1127      +/-   ##
==========================================
- Coverage   88.87%   88.87%   -0.01%     
==========================================
  Files         485      485              
  Lines       92112    92112              
==========================================
- Hits        81868    81865       -3     
- Misses      10244    10247       +3     
Flag Coverage Δ
miri 88.87% <ø> (-0.01%) ⬇️
unittests 88.52% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

"search_directories": [
"../big-ann-benchmarks/data/MSTuringANNS",
"../big-ann-benchmarks/neurips23/runbooks"
"test_data/disk_index_search"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Care to wire this up to the integration tests to prevent regression?

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.

5 participants