44 lines
2.4 KiB
Plaintext
44 lines
2.4 KiB
Plaintext
---
|
||
title: draw_zne_extrapolators (latest version)
|
||
description: API reference for qiskit_ibm_runtime.visualization.draw_zne_extrapolators in the latest version of qiskit-ibm-runtime
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: function
|
||
python_api_name: qiskit_ibm_runtime.visualization.draw_zne_extrapolators
|
||
---
|
||
|
||
<span id="qiskit-ibm-runtime-visualization-draw-zne-extrapolators" />
|
||
|
||
# qiskit\_ibm\_runtime.visualization.draw\_zne\_extrapolators
|
||
|
||
<Function id="qiskit_ibm_runtime.visualization.draw_zne_extrapolators" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.36/qiskit_ibm_runtime/visualization/draw_zne.py#L155-L271" signature="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. See [`ZneOptions`](options-zne-options "qiskit_ibm_runtime.options.ZneOptions") 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 of `indices`.
|
||
|
||
**Return type**
|
||
|
||
PlotlyFigure
|
||
</Function>
|
||
|