Skip to content

chore: re-cut as 0.0.1-alpha.1, and refresh the chart page from the results - #250

Merged
FBumann merged 1 commit into
mainfrom
chore/release-as-0-0-1
Jul 28, 2026
Merged

chore: re-cut as 0.0.1-alpha.1, and refresh the chart page from the results#250
FBumann merged 1 commit into
mainfrom
chore/release-as-0-0-1

Conversation

@FBumann

@FBumann FBumann commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

Two things.

The version. v0.1.0-alpha.1 was cut from #189 on a Release-As: footer
I proposed after telling Felix that 0.0.1-alpha was not a version this repo
could produce. That was wrong — Release-As: forces any version and
RELEASING.md documents it as lever 2 — so the choice got made from a menu that
was missing the wanted option. The tag and its GitHub release are deleted
(nothing had shipped: PUBLISH_TO_PYPI is unset, so that job skipped), the
manifest and CHANGELOG are reset to 0.0.0-alpha.33, and the footer here cuts
0.0.1-alpha.1 instead. Patch is 1 rather than 0, so the stream continues at
0.0.1-alpha.N rather than sitting in the absorbing state the config notes
describe.

bench/plot.py, 62 lines. docs/benchmarks-scaling.html was hand-built,
which made it numbers with no link to the run behind them — the failure
bench/README.md opens by describing. This rewrites exactly one line of the
page, the const DATA = {...}; literal, and touches nothing else.

Patching rather than templating is deliberate: the page is a tracked source
file whose prose carries the actual claims ("the bands do not overlap at any
rung" is an argument, not a rendering), and a template would move that into a
file nobody opens while burying every prose edit under a regenerated page.

Run against the committed results it reproduces the hand-built page byte for
byte, which is the only evidence the two ever agreed.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Updated benchmark instructions with separate size and density runs.
    • Added guidance for generating benchmark charts and refreshing scaling data.
    • Clarified which benchmark page content is generated versus manually reviewed.
  • Chores

    • Updated the package release version metadata.
    • Revised changelog entries to reflect the current release history.

…esults

Two things.

**The version.** `v0.1.0-alpha.1` was cut from #189 on a `Release-As:` footer
I proposed after telling Felix that `0.0.1-alpha` was not a version this repo
could produce. That was wrong — `Release-As:` forces any version and
RELEASING.md documents it as lever 2 — so the choice got made from a menu that
was missing the wanted option. The tag and its GitHub release are deleted
(nothing had shipped: `PUBLISH_TO_PYPI` is unset, so that job skipped), the
manifest and CHANGELOG are reset to `0.0.0-alpha.33`, and the footer here cuts
`0.0.1-alpha.1` instead. Patch is 1 rather than 0, so the stream continues at
`0.0.1-alpha.N` rather than sitting in the absorbing state the config notes
describe.

**`bench/plot.py`, 62 lines.** `docs/benchmarks-scaling.html` was hand-built,
which made it numbers with no link to the run behind them — the failure
`bench/README.md` opens by describing. This rewrites exactly one line of the
page, the `const DATA = {...};` literal, and touches nothing else.

Patching rather than templating is deliberate: the page is a tracked source
file whose prose carries the actual claims ("the bands do not overlap at any
rung" is an argument, not a rendering), and a template would move that into a
file nobody opens while burying every prose edit under a regenerated page.

Run against the committed results it reproduces the hand-built page byte for
byte, which is the only evidence the two ever agreed.

Release-As: 0.0.1-alpha.1
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The benchmark workflow now separates ladder and density runs, reports both datasets, and adds a plotting script that updates the scaling page. Release metadata changes adjust the package version and remove the prior changelog release section.

Changes

Benchmark plotting workflow

Layer / File(s) Summary
Plot data generation
bench/plot.py
Adds JSONL measurement aggregation, plot panel construction, missing-data validation, and replacement of the HTML const DATA literal.
Benchmark harness updates
bench/README.md
Documents separate ladder and density runs, combined reporting, plotting, and the single tracked HTML-line update.

Release metadata

Layer / File(s) Summary
Release version update
.release-please-manifest.json, CHANGELOG.md
Changes the root version to 0.0.0-alpha.33 and removes the 0.1.0-alpha.1 changelog section.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly reflects the release recut and benchmark chart refresh, which are the PR's main changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/release-as-0-0-1

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
bench/plot.py (1)

31-42: 📐 Maintainability & Code Quality | 🔵 Trivial | 🏗️ Heavy lift

Use precise types for the measurement tables.

dict[Any, Any] hides the tuple-key and numeric-value contract used by panel(), preventing Pyrefly from catching malformed records. Define typed aliases/TypedDicts and type the decoded timing records at the JSON boundary.

As per coding guidelines, **/*.py must use Pyrefly for type checking; fix types rather than widening them.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@bench/plot.py` around lines 31 - 42, The measurement tables in best currently
use dict[Any, Any], hiding their tuple-key and numeric-value contracts. Define
precise type aliases or TypedDicts for timing records and the wall, peak, and
cols tables, type the decoded JSON record at the boundary, and update best so
its return type and intermediate values are precise enough for panel() and
Pyrefly to validate malformed records.

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@bench/plot.py`:
- Around line 59-64: The benchmark input contract is inconsistent between the
plotting code and harness documentation. In bench/plot.py lines 59-64, update
the scaling input path and expected size/case keys to match the dataset produced
by the harness, or explicitly generate the required scaling dataset; in
bench/README.md lines 15-21, document and produce scaling.jsonl with dispatch
and xs–2xl entries, or change the plotting invocation to consume the density
dataset. Keep both sites aligned on the same contract.

---

Nitpick comments:
In `@bench/plot.py`:
- Around line 31-42: The measurement tables in best currently use dict[Any,
Any], hiding their tuple-key and numeric-value contracts. Define precise type
aliases or TypedDicts for timing records and the wall, peak, and cols tables,
type the decoded JSON record at the boundary, and update best so its return type
and intermediate values are precise enough for panel() and Pyrefly to validate
malformed records.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: c729b8eb-9799-4603-8aa5-41d6f59e4fa5

📥 Commits

Reviewing files that changed from the base of the PR and between 1193de8 and c8532dd.

📒 Files selected for processing (4)
  • .release-please-manifest.json
  • CHANGELOG.md
  • bench/README.md
  • bench/plot.py
💤 Files with no reviewable changes (1)
  • CHANGELOG.md

Comment thread bench/plot.py
Comment on lines +59 to +64
ladder = best(Path('bench/results/latest.jsonl'), 'highs')
scaling = best(Path('bench/results/scaling.jsonl'), 'lp')
cases = sorted({c for c, _, _ in ladder['wall']})
data = {
'scaling': panel(scaling, 'dispatch', SCALING, ('farkas', 'linopy', 'duckdb', 'duckdb@1GB')),
'cases': {c: panel(ladder, c, LADDER, ('farkas', 'linopy', 'duckdb')) for c in cases},

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟠 Major | 🏗️ Heavy lift

The benchmark producer and plotting consumer disagree on the input contract.

  • bench/plot.py#L59-L64: consume the file and size/case schema produced by the harness, or explicitly document and generate the required scaling run.
  • bench/README.md#L15-L21: produce scaling.jsonl with dispatch/xs2xl, or change the plotting invocation to match the density dataset.
📍 Affects 2 files
  • bench/plot.py#L59-L64 (this comment)
  • bench/README.md#L15-L21
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@bench/plot.py` around lines 59 - 64, The benchmark input contract is
inconsistent between the plotting code and harness documentation. In
bench/plot.py lines 59-64, update the scaling input path and expected size/case
keys to match the dataset produced by the harness, or explicitly generate the
required scaling dataset; in bench/README.md lines 15-21, document and produce
scaling.jsonl with dispatch and xs–2xl entries, or change the plotting
invocation to consume the density dataset. Keep both sites aligned on the same
contract.

@FBumann
FBumann merged commit f62d434 into main Jul 28, 2026
4 checks passed
@FBumann
FBumann deleted the chore/release-as-0-0-1 branch July 31, 2026 10:51
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