documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Gate error: Defined

Open zlatko-minev opened this issue 1 year ago • 11 comments

URL, if applicable

https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#properties

Describe the new content you are requesting.

In searching the documentation, and it appears to be challenging to find explicit information explaining the specific gate error metric reported for the backend properties in Qiskit. It is not explicitly mentioned whether the reported metric is related to RB Fidelity, average channel fidelity, entanglement fidelity, or another specific metric. Having this information would be valuable for theoreticians and users to better understand the quality and characteristics of the quantum device. It may be beneficial for the Qiskit documentation to specify the exact nature of the gate error metric for clarity and transparency.

For reference if useful, image

If this new content request is accepted, do you want to write the content?

I can help the team by providing enough information to write the material

zlatko-minev avatar Jan 17 '24 13:01 zlatko-minev

Thanks @zlatko-minev! To clarify: is this content you expect to be in the qiskit-ibm-runtime API docs, or in the non-API docs (somewhere in Start, build, transpile, verify, run)?

abbycross avatar Jan 17 '24 15:01 abbycross

I believe that this information is closely tied to the specific quantum provider and backend, and it would be best suited for inclusion in the runtime documentation. However, I don't have a strong preference regarding its placement; I simply believe it should be accessible somewhere within the documentation. It's worth noting that different quantum providers may opt to report different metrics of gate fidelity, so the choice of metric may be more provider-specific than fundamental to Qiskit Terra.

zlatko-minev avatar Jan 17 '24 20:01 zlatko-minev

If/when you add this content, we can add a link in the backend properties API doc to point to that.

jyu00 avatar Jan 31 '24 21:01 jyu00

good people to talk to about this issue: Andrew Wack and David McKay

javabster avatar Feb 13 '24 17:02 javabster

It's average gate fidelity; I figured that was noted somewhere but maybe it isn't

dcmckayibm avatar Apr 11 '24 22:04 dcmckayibm

maybe should be added here too https://docs.quantum.ibm.com/run/system-information

dcmckayibm avatar Apr 11 '24 22:04 dcmckayibm

@jyu00 which API docs need to reflect this clarification? I can open an issue in those repos.

@zlatko-minev @dcmckayibm would it be particularly useful to also clarify this on the detailed info for each system in the UI? For example, somewhere on the card below: Screenshot 2024-04-15 at 2 20 33 PM

abbycross avatar Apr 15 '24 18:04 abbycross

I think something like that little (i) next to processor type would make sense @francabrera

dcmckayibm avatar Apr 16 '24 00:04 dcmckayibm

@dcmckayibm would the (i) go on the ELPG number or elsewhere? I will open an issue for Fran in their repo.

abbycross avatar Apr 16 '24 15:04 abbycross

Beside median ECR error (in the example above) and median CZ error (for heron). EPLG already has a tooltip.

dcmckayibm avatar Apr 17 '24 00:04 dcmckayibm

Here is the issue for Fran's team: 5299 in the api repo (DM for the link) Please let me know if I missed any salient details!

In the meantime I am drafting for our docs the following:

Note that the metric for median ECR error (for Eagle processors) and median CZ error (for Heron processors) is the average gate fidelity, which is the average over all possible input states of the fidelity between the state produced by the actual operation and the state produced by the ideal operation.

This would go on the System information page, in an "Note" box.

abbycross avatar Apr 17 '24 21:04 abbycross

Done!

abbycross avatar Dec 19 '24 16:12 abbycross