logicsrc/docs/openstream/reports
Anthony Ettinger 9fda3973f6 docs: OpenStream benchmark report for nixamp 0.24.2
Manual publish of the report attached to the nixamp v0.24.2 release
(openstream-report-0.24.2.json/.md). The release workflow's
publish-report job skipped because LOGICSRC_PUBLISH_TOKEN is not set
on profullstack/nixamp. Built-in synthetic corpus, so the id carries
the -synthetic label per docs/openstream/reports/README.md.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015uheT4Gn9BBKAnSZGcabyN
2026-09-13 10:31:25 +00:00
..
2026-09-12-nixamp-0.17.1-synthetic.json docs: OpenStream benchmark reports, published per release (#150) 2026-09-12 06:23:46 -07:00
2026-09-12-nixamp-0.17.1-synthetic.md docs: OpenStream benchmark reports, published per release (#150) 2026-09-12 06:23:46 -07:00
2026-09-13-nixamp-0.24.2-synthetic.json docs: OpenStream benchmark report for nixamp 0.24.2 2026-09-13 10:31:25 +00:00
2026-09-13-nixamp-0.24.2-synthetic.md docs: OpenStream benchmark report for nixamp 0.24.2 2026-09-13 10:31:25 +00:00
README.md docs: OpenStream benchmark reports, published per release (#150) 2026-09-12 06:23:46 -07:00

OpenStream benchmark reports

Each file here is a reproducible run of the OpenStream benchmark: proof, on real hardware with recorded versions, that the envelope restores every byte, that an incompressible input costs only the framing overhead, that a compressible one saves what it claims against the complete wire size, and how long each codec takes. The site renders them at /docs/openstream/reports.

A report is two files sharing one id:

  • <id>.json — the machine-readable report (canonical). Its schema field is the version of the shape below.
  • <id>.md — the same run rendered for reading, shown on the site.

The id is YYYY-MM-DD-<implementation>-<version>[-<corpus>], for example 2026-09-12-nixamp-0.17.1-synthetic. Append the corpus label when the run used the built-in synthetic corpus rather than authorized real samples, so no one mistakes a padded-fixture number for a production one.

Publishing one

The reference implementation emits both files:

nixamp compression benchmark --out .

writes openstream-report.json and openstream-report.md. Rename them to the id, drop them in this directory, and open a pull request. The command exits non-zero if any codec that applied failed to restore byte-for-byte, so a report that would not build is caught before it is committed.

A report is published with every release of a reference implementation. The release step runs the benchmark, commits the two files here, and the site picks them up on its next deploy. Prefer a run over authorized real samples (--corpus DIR); a synthetic run is acceptable as a floor but is labelled as such and is not evidence of production savings.

What the numbers mean, and do not

OpenStream is a framing envelope over Zstandard and gzip, not a new compression algorithm. A report measures those codecs at the block boundary, framed honestly. Read the caveats array in every report: a synthetic padded transport stream saves about its padding share and says more about the padding than the codec; an efficient real feed saves little; timings are for the one machine named in environment. The one number that is a pass/fail rather than a measurement is round-trip exactness, and it must hold for every applicable codec on every sample.