Example Stats Error Bands

"""Auto-generated example: Error Bands: mean +/- std deviation on a 1D sweep with 10 repeats."""

import bencher as bn
from bencher.example.meta.example_meta import BenchableObject


def example_stats_error_bands(run_cfg: bn.BenchRunCfg | None = None) -> bn.Bench:
    """Error Bands: mean +/- std deviation on a 1D sweep with 10 repeats."""
    bench = BenchableObject().to_bench(run_cfg)
    bench.plot_sweep(input_vars=["float1"], result_vars=["distance", "sample_noise"], const_vars=dict(noise_scale=0.3))

    return bench


if __name__ == "__main__":
    bn.run(example_stats_error_bands, subsampling_divisions=4, repeats=10)