Skip to content

[REFAC]: Adding changelog + bench-scripts#16

Merged
SwayamInSync merged 2 commits into
mainfrom
release/1.5-extras
May 14, 2026
Merged

[REFAC]: Adding changelog + bench-scripts#16
SwayamInSync merged 2 commits into
mainfrom
release/1.5-extras

Conversation

@SwayamInSync
Copy link
Copy Markdown
Owner

@SwayamInSync SwayamInSync commented May 14, 2026

Three small follow-ups to #15 (the QBLAS 1.5.0 release). No code
changes; pure documentation/reproducibility plumbing.

What's in here

  1. bench/bench_quad_vs_numpy.py — the cross-dtype throughput
    harness that produced the numbers cited in release: QBLAS 1.5.0 compiled-library rewrite with runtime CPU dispatch #15 and in
    docs/perf_comparison_with_old.md. Reproduces the perf claims from
    a clean checkout:

    pip install numpy-quaddtype
    BENCH_THREADS=16 python bench/bench_quad_vs_numpy.py

    Same methodology as in the perf doc: 3 warmup + 9 timed samples,
    olympic-trimmed median, inner loop auto-calibrated to ≥ 50 ms per
    sample.

  2. CHANGELOG.md — seeded with a 1.5.0 entry covering Highlights,
    Added / Changed / Removed, and Known limitations (with cross-links
    into docs/performance_bottlenecks.md for the items on the post-1.5
    roadmap). Format: Keep a Changelog.

  3. Move perf docs into docs/. Top level previously had five .md
    files; now just the canonical three (README.md, CHANGELOG.md,
    CLAUDE.md). Reference material lives under docs/:

    docs/
      perf_comparison_with_old.md
      performance_bottlenecks.md
    

    All cross-references (in README, CHANGELOG, the bench harness, and
    the internal repro section of performance_bottlenecks.md itself)
    are updated.

bench/bench_quad_vs_numpy.py is the harness that produced the
quad-vs-f64 numbers in perf_comparison_with_old.md. It now lives in
tree so the perf claims are reproducible from a clean checkout.

CHANGELOG.md documents the 1.5.0 release (highlights, added/changed/
removed, known limitations) and seeds the format for future versions.
Top-level used to have five .md files (README, CHANGELOG, CLAUDE,
perf_comparison_with_old, performance_bottlenecks). Reference material
that the README links to belongs deeper. Moves both perf docs into
docs/; updates the cross-references in README, CHANGELOG, the bench
harness's docstring, and the internal repro-instructions inside
performance_bottlenecks.md.

Top level is now README + CHANGELOG + CLAUDE only — the conventional
three for an OSS project.
@SwayamInSync SwayamInSync changed the title post-release: check in bench harness + CHANGELOG.md post-release: bench harness, CHANGELOG, move perf docs into docs/ May 14, 2026
@SwayamInSync SwayamInSync changed the title post-release: bench harness, CHANGELOG, move perf docs into docs/ [REFAC]: Adding changelog + bench-scripts May 14, 2026
@SwayamInSync SwayamInSync merged commit 883fdb3 into main May 14, 2026
5 checks passed
@SwayamInSync SwayamInSync deleted the release/1.5-extras branch May 14, 2026 17:56
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.

1 participant