iqm.benchmarks.benchmark.BenchmarkBase#

class iqm.benchmarks.benchmark.BenchmarkBase(backend: IQMBackendBase, configuration: BenchmarkConfigurationBase)#

Bases: ABC

The base implementation of all benchmarks, from which they inherit.

Methods

check_requirements(all_benchmarks)

Check whether the requirements for the benchmark are met, returning a valid benchmark dictionary.

execute_full_benchmark()

Execute the full benchmark on the given backend.

generate_requirements(all_benchmarks)

Generate the required attributes for execution.

name()

Return the name of the benchmark.

Parameters:
abstract classmethod name()#

Return the name of the benchmark.

abstract execute_full_benchmark()#

Execute the full benchmark on the given backend.

static check_requirements(all_benchmarks: OrderedDict[str, BenchmarkBase]) OrderedDict[str, BenchmarkBase]#

Check whether the requirements for the benchmark are met, returning a valid benchmark dictionary.

Parameters:

all_benchmarks (OrderedDict[str, BenchmarkBase]) –

Return type:

OrderedDict[str, BenchmarkBase]

generate_requirements(all_benchmarks: OrderedDict[str, BenchmarkBase]) None#

Generate the required attributes for execution.

Parameters:

all_benchmarks (OrderedDict[str, BenchmarkBase]) –

Return type:

None