energy-bench 0.1.30

Methods for benchmarking the energy consumption of programs.
docs.rs failed to build energy-bench-0.1.30
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build: energy-bench-0.1.12

Energy Benchmarking Tool

Tool for benchmarking the energy consumption of programs. Idle energy consumption and energy consumed by data generation are not included in the results. A new benchmark builder is created with EnergyBenchBuilder::new(). A benchmark of function bench_fn with data data_fn can be started with benchmark(name, data_fn, bench_fn). This function returns a JSON of measurement data.

Check out the energy-benchmarking-example project for a minimal example.

use energy_bench::EnergyTool;

let bench = EnergyBenchBuilder::new("benchmark name").build();

bench.benchmark("instance name", data_fn, bench_fn);

Some programs are too short-running to provide accurate energy measurement results. To avoid this, the benchmark can be repeated until a given amount of time has passed: with_min_measurement_duration. By default, benchmarks are run for at least 100ms.

let bench = EnergyBenchBuilder::new("benchmark name")
    .with_min_measurement_duration(Duration::from_secs(2))
    .build();