Add A/A benchmark documentation#974
Open
YuanyuanTian-hh wants to merge 3 commits intomainfrom
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds standalone documentation for the daily DiskANN A/A benchmark stability workflow, so maintainers can understand what it does and how to interpret failures without reading the workflow YAML.
Changes:
- Add
diskann-benchmark/AA_BENCHMARK.mddescribing the A/A benchmark purpose, schedule, datasets, and pipeline steps. - Document the tolerance thresholds used for baseline vs target comparisons.
- Document failure notification behavior and how A/A differs from the A/B benchmark workflow.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #974 +/- ##
==========================================
- Coverage 89.43% 89.43% -0.01%
==========================================
Files 449 449
Lines 83779 83779
==========================================
- Hits 74928 74926 -2
- Misses 8851 8853 +2
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
arrayka
requested changes
Apr 23, 2026
YuanyuanTian-hh
force-pushed
the
tianyuanyuan/add-aa-benchmark-docs
branch
from
419230d to
49554d3
Compare
Address review feedback from arrayka: - Place doc in .github/docs/disk-benchmarks-aa.md (lowercase, next to workflows) - Remove redundant Steps section to keep the doc concise - Add back-link from disk-benchmarks-aa.yml to the doc - Keep tolerance thresholds, failure notification, and A/B comparison sections
YuanyuanTian-hh
force-pushed
the
tianyuanyuan/add-aa-benchmark-docs
branch
from
49554d3 to
d53e542
Compare
Address review feedback: the A/A benchmark has a 95% reliability promise, meaning 1 failure in 20 runs is expected. The notify-on-failure job now checks the last 20 completed runs and only creates a GitHub issue if the failure rate exceeds 5%. This avoids unnecessary noise from expected environment variability. Also update disk-benchmarks-aa.md to document this behavior.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add diskann-benchmark/AA_BENCHMARK.md documenting how the daily A/A benchmark stability test is conducted and scheduled.
Content Covered
Motivation
This makes it easier for new contributors and maintainers to understand how the A/A stability test works without having to read the YAML workflow directly.