iqm.benchmarks.benchmark_definition.BenchmarkAnalysisResult

class iqm.benchmarks.benchmark_definition.BenchmarkAnalysisResult(dataset: ~xarray.core.dataset.Dataset, circuits: ~iqm.benchmarks.circuit_containers.Circuits | None = None, plots: dict[str, ~matplotlib.figure.Figure] = <factory>, observations: list[~iqm.benchmarks.benchmark_definition.BenchmarkObservation] = <factory>)

Bases: object

A dataclass storing the results of the analysis.

The result consists of a dataset, plots, and observations. Plots are defined as a dictionary that maps a plot name to a figure. Observations are key-value pairs of data that contain the main results of the benchmark.

Attributes

circuits
dataset
plots
observations

Methods

__eq__(other)	Return self==value.
__repr__()	Return repr(self).
from_run_result(run)	Creates a new AnalysisResult from a RunResult.
plot(plot_name)	Plots the given figure.
plot_all()	Plots all the figures defined for the analysis.

Parameters:

• dataset (Dataset) –

• circuits (Circuits | None) –

• plots (dict[str, Figure]) –

• observations (list[BenchmarkObservation]) –

plot(plot_name: str)

Plots the given figure.

Parameters:

plot_name (str) – Name of the figure to be plotted.

plot_all()

Plots all the figures defined for the analysis.

classmethod from_run_result(run: BenchmarkRunResult)

Creates a new AnalysisResult from a RunResult.

Parameters:

run (BenchmarkRunResult) – A run for which analysis result is created.