(datafusion) 01/01: chore: benchmarks compare.py documentation fixes (#24505)

[gi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

github-merge-queue[bot] pushed a commit to branch gh-readonly-queue/main/pr-24505-97ba4c9fcedd8e834cfede687d9add19175901dc
in repository https://gitbox.apache.org/repos/asf/datafusion.git

commit 16ec8e0c79462a58e49d1b1b4f7f938691c13296
Author: Adam Reeve <ad...@gr-oss.io>
AuthorDate: Thu Aug 20 02:57:44 2026 +0000

    chore: benchmarks compare.py documentation fixes (#24505)
    
    ## Which issue does this PR close?
    
    No issue, this is a minor change and not user-facing.
    
    ## Rationale for this change
    
    Help developers run benchmarks without getting distracted by errors and
    trying commands that no longer work.
    
    ## What changes are included in this PR?
    
    Updates documentation for `compare.py` to account for the switch to uv
    (#20414) and fixes a crash when getting the help test (running with
    `--help`).
    
    ## Are these changes tested?
    
    Yes, I've run the script.
    
    ## Are there any user-facing changes?
    
    No.
---
 benchmarks/README.md  | 2 +-
 benchmarks/compare.py | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/benchmarks/README.md b/benchmarks/README.md
index f357ff4da5..489f2d485a 100644
--- a/benchmarks/README.md
+++ b/benchmarks/README.md
@@ -294,7 +294,7 @@ $ mkdir -p /tmp/output_branch
 $ git checkout my_branch
 $ cargo run --release --bin tpch -- benchmark datafusion --iterations 5 --path ./data --format parquet -o /tmp/output_branch/tpch.json
 # compare the results:
-./compare.py /tmp/output_main/tpch.json  /tmp/output_branch/tpch.json
+uv run ./compare.py /tmp/output_main/tpch.json  /tmp/output_branch/tpch.json
 ```
 
 This will produce output like:
diff --git a/benchmarks/compare.py b/benchmarks/compare.py
index 9ad1de980a..0fb8f4598f 100755
--- a/benchmarks/compare.py
+++ b/benchmarks/compare.py
@@ -30,7 +30,7 @@ try:
     from rich.console import Console
     from rich.table import Table
 except ImportError:
-    print("Couldn't import modules -- run `./bench.sh venv` first")
+    print("Couldn't import modules -- run with uv (`uv run compare.py`)")
     raise
 
 
@@ -258,7 +258,7 @@ def main() -> None:
         "--noise-threshold",
         type=float,
         default=0.05,
-        help="The threshold for statistically insignificant results (+/- %5).",
+        help="The threshold for statistically insignificant results (+/- 5%%).",
     )
     compare_parser.add_argument(
         "--detailed",


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org