Add documentation links to benchmark suite PR comments#8815
Draft
joseph-isaacs wants to merge 1 commit into
Draft
Add documentation links to benchmark suite PR comments#8815joseph-isaacs wants to merge 1 commit into
joseph-isaacs wants to merge 1 commit into
Conversation
joseph-isaacs
added
the
action/benchmark
github-actions
Bot
removed
the
action/benchmark
Contributor
Polar Signals Profiling ResultsLatest Run
Previous Runs (1)
Powered by Polar Signals Cloud |
Contributor
Benchmarks: Vortex queries 📖Verdict: No clear signal (low confidence) How to read Verdict and Engines
datafusion / vortex-file-compressed (1.036x ➖, 0↑ 0↓)
datafusion / parquet (0.960x ➖, 0↑ 0↓)
duckdb / vortex-file-compressed (1.010x ➖, 0↑ 0↓)
duckdb / parquet (1.005x ➖, 0↑ 0↓)
No file size changes detected. |
Contributor
Benchmarks: PolarSignals Profiling 📖Vortex (geomean): 0.889x ✅ How to read Verdict and Engines
datafusion / vortex-file-compressed (0.889x ✅, 5↑ 0↓)
No file size changes detected. |
Contributor
Benchmarks: FineWeb NVMe 📖Verdict: No clear signal (low confidence) How to read Verdict and Engines
datafusion / vortex-file-compressed (0.948x ➖, 2↑ 0↓)
datafusion / vortex-compact (0.960x ➖, 1↑ 0↓)
datafusion / parquet (0.963x ➖, 1↑ 0↓)
duckdb / vortex-file-compressed (0.949x ➖, 1↑ 0↓)
duckdb / vortex-compact (0.971x ➖, 0↑ 0↓)
duckdb / parquet (0.975x ➖, 0↑ 0↓)
No file size changes detected. |
Contributor
Benchmarks: TPC-H SF=1 on NVME 📖Verdict: No clear signal (environment too noisy confidence) How to read Verdict and Engines
datafusion / vortex-file-compressed (1.005x ➖, 0↑ 0↓)
datafusion / vortex-compact (0.994x ➖, 0↑ 0↓)
datafusion / parquet (0.989x ➖, 2↑ 1↓)
datafusion / arrow (0.988x ➖, 1↑ 1↓)
duckdb / vortex-file-compressed (0.994x ➖, 0↑ 0↓)
duckdb / vortex-compact (0.995x ➖, 0↑ 0↓)
duckdb / parquet (0.999x ➖, 2↑ 2↓)
duckdb / duckdb (0.991x ➖, 0↑ 0↓)
No file size changes detected. |
Contributor
Benchmarks: TPC-DS SF=1 on NVME 📖Verdict: No clear signal (low confidence) How to read Verdict and Engines
datafusion / vortex-file-compressed (0.987x ➖, 1↑ 1↓)
datafusion / vortex-compact (0.995x ➖, 0↑ 0↓)
datafusion / parquet (0.982x ➖, 0↑ 0↓)
duckdb / vortex-file-compressed (0.979x ➖, 4↑ 1↓)
duckdb / vortex-compact (0.993x ➖, 1↑ 2↓)
duckdb / parquet (0.996x ➖, 0↑ 1↓)
duckdb / duckdb (0.993x ➖, 0↑ 1↓)
No file size changes detected. |
Contributor
Benchmarks: FineWeb S3 📖Verdict: No clear signal (low confidence) How to read Verdict and Engines
datafusion / vortex-file-compressed (0.953x ➖, 0↑ 0↓)
datafusion / vortex-compact (0.928x ➖, 1↑ 0↓)
datafusion / parquet (0.981x ➖, 0↑ 0↓)
duckdb / vortex-file-compressed (0.970x ➖, 0↑ 0↓)
duckdb / vortex-compact (0.972x ➖, 0↑ 0↓)
duckdb / parquet (0.955x ➖, 0↑ 0↓)
|
Contributor
Benchmarks: Statistical and Population Genetics 📖Verdict: No clear signal (low confidence) How to read Verdict and Engines
duckdb / vortex-file-compressed (0.989x ➖, 0↑ 0↓)
duckdb / vortex-compact (0.999x ➖, 0↑ 0↓)
duckdb / parquet (0.986x ➖, 0↑ 0↓)
No file size changes detected. |
Contributor
Benchmarks: Clickbench Sorted on NVME 📖Verdict: No clear signal (low confidence) How to read Verdict and Engines
datafusion / vortex-file-compressed (1.101x ❌, 0↑ 5↓)
datafusion / parquet (1.071x ➖, 0↑ 3↓)
duckdb / vortex-file-compressed (1.058x ➖, 0↑ 1↓)
duckdb / parquet (1.003x ➖, 0↑ 0↓)
duckdb / duckdb (1.025x ➖, 0↑ 0↓)
File Size Changes (201 files changed, -0.0% overall, 98↑ 103↓)
Totals:
|
Contributor
Benchmarks: TPC-H SF=10 on NVME 📖Verdict: No clear signal (low confidence) How to read Verdict and Engines
datafusion / vortex-file-compressed (0.856x ✅, 21↑ 0↓)
datafusion / vortex-compact (0.889x ✅, 16↑ 0↓)
datafusion / parquet (0.885x ✅, 17↑ 0↓)
datafusion / arrow (0.826x ✅, 20↑ 0↓)
duckdb / vortex-file-compressed (0.903x ➖, 9↑ 0↓)
duckdb / vortex-compact (0.936x ➖, 1↑ 0↓)
duckdb / parquet (0.937x ➖, 0↑ 0↓)
duckdb / duckdb (0.942x ➖, 1↑ 0↓)
No file size changes detected. |
Contributor
Benchmarks: TPC-H SF=1 on S3 📖Verdict: No clear signal (low confidence) How to read Verdict and Engines
datafusion / vortex-file-compressed (0.885x ➖, 2↑ 0↓)
datafusion / vortex-compact (0.827x ➖, 4↑ 0↓)
datafusion / parquet (1.028x ➖, 0↑ 0↓)
duckdb / vortex-file-compressed (0.912x ➖, 0↑ 0↓)
duckdb / vortex-compact (0.939x ➖, 0↑ 0↓)
duckdb / parquet (0.933x ➖, 0↑ 0↓)
|
Contributor
Benchmarks: Clickbench on NVME 📖Verdict: No clear signal (low confidence) How to read Verdict and Engines
datafusion / vortex-file-compressed (0.986x ➖, 1↑ 1↓)
datafusion / parquet (0.976x ➖, 1↑ 0↓)
duckdb / vortex-file-compressed (1.001x ➖, 1↑ 2↓)
duckdb / parquet (0.996x ➖, 0↑ 0↓)
duckdb / duckdb (0.989x ➖, 0↑ 0↓)
File Size Changes (1 files changed, -0.0% overall, 0↑ 1↓)
Totals:
|
Contributor
Benchmarks: TPC-H SF=10 on S3 📖Verdict: No clear signal (environment too noisy confidence) How to read Verdict and Engines
datafusion / vortex-file-compressed (0.980x ➖, 0↑ 0↓)
datafusion / vortex-compact (0.988x ➖, 0↑ 0↓)
datafusion / parquet (1.014x ➖, 0↑ 0↓)
duckdb / vortex-file-compressed (1.004x ➖, 0↑ 0↓)
duckdb / vortex-compact (0.994x ➖, 0↑ 0↓)
duckdb / parquet (0.987x ➖, 0↑ 0↓)
|
Contributor
Benchmarks: Random Access 📖Vortex (geomean): 1.015x ➖ How to read Verdict and Engines
unknown / unknown (1.013x ➖, 1↑ 1↓)
|
Contributor
Benchmarks: Appian on NVME 📖Verdict: No clear signal (low confidence) How to read Verdict and Engines
datafusion / vortex-file-compressed (0.925x ➖, 1↑ 0↓)
datafusion / parquet (0.912x ➖, 1↑ 0↓)
duckdb / vortex-file-compressed (0.958x ➖, 0↑ 0↓)
duckdb / parquet (0.956x ➖, 0↑ 0↓)
duckdb / duckdb (0.928x ➖, 2↑ 0↓)
File Size Changes (1 files changed, -0.0% overall, 0↑ 1↓)
Totals:
|
Contributor
Benchmarks: Compression 📖Vortex (geomean): 0.999x ➖ How to read Verdict and Engines
unknown / unknown (1.002x ➖, 1↑ 1↓)
|
joseph-isaacs
added
the
action/benchmark-sql-full
github-actions
Bot
removed
the
action/benchmark-sql-full
Each "Benchmarks: <suite>" PR comment now carries a book icon link in its title pointing at a markdown explainer that lives next to the suite definition (vortex-bench/sql/* for SQL suites, benchmarks/* for the random-access and compression binaries). The doc path is a new "doc" field on each benchmark matrix entry, rendered into the comment title by the Compare results steps. Signed-off-by: Joe Isaacs <joe.isaacs@live.co.uk>
joseph-isaacs
force-pushed
the
claude/benchmark-explainers-links-rywc8y
branch
from
July 17, 2026 12:43
9b9a1d9 to
9c031e2
Compare
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
1 participant
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.
Rationale for this change
Benchmark PR comments are the primary way developers learn about performance regressions and understand what workloads are being tested. Currently, these comments lack context about what each benchmark measures, how to run it locally, or what queries/patterns it exercises.
This change adds documentation links to all benchmark suite PR comments, making it easier for developers to:
What changes are included in this PR?
Documentation files added:
vortex-bench/sql/clickbench.md- ClickBench web-analytics benchmark (43 queries, wide table scans, aggregations)vortex-bench/sql/vortex/README.md- Vortex queries microbenchmark (25M-row table, scan path optimization)vortex-bench/sql/statpopgen.md- Genomics analytics benchmark (variable-length lists, list encodings)vortex-bench/sql/tpch/README.md- TPC-H decision-support benchmark (22 queries, joins, aggregations)vortex-bench/sql/tpcds/README.md- TPC-DS decision-support benchmark (99 queries, wide schema)vortex-bench/sql/fineweb.md- String-heavy web-crawl benchmark (dictionary/FSST compression)vortex-bench/sql/polarsignals.md- Profiling stacktrace benchmark (sparse structs, nested data)vortex-bench/sql/appian/README.md- Business-application workload (selective filters, joins)benchmarks/random-access-bench/README.md- Point-lookup latency benchmark (correlated/uniform access)benchmarks/compress-bench/README.md- Compression throughput benchmark (multiple datasets)Each document includes:
Workflow changes:
.github/workflows/sql-benchmarks.ymlto adddocfield to all 11 benchmark suite definitions.github/workflows/bench-pr.ymlto adddocfield to random-access and compress benchmarks.github/workflows/bench.ymlto adddocfield to vortex-queries benchmark.github/workflows/sql-vortex-pr.ymlto adddocfield to vortex-queries benchmarkLicensing:
vortex-bench/REUSE.tomlto mark benchmark documentation as CC-BY-4.0What APIs are changed? Are there any user-facing changes?
No API changes. This is purely documentation and workflow configuration. The
docfield in benchmark suite definitions will be used by the benchmark result reporting infrastructure to link to these explainer documents in PR comments.https://claude.ai/code/session_01UyNKmfqVZaGDqhApenDtDu