Skip to content

Migration Notes

This page records public-surface changes that matter when reproducing or comparing benchmark outputs across public releases.

1.0.2

Release 1.0.2 is the first PyPI-published stable package release. The public output contract remains 1.0.0; no schema, metric, manifest, or required-column changes were made.

1.0.1

Release 1.0.1 was an internal packaging-only release candidate for PyPI publication. The public output contract remains 1.0.0; no schema, metric, manifest, or required-column changes were made.

1.0.0

Release 1.0.0 promotes the release-candidate public surfaces to the stable public research release.

Versioning

  • Python package version: 1.0.0.
  • Git tag: v1.0.0.
  • Public output contract version: 1.0.0.

Public Output Contract

The required report and raw result-store files are unchanged from 0.9.0-rc1. The contract version was advanced to 1.0.0 to mark the stable public release.

Citation and Archival Status

v1.0.0 is citeable through CITATION.cff and the GitHub release. No DOI or archived benchmark result bundle is attached to this release; those can be added in a later archival release.

0.9.0rc1

Release candidate 0.9.0rc1 freezes the public result export contract for final review before v1.0.0.

Versioning

  • Python package version: 0.9.0rc1.
  • Git tag: v0.9.0-rc1.
  • Public output contract version: 0.9.0-rc1.

Public Output Contract

The required report and raw result-store files are unchanged from the public benchmark beta. The contract version was advanced from 0.3.0-beta to 0.9.0-rc1 to mark the release-candidate freeze review.

Downstream tooling should continue to use lrdbench.output_contract.PUBLIC_OUTPUT_CONTRACT or configs/contracts/public_output_contract.json as the authority for required files and columns. Dynamic metric__* and stratum__* columns remain data dependent.

Estimator Interface

The documented estimator entrypoint remains lrdbench.interfaces.BaseEstimator. Third-party estimators should return EstimateResult objects and report stable estimator names, versions, assumptions, diagnostics, and uncertainty support where available.

No estimator-interface rename is planned for v1.0.0.

Manifest Schema

The public manifest blocks used by the packaged smoke, public-small, and public-medium suites are the supported schema surface for the release candidate. Public comparisons should pin the manifest file, manifest_id, package version, and output contract version.

No manifest-field rename is planned for v1.0.0.

Reproducing Older Beta Outputs

When comparing outputs generated with 0.3.0-beta:

  • keep the original manifest/environment.json;
  • record the output contract version shown by lrdbench validate-output;
  • avoid mixing leaderboards generated by different package versions unless the comparison notes the package and contract versions explicitly.

The CSV names and required columns are intended to remain compatible between 0.3.0-beta and 0.9.0-rc1.