qiskit_ibm_runtime.visualization.draw_zne_extrapolators
draw_zne_extrapolators(result, indices=None, names=None, num_stds=1, max_mag=10, max_std=0.2, height=500, width=1000, colorscale='Aggrnyl')
Plot the zero noise extrapolation data in an EstimatorPubResult
.
This function generates a subfigure for each extrapolator.
Parameters
- result (EstimatorPubResult) – An
EstimatorPubResult
. - indices (Sequence[tuple[int, ...]] | None) – The indices of the expectation values to include in the plot. If
None
, includes all values. SeeZneOptions
for information on the indexing scheme. - names (Sequence[str] | None) – The names to assign to the expectation values. If
None
, the names correspond to the indices. - num_stds (int) – The number of standard deviations to include around each fit.
- max_mag (float) – The maximum magnitude of expectation values to include. If
evs_extrapolated
has a greater magnitude than this value, the expectation value is omitted from the plot. - max_std (float) – The maximum standard deviation to include. If
stds_extrapolated
is greater than this value for an expectation value and extrapolator, the fit is omitted from the plot. - height (int) – The height of the plot in pixels.
- width (int) – The width of the plot in pixels.
- colorscale (str) – The colorscale to use.
Returns
A plotly figure.
Raises
- ValueError – If
result
does not contain zero noise extrapolation data. - ValueError – If the length of
names
is not equal to the length ofindices
.
Return type
PlotlyFigure