Changed EfficientSU2 to efficient_su2 #2841

kaldag · 2025-03-24T07:49:06Z

No description provided.

qiskit-bot · 2025-03-24T07:49:10Z

Thanks for contributing to Qiskit documentation!

Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌

One or more of the following people are relevant to this code:

@ElePT
@abbycross
@beckykd
@cbjuan
@d-kremer
@jyu00
@kevinsung
@mtreinish
@nbronn

review-notebook-app · 2025-03-24T07:49:12Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

CLAassistant · 2025-03-24T07:49:13Z

All committers have signed the CLA.

kaldag · 2025-03-24T09:22:42Z

Fixes #2811
Fixes Qiskit/qiskit#14075

ShellyGarion

Hi @kaldag. thanks for your contribution.
My main comment is that you should try to locally run the code to see that it works.
for efficient_su2 the decompose() is no longer needed and there is no flatten parameter.

docs/api/qiskit/qiskit.circuit.library.RGate.mdx

ShellyGarion · 2025-03-24T13:28:49Z

docs/guides/ai-transpiler-passes.mdx

 from qiskit_ibm_transpiler.ai.routing import AIRouting

 ai_passmanager = PassManager([
  AIRouting(backend_name="ibm_sherbrooke", optimization_level=2, layout_mode="optimize", local_mode=True)
 ])

-circuit = EfficientSU2(101, entanglement="circular", reps=1).decompose()
+circuit = efficient_su2(101, entanglement="circular", reps=1).decompose()


decompose is not needed here

ShellyGarion · 2025-03-24T13:29:04Z

docs/guides/ai-transpiler-passes.mdx

@@ -84,7 +84,7 @@ ai_passmanager = PassManager([
  AIPauliNetworkSynthesis(backend_name="ibm_cairo", local_mode=False),  # Re-synthesize Pauli Network blocks. Only available in the Qiskit Transpiler Service
 ])

-circuit = EfficientSU2(10, entanglement="full", reps=1).decompose()
+circuit = efficient_su2(10, entanglement="full", reps=1).decompose()


decompose is not needed here.

ShellyGarion · 2025-03-24T13:30:03Z

docs/guides/ai-transpiler-passes.mdx

    from qiskit_ibm_runtime import QiskitRuntimeService

    backend = QiskitRuntimeService().backend("ibm_fez")
    fez_coupling_map = backend.coupling_map

-    su2_circuit = EfficientSU2(101, entanglement="circular", reps=1).decompose()
+    su2_circuit = efficient_su2(101, entanglement="circular", reps=1).decompose()


decompose is not needed here.

ShellyGarion · 2025-03-24T13:32:07Z

docs/guides/get-started-with-primitives.ipynb

    "\n",
-    "circuit = EfficientSU2(127, entanglement=\"linear\", flatten=True)\n",
+    "circuit = efficient_su2(127, entanglement=\"linear\", flatten=True)\n",


remove the flatten argument which does not exist.

ShellyGarion · 2025-03-24T13:32:22Z

docs/guides/qiskit-transpiler-service.mdx

    from qiskit_ibm_transpiler.transpiler_service import TranspilerService

-    circuit = EfficientSU2(101, entanglement="circular", reps=1).decompose()
+    circuit = efficient_su2(101, entanglement="circular", reps=1).decompose()


decompose is not needed.

ShellyGarion · 2025-03-24T13:32:35Z

docs/guides/qiskit-transpiler-service.mdx

    from qiskit_ibm_transpiler.transpiler_service import TranspilerService

-    circuit = EfficientSU2(101, entanglement="circular", reps=1).decompose()
+    circuit = efficient_su2(101, entanglement="circular", reps=1).decompose()


decompose is not needed

ShellyGarion · 2025-03-24T13:32:49Z

docs/guides/qiskit-transpiler-service.mdx

    from qiskit_ibm_transpiler.transpiler_service import TranspilerService

-    circuit = EfficientSU2(101, entanglement="circular", reps=1).decompose()
+    circuit = efficient_su2(101, entanglement="circular", reps=1).decompose()


decompose is not needed.

ShellyGarion · 2025-03-24T13:33:14Z

docs/guides/simulate-with-qiskit-aer.ipynb

@@ -47,7 +47,7 @@
  },
  {
   "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
   "id": "df70b5fd-971d-4e7d-a23a-8df037c0fa47",


why is this change needed here?

That was a mistake. Corrected.

ShellyGarion · 2025-03-24T13:35:53Z

docs/guides/represent-quantum-computers.ipynb

    "\n",
-    "qc = EfficientSU2(12, entanglement=\"circular\", reps=1)\n",
+    "qc = efficient_su2(12, entanglement=\"circular\", reps=1)\n",
    "\n",
    "qc.decompose().draw(\"mpl\")"


decompose is not needed here

ShellyGarion · 2025-03-24T13:36:13Z

docs/guides/simulate-stabilizer-circuits.ipynb

    "\n",
    "n_qubits = 8\n",
-    "circuit = EfficientSU2(n_qubits)\n",
+    "circuit = efficient_su2(n_qubits)\n",
    "circuit.decompose().draw(\"mpl\")"


decompose is not needed here

ShellyGarion · 2025-03-24T13:36:28Z

docs/guides/simulate-with-qiskit-aer.ipynb

    "\n",
    "n_qubits = 8\n",
-    "circuit = EfficientSU2(n_qubits)\n",
+    "circuit = efficient_su2(n_qubits)\n",
    "circuit.decompose().draw(\"mpl\")"


decompose is not needed here

ShellyGarion · 2025-03-24T13:37:08Z

docs/guides/simulate-with-qiskit-aer.ipynb

@@ -180,7 +180,7 @@
    "\n",
    "where $n$ is the number of qubits, in this case, 2. That is, with probability $p$, the state is replaced with the completely mixed state, and the state is preserved with probability $1 - p$. After $m$ applications of the depolarizing channel, the probability of the state being preserved would be $(1 - p)^m$. Therefore, we expect the probability of retaining the correct state at the end of the simulation to go down exponentially with the number of CX gates in our circuit.\n",
    "\n",
-    "Let's count the number of CX gates in our circuit and compute $(1 - p)^m$. Because our circuit uses the EfficientSU2 class, we'll need to call `decompose` once to decompose it into CX gates. We call `count_ops` to get a dictionary that maps gate names to counts, and retrieve the entry for the CX gate."
+    "Let's count the number of CX gates in our circuit and compute $(1 - p)^m$. Because our circuit uses the efficient_su2 class, we'll need to call `decompose` once to decompose it into CX gates. We call `count_ops` to get a dictionary that maps gate names to counts, and retrieve the entry for the CX gate."


no need to call decompose anymore

kaldag · 2025-03-24T15:23:33Z

Hi @kaldag. thanks for your contribution. My main comment is that you should try to locally run the code to see that it works. for efficient_su2 the decompose() is no longer needed and there is no flatten parameter.

Hi @ShellyGarion. Thank you for the response. I did try locally. I did not get error with decompose(), hence did not tamper with it. However, the 'flatten' parameter was overlooked, as you correctly pointed out. I have corrected all of them.

ShellyGarion · 2025-03-25T07:30:38Z

LGTM. I don't understand why the CI tests are failing

frankharkins · 2025-03-25T10:07:14Z

Thanks! The CI failure is not your fault, it's because we can't run that test on pull requests forks.

frankharkins

Thank you!

frankharkins · 2025-03-25T10:49:41Z

@kaldag thank you for making this PR and for signing the CLA. Could you please also link your committer email to your GitHub account so the CLA check passes? See instructions: #2841 (comment)

ShellyGarion · 2025-03-25T15:48:13Z

Hi @kaldag - thanks again for this PR, I already handled all the other notebooks in #2852 and #2848.
could you please handle the CLA so that we can merge this PR? thanks!

An action recently synced the latest dev docs. This PR updates all dev APIs that changed. > [!NOTE] > This pull request was created by a GitHub action. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

This PR makes three changes to the API generation script: - **Recognize C `typedef` and format as class** - **Do not use dedicated pages in C API** In Python APIs, if a class has the same name as the page name, the page will be a "dedicated page" for that class. This commit disables that for the C API. The C API pages are a grouping of structs and associated functions, rather than a class and its methods. This change reflects that in the information heirarchy. - **Fix TOC for C API** C does not have modules, so we can't group pages by module. This commit just lists all C API pages in the TOC.

Regenerates the C API from a new artifact generated from https://github.com/frankharkins/qiskit-terra/tree/FH/c-api-docs. I did not check in images from the release notes or the `objects.inv` files as they'll eventually be removed during the generation script.

kaldag · 2025-03-25T18:13:12Z

Hi @kaldag - thanks again for this PR, I already handled all the other notebooks in #2852 and #2848. could you please handle the CLA so that we can merge this PR? thanks!

Thank you. I have amended the author and email.

Eric-Arellano · 2025-03-25T18:15:33Z

Thanks, @kaldag, for signing the CLA!

It looks like this PR now has some merge conflicts. Feel free to either rebase or do a normal merge with main.

execution count had to changed in cell.

Execution count had to changed in cell code.

cell execution was changed.

Eric-Arellano · 2025-03-25T18:30:31Z

It looks like this PR now has some merge conflicts. Feel free to either rebase or do a normal merge with main.

The easiest approach might be an interactive rebase.

git fetch --all
git rebase -i upstream/main

In the rebase, you'll want to make sure the following commits don't show up because they are not relevant to your change and they are causing merge conflicts. This guide may be helpful: https://docs.github.com/en/get-started/using-git/about-git-rebase. Or there are lots of other good online tutorials on interactive rebases.

execution count had to changed in cell.

Execution count had to changed in cell code.

cell execution was changed.

Eric-Arellano · 2025-03-25T19:07:40Z

Thanks! @ShellyGarion @Cryoris can you please re-confirm that this PR looks good to double check that nothing was broken when dealing with the merge conflict? We will merge this after getting your confirmation.

ShellyGarion

Thanks for the contribution!
Looks good except one broken link, perhaps you can merge it now and I'll fix it in #2852?

ShellyGarion · 2025-03-26T07:20:05Z

docs/guides/represent-quantum-computers.ipynb

@@ -80,8 +80,7 @@
   "id": "4064b5ad-8a3a-462b-ae30-29576230c084",
   "metadata": {},
   "source": [
-    "The example circuit uses an instance of [`EfficientSU2`](/api/qiskit/qiskit.circuit.library.EfficientSU2#efficientsu2) from Qiskit's circuit library.\n",
-    "The following cell decomposes the circuit before drawing it to show its gate structure."
+    "The example circuit uses an instance of [`efficient_su2`](/api/qiskit/qiskit.circuit.library.EfficientSU2#efficientsu2) from Qiskit's circuit library."


the link should be api/qiskit/qiskit.circuit.library.efficient_su2

The link has been changed.

thanks, but it should be:
api/qiskit/qiskit.circuit.library.efficient_su2
and not:
api/qiskit/qiskit.circuit.library.efficientsu2

corrected the link.

link changed to /api/qiskit/qiskit.circuit.library.efficient_su2

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Frank Harkins <[email protected]>

github-project-automation bot added this to Docs Planning Mar 24, 2025

ShellyGarion suggested changes Mar 24, 2025

View reviewed changes

ShellyGarion reviewed Mar 24, 2025

View reviewed changes

kaldag force-pushed the kaldag_local branch from baafe8a to b53770a Compare March 24, 2025 14:00

ShellyGarion self-requested a review March 25, 2025 07:53

ShellyGarion approved these changes Mar 25, 2025

View reviewed changes

frankharkins approved these changes Mar 25, 2025

View reviewed changes

kaldag and others added 7 commits March 25, 2025 23:24

changed EfficientSU2 to efficient_su2

0f68007

changed EfficientSU2 to efficient_su2

8885871

changed EfficientSU2 to efficient_su2

3e0afe0

Update API dev docs (Qiskit#2831)

dff7469

An action recently synced the latest dev docs. This PR updates all dev APIs that changed. > [!NOTE] > This pull request was created by a GitHub action. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

corrections to efficient_su2

af8822a

kaldag force-pushed the kaldag_local branch from a8aa789 to af8822a Compare March 25, 2025 17:59

Update simulate-with-qiskit-aer.ipynb

17792ab

execution count had to changed in cell.

kaldag added 2 commits March 25, 2025 23:53

Update simulate-stabilizer-circuits.ipynb

42ff602

Execution count had to changed in cell code.

Update represent-quantum-computers.ipynb

af60760

cell execution was changed.

kaldag added 8 commits March 26, 2025 00:10

changed EfficientSU2 to efficient_su2

6986d76

changed EfficientSU2 to efficient_su2

0e68ed7

changed EfficientSU2 to efficient_su2

95ca982

corrections to efficient_su2

7dfca39

Update simulate-with-qiskit-aer.ipynb

6bc0539

execution count had to changed in cell.

Update simulate-stabilizer-circuits.ipynb

572ac8c

Execution count had to changed in cell code.

Update represent-quantum-computers.ipynb

e892b29

cell execution was changed.

updates

dafaf6d

ShellyGarion approved these changes Mar 26, 2025

View reviewed changes

kaldag added 2 commits March 26, 2025 13:58

Update represent-quantum-computers.ipynb

0619e49

corrected the link.

Update represent-quantum-computers.ipynb

62a46fe

link changed to /api/qiskit/qiskit.circuit.library.efficient_su2

ShellyGarion approved these changes Mar 26, 2025

View reviewed changes

ElePT enabled auto-merge March 26, 2025 09:05

ElePT added this pull request to the merge queue Mar 26, 2025

Merged via the queue into Qiskit:main with commit 78eaadc Mar 26, 2025
3 of 4 checks passed

github-project-automation bot moved this to Done in Docs Planning Mar 26, 2025

Changed EfficientSU2 to efficient_su2 #2841

Changed EfficientSU2 to efficient_su2 #2841

Conversation

kaldag commented Mar 24, 2025

qiskit-bot commented Mar 24, 2025

review-notebook-app bot commented Mar 24, 2025

CLAassistant commented Mar 24, 2025 • edited Loading

kaldag commented Mar 24, 2025

ShellyGarion left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kaldag commented Mar 24, 2025

ShellyGarion commented Mar 25, 2025 • edited Loading

frankharkins commented Mar 25, 2025

frankharkins left a comment

Choose a reason for hiding this comment

frankharkins commented Mar 25, 2025

ShellyGarion commented Mar 25, 2025

kaldag commented Mar 25, 2025

Eric-Arellano commented Mar 25, 2025

Eric-Arellano commented Mar 25, 2025

Eric-Arellano commented Mar 25, 2025

ShellyGarion left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CLAassistant commented Mar 24, 2025 •

edited

Loading

ShellyGarion commented Mar 25, 2025 •

edited

Loading