RunRecord

report.RunRecord(
    created,
    seed_entropy,
    n_iterations,
    interventions,
    parameters,
    draw_sources=None,
    versions=_versions(),
    note='',
)

A reproducibility record for one analysis run.

Example

from heormodel.report import capture_run from heormodel.run import SeedManager rec = capture_run(seed=SeedManager(42), note=“demo”) rec.seed_entropy 42

Methods

Name	Description
from_json	Rebuild a record from to_json output.
to_json	Serialise to JSON; optionally also write it to path.
to_markdown	Render the record as a markdown run report.

from_json

report.RunRecord.from_json(text)

Rebuild a record from to_json output.

to_json

report.RunRecord.to_json(path=None)

Serialise to JSON; optionally also write it to path.

Example

from heormodel.report import capture_run ‘“note”: “x”’ in capture_run(note=“x”).to_json() True

to_markdown

report.RunRecord.to_markdown(title='Run report')

Render the record as a markdown run report.

Example

from heormodel.report import capture_run capture_run().to_markdown().startswith(“# Run report”) True