Consolidate two similar pages (get-qpu-information and qpu-information) #4313

abbycross · 2025-11-25T21:29:58Z

Consolidate two files containing similar/overlapping content: Get backend information with Qiskit and QPU information.

@Eric-Arellano @frankharkins @arnaucasau FYI: when it is time to merge, can you please set up a redirect from qpu-information.mdx to get-qpu-information.ipynb?

Closes #4249

review-notebook-app · 2025-11-25T21:30:03Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

jyu00

Sorry if I reviewed too early... didn't realize it's still in draft!

docs/guides/get-qpu-information.ipynb

jyu00 · 2025-12-01T16:33:03Z

docs/guides/get-qpu-information.ipynb

-       " <IBMBackend('ibm_brisbane')>,\n",
       " <IBMBackend('ibm_fez')>,\n",
       " <IBMBackend('ibm_torino')>,\n",
       " <IBMBackend('ibm_marrakesh')>,\n",


I can't comment on the specific line, but the schemas linked in

Use these keyword arguments to filter by any attribute in backend configuration (JSON schema) or status (JSON schema).

are no longer valid. You can link to the runtime API instead - BackendConfiguration and BackendStatus

I actually can't parse that sentence! Can you tell me if this is an accurate rewrite? @jyu00

These JSON schemas list the keyword arguments to use when filtering by attribute.

Backend configuration JSON schema

Status JSON schema

I think we can just link those in the first sentence, since the code example already uses attributes from backend configuration (simulator=False) and status (operational=True).

Filter backends
You can also filter the available backends by their configuration or status. For more general filters, set the filters argument to a function that accepts a backend object and returns True if it meets your criteria. Refer to the API documentation for more details.

The following code returns only backends that fit these criteria and are available to you on your currently selected instance:
...
A similar method is QiskitRuntimeService.least_busy() ...

docs/guides/get-qpu-information.ipynb

docs/guides/qpu-information.ipynb

jyu00 · 2025-12-01T16:47:06Z

docs/guides/qpu-information.ipynb

+    "### Details section\n",
+    "\n",


All of these fields (with the exception of region) is also available in backend properties. This is why we wanted to merge these 2 pages together, since this is duplicate information.

Right - so do you want me to add to each field the code to get it programmatically (some of it is in the first half of the page)? Or just state more clearly in the Platform section of this page, that you can also use Qiskit to find all of these?

Perhaps this page can be organized so that each section first introduces the data, then explain how to get that data from Qiskit / IQP. It'd be nice if we can have clickable tabs to show Qiskit vs IQP.

For example, we can have these sections

Static QPU information

Dynamic QPU information

List and filter backends

And Static QPU information can say

Static QPU information

Some information about a backend does not change regularly, such as its name, version, the number of qubits it has, and the types of features it supports.

Native gates and operations

Each processor family has a native gate set. By default, the QPUs in each family only support running the gates and operations in the native gate set. Thus, every gate in the circuit must be translated (by the transpiler) to the elements of this set.

View with Qiskit | View on IQP (these are clickable tabs)

QPU versioning

...

And for the Dynamic QPU information section it'd just list out the attributes such as T1, T2, 2Q error, etc. Then clickable tabs to show how to find that data via Qiskit and IQP.

@jyu00 should I remove the headers "Qubit properties" and "Instruction properties", and just put them all together under Dynamic QPU info?

docs/guides/get-qpu-information.ipynb

jyu00 · 2025-12-16T21:25:45Z

docs/guides/qpu-information.ipynb

+    "\n",
+    "### QPU versioning\n",
+    "\n",
+    "Each QPU has a version number in the form X.Y.Z (major.minor.revision). A circuit compiled for a given version number is guaranteed to run on that QPU. If the revision number changes, the circuit will continue to run. If the major or minor number changes, the circuit is not guaranteed to run, although it may do so.\n",


A circuit compiled for a given version number is guaranteed to run on that QPU

I don't know if this statement is really true. For example, I'm not sure if the version number changed when we toggled dynamic circuits support. I'll ask in Jan when people are back.

docs/guides/qpu-information.ipynb

jyu00 · 2025-12-16T21:52:30Z

docs/guides/qpu-information.ipynb

+    "Each [processor family](/docs/guides/processor-types) has a native gate set. By default, the QPUs in each family only support running the gates and operations in the native gate set. Thus, every gate in the circuit must be translated (by the transpiler) to the elements of this set.\n",
+    "\n",
+    "You can view the native gates and supported instructions, including non-gate-type instructions, for a QPU with Qiskit. The IBM Quantum Platform Compute resources page lists the basis gates for a QPU.\n",


Personally I dislike the use of native gate set to also include non-gate-type operations. I think we should just say supported instructions to match the Qiskit method. Here's my suggestion

Every processor family natively supports a limited set of instructions. This set includes single- and two-qubit gates, as well as non-unitary operations such as measure and reset. Every gate in the circuit must be translated (by the transpiler) to the elements of a QPU's supported instruction set before it can run on the QPU.

You can view the supported instruction sets for a QPU with Qiskit. The IBM Quantum Platform Compute resources page lists only the supported unitary gates (basis gates) for a QPU.

In addition, this page should be updated to use the same wording. The use of basis gates there is different from the basis gates on IQP 😅

jyu00 · 2025-12-16T21:57:52Z

docs/guides/qpu-information.ipynb

+    "    from qiskit_ibm_runtime import QiskitRuntimeService\n",
+    "\n",
+    "    service = QiskitRuntimeService()\n",
+    "\n",
+    "    for backend in service.backends():\n",
+    "        config = backend.configuration()\n",
+    "        if \"simulator\" in config.backend_name:\n",
+    "            continue\n",
+    "        print(f\"Backend: {config.backend_name}\")\n",
+    "        print(f\"    Processor type: {config.processor_type}\")\n",
+    "        print(f\"    Supported instructions:\")\n",
+    "        for instruction in config.supported_instructions:\n",
+    "            print(f\"        {instruction}\")\n",
+    "        print()\n",
+    "    ```\n",


This code block should be simplified to

from qiskit_ibm_runtime import QiskitRuntimeService service = QiskitRuntimeService() backend = service.backend("ibm_fez") print(f"Backend: {backend.name}") print(f" Processor type: {backend.processor_type}") print(f" Supported instructions: {backend.supported_instructions}")

because (1) the old code loops through all backends, which is very slow and (2) you can extract backend information directly; no need to get its configuration.

jyu00 · 2025-12-16T22:03:15Z

docs/guides/qpu-information.ipynb

+    "\n",
+    "|  |  |\n",
+    "| --- | --- |\n",
+    "| **View with Qiskit** | `backend.properties().t1(qubit)` |\n",


jyu00 · 2025-12-16T22:05:09Z

docs/guides/qpu-information.ipynb

+    "|  |  |\n",
+    "| --- | --- |\n",
+    "| **View with Qiskit** | `backend.properties().t1(qubit)` |\n",
+    "| **View on IBM Quantum Platform** | Details section |\n",


I used "Details" section bc on the interface, the section is labeled "Details". Does that change how you want it labeled?

I added Qubit because this page has a lot of information, and it may not be obvious this is under the dropdown menu under Qubit:

Gotcha 👍

jyu00 · 2025-12-16T22:45:09Z

docs/guides/qpu-information.ipynb

+    "| **View with Qiskit** | `backend.properties().frequency(qubit)` |\n",
+    "| **View on IBM Quantum Platform** | Calibration data section, graph view  |\n",
+    "\n",
+    "#### `anharmonicity`\n",


I'll need to investigate more about frequency and anharmonicity, to see if they are no longer reported or is just broken in qiskit-ibm-runtime.

jyu00 · 2025-12-16T23:00:58Z

docs/guides/qpu-information.ipynb

+   "id": "67525443-070e-4798-99b3-72a599bf96c8",
+   "metadata": {},
+   "source": [
+    "### Instruction properties\n",


I know you're not done merging the pages, but instruction properties are also available on IQP - e.g. single qubit gate length under Qubit.

Similarly, everything available on IQP should be queryable from Qiskit.

Do all properties fit neatly under the two subheadings of "Instruction properties" and Qubit properties"? Or do we dispense with the subheaders and just list all properties in the Dynamic backend information section ?
Either way, I plan to do an in-page toc to easily jump to a property - as in what we do here in the current page:

Do all properties fit neatly under the two subheadings of "Instruction properties" and Qubit properties"?

Unfortunately no. But we can have a third "Additional information" (or some better name) for other backend data like total pending jobs and CLOPS.

I think it'd help dividing them into sections... even better if the sections can be collapsed 😄.

We will collapse them!
Other than CLOPS and total pending - what else falls under "Additional information"?

Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>

abbycross added 8 commits November 25, 2025 14:50

begin combining files

055b325

limit h level for in-page toc

e3d7e0d

reconfigure headers, add twisties

4ae63b6

wordsmith, rearrange

d693655

tox -e fix

9960780

update title again

81c27c9

rmv qpu-information file

200d660

Cleanup after deleting file

9bf9025

github-project-automation bot added this to Docs Planning Nov 25, 2025

github-actions bot had a problem deploying to pr_preview November 25, 2025 21:30 Failure

abbycross requested a review from jyu00 November 25, 2025 21:31

github-actions bot temporarily deployed to pr_preview November 25, 2025 22:19 Destroyed

rmv brisbane

c2151f2

github-actions bot deployed to pr_preview November 25, 2025 22:22 View deployment

abbycross changed the title ~~Ajc/consolidate qpu info~~ Consolidate two similar pages (get-qpu-information and qpu-information) Nov 26, 2025

jyu00 reviewed Dec 1, 2025

View reviewed changes

abbycross linked an issue Dec 5, 2025 that may be closed by this pull request

qpu-information and get-qpu-information #3671

Open

Merge branch 'main' into ajc/consolidate-qpu-info

15544f0

github-actions bot deployed to pr_preview December 8, 2025 17:25 View deployment

abbycross commented Dec 8, 2025

View reviewed changes

docs/guides/get-qpu-information.ipynb Outdated Show resolved Hide resolved

abbycross commented Dec 8, 2025

View reviewed changes

docs/guides/get-qpu-information.ipynb Outdated Show resolved Hide resolved

Apply suggestions from code review

34e9fed

github-actions bot deployed to pr_preview December 8, 2025 22:12 View deployment

abbycross added 3 commits December 8, 2025 17:22

link to calibration jobs page

25285d2

transition to qubit properties code examples

845e840

schema link update

282ac7b

github-actions bot deployed to pr_preview December 8, 2025 22:54 View deployment

tox -e fix

4fa3fdf

github-actions bot deployed to pr_preview December 8, 2025 23:00 View deployment

abbycross added 2 commits December 12, 2025 17:20

try to avoid merge conflict...

ef3ffe7

Merge branch 'main' into ajc/consolidate-qpu-info

e0ad5d2

github-actions bot deployed to pr_preview December 12, 2025 22:24 View deployment

work on tabbing page

915125a

github-actions bot deployed to pr_preview December 15, 2025 23:48 View deployment

fix checks

571b12c

github-actions bot deployed to pr_preview December 16, 2025 00:03 View deployment

fix missing variable

055372c

github-actions bot deployed to pr_preview December 16, 2025 00:17 View deployment

abbycross added 2 commits December 16, 2025 10:16

possible tables

f3e64a3

keep second table

97d5c4a

github-actions bot deployed to pr_preview December 16, 2025 15:17 View deployment

Combine List and Filter backends

f727ea7

github-actions bot deployed to pr_preview December 16, 2025 18:53 View deployment

use the CodeCellPlaceholder component

ca2b05a

github-actions bot deployed to pr_preview December 16, 2025 19:25 View deployment

Delete random cell, change 5 to 100

ef5d8d1

github-actions bot deployed to pr_preview December 16, 2025 19:34 View deployment

jyu00 reviewed Dec 16, 2025

View reviewed changes

eek

280dac5

Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>

github-actions bot deployed to pr_preview December 17, 2025 14:47 View deployment

	"\| View with Qiskit \| `backend.properties().t1(qubit)` \|\n",
	"\| View with Qiskit \| `backend.properties().t1(<qubit>)` \|\n",

	"\| View on IBM Quantum Platform \| Details section \|\n",
	"\| View on IBM Quantum Platform \| Qubits section in QPU detailed view\|\n",

Consolidate two similar pages (get-qpu-information and qpu-information) #4313

Are you sure you want to change the base?

Consolidate two similar pages (get-qpu-information and qpu-information) #4313

Uh oh!

Conversation

abbycross commented Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

review-notebook-app bot commented Nov 25, 2025

Uh oh!

jyu00 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Static QPU information

Native gates and operations

QPU versioning

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jyu00 Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

abbycross commented Nov 25, 2025 •

edited

Loading

jyu00 Dec 17, 2025 •

edited

Loading