i}9SrSSKJr SSKJrJrJrJrJrJ r SSK J r SSK r SSKJr SSKJr SSKJrJr S S KJr \ (aSS KJr "S S 5r"SS5r"SS5rg)aZ ================================================================================== NoiseLearner result classes (:mod:`qiskit_ibm_runtime.utils.noise_learner_result`) ================================================================================== .. autosummary:: :toctree: ../stubs/ :nosignatures: PauliLindbladError LayerError ) annotations)AnyIteratorOptionalSequenceUnion TYPE_CHECKING)NDArrayN) BackendV2)QuantumCircuit) PauliListPauli) Embedding)Figurec|\rSrSrSrS Sjr\S Sj5r\SSj5r\SSj5r SSjr SSjr SS jr S r g )PauliLindbladError*uKA Pauli error channel generated by a Pauli Lindblad dissipators. This operator represents an N-qubit quantum error channel :math:`E(\rho) = e^{\sum_j r_j D_{P_j}}(\rho)` generated by Pauli Lindblad dissipators :math:`D_P(\rho) = P \rho P - \rho`, where :math:`P_j` are N-qubit :class:`~.Pauli` operators. The list of Pauli generator terms are stored as a :class:`~.PauliList` and can be accessed via the :attr:`~generators` attribute. The array of dissipator rates :math:`r_j` can be accessed via the :attr:`~rates` attribute. The equivalent Pauli error channel can be constructed as a composition of single-Pauli channel terms .. math:: E = e^{\sum_j r_j D_{P_j}} = \prod_j e^{r_j D_{P_j}} = prod_j \left( (1 - p_j) S_I + p_j S_{P_j} \right) where :math:`p_j = \frac12 - \frac12 e^{-2 r_j}` [1]. Args: generators: A list of the Pauli Lindblad generators for the error channel. rates: A list of the rates for the Pauli-Lindblad ``generators``. Raises: ValueError: If ``generators`` and ``rates`` have different lengths. References: 1. E. van den Berg, Z. Minev, A. Kandala, K. Temme, *Probabilistic error cancellation with sparse Pauli–Lindblad models on noisy quantum processors*, Nature Physics volume 19, pages1116–1121 (2023). `arXiv:2201.09866 [quant-ph] `_ cXl[R"U[S9Ul[ U54URR :wa/[S[ U5SURR S35eg)N)dtypez``generators`` has length z but ``rates`` has shape .) _generatorsnpasarrayfloat_rateslenshape ValueError)self generatorsratess g/home/james-whalen/.local/lib/python3.13/site-packages/qiskit_ibm_runtime/utils/noise_learner_result.py__init__PauliLindbladError.__init__Nsn%jje4  O !2!2 2,S_,=>++/;;+<+<*=Q@  3cUR$)zF The Pauli Lindblad generators of this :class:`~.PauliLindbladError`. )rr s r#r!PauliLindbladError.generatorsXs r&cUR$)z5 The Lindblad generator rates of this quantum error. )rr(s r#r"PauliLindbladError.rates_s {{r&c.URR$)z= The number of qubits in this :class:`~.PauliLindbladError`. )r! num_qubitsr(s r#r-PauliLindbladError.num_qubitsfs )))r&cUS:a [S5e[R"URRURR -SS9U:Hn[ URUURU5$)aT The :class:`~.PauliLindbladError` containing only those terms acting on exactly ``num_qubits`` qubits. Args: num_qubits: The number of qubits that the returned error acts on. Returns: The error containing only those terms acting on exactly ``num_qubits`` qubits. Raises: ValueError: If ``num_qubits`` is smaller than ``0``. rz'``num_qubits`` must be ``0`` or larger.)axis)rrsumr!xzrr")r r-masks r#restrict_num_bodies&PauliLindbladError.restrict_num_bodiesmsd >FG Gvvdoo''$//*;*;;!D R!$//$"7D9IJJr&c4URURS.$)PReturn a dictionary containing all the information to re-initialize this object.r!r"r:r(s r#_jsonPauliLindbladError._jsons"oo CCr&cXSURSURR5S3$)NzPauliLindbladError(generators=z, rates=))r!r"tolistr(s r#__repr__PauliLindbladError.__repr__s+//@IZIZI\H]]^__r&)rrN)r!r r"zSequence[float]returnNone)rBr )rBzNDArray[np.float64]rBint)r-rErBrrBdictrBstr)__name__ __module__ __qualname____firstlineno____doc__r$propertyr!r"r-r6r;r@__static_attributes__r&r#rr*s[!F   ** K&D`r&rcB\rSrSrSrSSSjjr\SSj5r\SSj5r\SSj5r \SSj5r SSS jjr SSS jjr SS jr SS jrS rg) LayerErroraThe error channel (in Pauli-Lindblad format) of a single layer of instructions. Args: circuit: A circuit whose noise has been learnt. qubits: The labels of the qubits in the ``circuit``. error: The Pauli Lindblad error channel affecting the ``circuit``, or ``None`` if the error channel is either unknown or explicitly disabled. Raises: ValueError: If ``circuit``, ``qubits``, and ``error`` have mismatching number of qubits. Nc*Xl[U5UlX0l[ S5n[ UR 5URR:waUeURb0[ UR 5URR:waUegg)NzMistmatching numbers of qubits.) _circuitlist_qubits_errorrrqubitscircuitr-error)r r[rZr\errs r#r$LayerError.__init__sv F|  :; t{{ t||66 6I :: !c$++&6$**:O:O&OI'P !r&cUR$)z, The circuit in this :class:`.~LayerError`. )rVr(s r#r[LayerError.circuits }}r&cUR$)z+ The qubits in this :class:`.~LayerError`. )rXr(s r#rZLayerError.qubitss ||r&cUR$)z} The error channel in this :class:`.~LayerError`, or ``None`` if the error channel is either unknown or explicitly disabled. )rYr(s r#r\LayerError.errors {{r&c,[UR5$)z5 The number of qubits in this :class:`~.LayerError`. )rrZr(s r#r-LayerError.num_qubitss 4;;r&c 0SSKJn U "UUUUUUUUUU U U S9 $)a Draw a map view of a this layer error. Args: embedding: An :class:`~.Embedding` object containing the coordinates and coupling map to draw the layer error on, or a backend to generate an :class:`~.Embedding` for. colorscale: The colorscale used to show the rates of this layer error. color_no_data: The color used for qubits and edges for which no data is available. color_out_of_scale: The color used for rates with value greater than ``highest_rate``. num_edge_segments: The number of equal-sized segments that edges are made of. edge_width: The line width of the edges in pixels. height: The height of the returned figure. highest_rate: The highest rate, used to normalize all other rates before choosing their colors. If ``None``, it defaults to the highest value found in the ``layer_error``. background_color: The background color. radius: The radius of the pie charts representing the qubits. width: The width of the returned figure. .. code:: python from qiskit import QuantumCircuit from qiskit.quantum_info import PauliList from qiskit_ibm_runtime.utils.embeddings import Embedding from qiskit_ibm_runtime.utils.noise_learner_result import LayerError, PauliLindbladError # A five-qubit 1-D embedding with nearest neighbouring connectivity coordinates1 = [(0, 0), (0, 1), (0, 2), (0, 3), (0, 4), (0, 5)] coupling_map1 = [(0, 1), (1, 2), (2, 3), (3, 4), (4, 5)] embedding1 = Embedding(coordinates1, coupling_map1) # A six-qubit horseshoe-shaped embedding with nearest neighbouring connectivity coordinates2 = [(0, 0), (0, 1), (0, 2), (1, 0), (1, 1), (1, 2)] coupling_map2 = [(0, 1), (1, 2), (0, 3), (3, 4), (4, 5)] embedding2 = Embedding(coordinates2, coupling_map2) # A LayerError object circuit = QuantumCircuit(4) qubits = [1, 2, 3, 4] generators = PauliList(["IIIX", "IIXI", "IXII", "YIII", "ZIII", "XXII", "ZZII"]) rates = [0.01, 0.01, 0.01, 0.005, 0.02, 0.01, 0.01] error = PauliLindbladError(generators, rates) layer_error = LayerError(circuit, qubits, error) # Draw the layer error on embedding1 layer_error.draw_map(embedding1) # Draw the layer error on embedding2 layer_error.draw_map(embedding2) r)draw_layer_error_map) layer_error embedding colorscale color_no_datacolor_out_of_scalenum_edge_segments edge_widthheight highest_ratebackground_colorradiuswidth) visualizationrh) r rjrkrlrmrnrorprqrrrsrtrhs r#draw_mapLayerError.draw_maps9B 9#!'1/!%-  r&c 4SSKJn U "U/UUUUUUUUU U U U S9 $)a Draw a swarm plot of the rates in this layer error. This function plots the rates along a vertical axes, offsetting the rates along the ``x`` axis so that they do not overlap with each other. .. note:: To draw multiple layer errors at once, consider calling :meth:`~qiskit_ibm_runtime.visualization.draw_layer_errors_swarm` directly. Args: num_bodies: The weight of the generators to include in the plot, or ``None`` if all the generators should be included. max_rate: The largest rate to include in the plot, or ``None`` if no upper limit should be set. min_rate: The smallest rate to include in the plot, or ``None`` if no lower limit should be set. connected: A list of generators whose markers are to be connected by lines. colors: A list of colors for the markers in the plot, or ``None`` if these colors are to be chosen automatically. num_bins: The number of bins to place the rates into when calculating the ``x``-axis offsets. opacities: A list of opacities for the markers. names: The names of the various layers as displayed in the legend. If ``None``, default names are assigned based on the layers' position inside the ``layer_errors`` list. x_coo: The ``x``-axis coordinates of the vertical axes that the markers are drawn around, or ``None`` if these axes should be placed at regular intervals. marker_size: The size of the marker in the plot. height: The height of the returned figure. width: The width of the returned figure. r)draw_layer_errors_swarm) layer_errors num_bodiesmax_ratemin_rate connectedcolorsnum_bins opacitiesnamesx_coo marker_sizerprt)rury)r r{r|r}r~rrrrrrrprtrys r# draw_swarmLayerError.draw_swarms>` <&!#  r&cJURURURS.$)r9r[rZr\rr(s r#r;LayerError._jsonWs<<4;;TTr&ctS[UR5SURSURS3nSUS3$)Nzcircuit=z , qubits=z, error=r>z LayerError()reprr[rZr\)r rets r#r@LayerError.__repr__[s>dll+,Idkk](4::,VWXSE##r&)rVrYrXN)r[r rZz Sequence[int]r\zOptional[PauliLindbladError]rBrC)rBr )rBz list[int])rBzUnion[PauliLindbladError, None]rD) Bluered lightgray lightgreenNwhiteg? )rjzUnion[Embedding, BackendV2]rkrIrlrIrmrIrnrErorrprErqOptional[float]rrrIrsrrtrErB PlotlyFigure) NNNNNNg?NNNrr)r{ Optional[int]r|rr}rr~z'Optional[Union[list[Pauli], list[str]]]rOptional[list[str]]rrrzUnion[float, list[float]]rrrzOptional[list[float]]rrrprErtrErBrrFrH)rJrKrLrMrNr$rOr[rZr\r-rvrr;r@rPrQr&r#rSrSs  /3 ,   "    $(".!#(, 'P .P P  P  P  P P P &P P P P  P h%)$($(=A&*"&/2%)'+'+@ !@ "@ " @ ; @ $ @  @ -@ #@ %@ %@ @ @  @ DU$r&rScv\rSrSrSrS S Sjjr\SSj5r\SSj5rSSjr SSjr SS jr SS jr S r g)NoiseLearnerResulti`z:A container for the results of a noise learner experiment.Ncd[U5UlUc0UlgUR5Ulg)z Args: data: The data of a noise learner experiment. metadata: Metadata that is common to all pub results; metadata specific to particular pubs should be placed in their metadata fields. Keys are expected to be strings. N)rW_datacopy _metadata)r datametadatas r#r$NoiseLearnerResult.__init__cs'$Z '/X]]_r&cUR$)z&The data of this noise learner result.)rr(s r#rNoiseLearnerResult.datamszzr&cUR$)z*The metadata of this noise learner result.)rr(s r#rNoiseLearnerResult.metadatars~~r&c URU$r)r)r indexs r# __getitem__NoiseLearnerResult.__getitem__wsyyr&c,[UR5$r)rrr(s r#__len__NoiseLearnerResult.__len__zs499~r&c<SURSURS3$)NzNoiseLearnerResult(data=z , metadata=r>)rrr(s r#r@NoiseLearnerResult.__repr__}s)$))K aPPr&c,[UR5$r)iterrr(s r#__iter__NoiseLearnerResult.__iter__sDIIr&)rrr)rzSequence[LayerError]rzdict[str, Any] | None)rBzlist[LayerError])rBzdict[str, Any])rrErBrSrDrH)rBzIterator[LayerError])rJrKrLrMrNr$rOrrrrr@rrPrQr&r#rr`sHDE Qr&r)rN __future__rtypingrrrrrr numpy.typingr numpyrqiskit.providers.backendr qiskit.circuitr qiskit.quantum_infor rutils.embeddingsrplotly.graph_objectsrrrrSrrQr&r#rsS #JJ .)0(;[`[`|U$U$p!!r&