kaira.benchmarks.BenchmarkSuite

Inheritance diagram of BenchmarkSuite

Inheritance diagram for BenchmarkSuite

class kaira.benchmarks.BenchmarkSuite(name: str, description: str = '')[source]

Bases: object

Collection of benchmarks that can be run together.

Methods

__init__

Initialize benchmark suite.

add_benchmark

Add a benchmark to the suite.

get_summary

Get summary statistics for all results.

run_all

Run all benchmarks in the suite.

save_results

Save all results to a directory.

__init__(name: str, description: str = '')[source]

Initialize benchmark suite.

Parameters:
  • name – Name of the benchmark suite

  • description – Description of the suite

add_benchmark(benchmark: BaseBenchmark) None[source]

Add a benchmark to the suite.

run_all(**kwargs) List[BenchmarkResult][source]

Run all benchmarks in the suite.

get_summary() Dict[str, Any][source]

Get summary statistics for all results.

save_results(directory: str | Path) None[source]

Save all results to a directory.