[sc-63358] How to use Qiskit 1.0 with PennyLane #1104

isaacdevlugt · 2024-05-15T20:15:25Z

Title: How to use Qiskit 1.0 with PL

Shortcut: https://app.shortcut.com/xanaduai/story/63358/how-to-how-to-use-qiskit-1-0-with-pennylane

github-actions · 2024-05-15T20:15:44Z

👋 Hey, looks like you've updated some demos!

🐘 Don't forget to update the dateOfLastModification in the associated metadata files so your changes are reflected in Glass Onion (search and recommendations).

Please hide this comment once the field(s) are updated. Thanks!

demonstrations/tutorial_how_to_use_qiskit1.0_with_pennylane.py

demonstrations/tutorial_how_to_use_qiskit1.0_with_pennylane.metadata.json

g

demonstrations/how_to_use_qiskit1.0_with_pennylane.metadata.json

demonstrations/how_to_use_qiskit1.0_with_pennylane.py

github-actions · 2024-05-15T22:04:00Z

Thank you for opening this pull request.

You can find the built site at this link.

Deployment Info:

Pull Request ID: 1104
Deployment SHA: 15c97a8dbf17e875c61cb4fff74f82ccf3660985
(The Deployment SHA refers to the latest commit hash the docs were built from)

Note: It may take several minutes for updates to this pull request to be reflected on the deployed site.

co9olguy · 2024-06-07T20:58:42Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+# You’ll notice, too, that ``pl_func`` has the call signature that you would expect:
+# ``pl_qfunc(phis, theta)``, just like the name we gave them when we defined them in Qiskit
+# (``ParameterVector("phis", n-1)`` and ``Parameter("theta")``).


Love it, thanks for highlighting this

…b.com/PennyLaneAI/qml into tutorial-use-qiskit1.0-with-pennylane

isaacdevlugt · 2024-06-13T16:37:11Z

demonstrations/how_to_use_qiskit1_with_pennylane.metadata.json

+ "previewImages": [
+ {
+ "type": "thumbnail",
+ "uri": "/_static/demonstration_assets/regular_demo_thumbnails/thumbnail_variationally_quantum_thermalizer.png"


Just putting a note here to change this when the image is ready

isaacdevlugt · 2024-06-13T20:21:20Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+qc = QuantumCircuit(2, 1)
+
+qc.h(0)
+qc.cx(0, 1)
+qc.measure(1, 0)
+
+sampler = Sampler(options={"shots": 1024})
+print(sampler.run(qc).result())


@austingmhuang with my example below using qiskit.basicsim, should I be using BasicProvider here instead? (https://docs.quantum.ibm.com/api/qiskit/providers_basic_provider)

I would use BasicProvider here instead.

The Sampler you're importing here from qiskit.primitives is SamplerV1, and there's no particular backend specified (In this case it's a statevector simulator I think). Whereas for qiskit.basicsim we are specifically getting backend = BasicProvider().get_backend('basic_simulator') and running the device using said backend. So it would be a little confusing.

For reference on our side, we don't import Sampler from qiskit.primitives, but from qiskit_ibm_runtime as per https://docs.quantum.ibm.com/api/migration-guides/v2-primitives.

Another thing to note is that sampler.run(qc).result()) gives SamplerResult(quasi_dists=[{0: 0.5234375, 1: 0.4765625}], metadata=[{'shots': 1024}]), which is quite different, format wise, from what we get from PL [0.50488281 0.49511719]

Maybe you can try qml.expval() instead? Or format the answer so it matches a bit better.

austingmhuang · 2024-06-13T21:12:31Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+from qiskit.primitives import Estimator
+
+estimator = Estimator()
+
+job = estimator.run([qc] * len(operators), operators)
+result = job.result()
+print(result)


Just fyi this is using EstimatorV1 and EstimatorV1 syntax.

austingmhuang · 2024-06-13T21:18:07Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+opt = qml.AdamOptimizer(0.1)
+
+for i in range(100):
+ (phis, theta), new_loss = opt.step_and_cost(cost, phis, theta)
+
+print(f"Optimized parameters: phis = {phis}, theta = {theta}")
+print(f"Optimized cost function value: {new_loss}")


This is a great example.

It would be great if we get the new qiskit device merged into master then we can update this to use the qiskit_session context manager so that a real user knows they don't have to wait and queue for each iteration of the optimizer.

@isaacdevlugt It would also be nice to know that this actually works with our qiskit_session context manager... if you have time, could you checkout new_device_feature_branch and try running this code with the qiskit_session? You might have to use real hardware though (not sure). If not I can always find time to try this out myself though 😅 .

austingmhuang

Nice work @isaacdevlugt!
Just a general comment but I'd just like to highlight something that is distinctly neat about using PL over using Qiskit: You don't need to swap between Estimator and Sampler in order to get what you want.

E.g. in Qiskit if you had some circuit and you wanted both the expectation value and the counts (admittedly, this is a bit of a contrived example), you would need to initialize Estimator and Sampler, and then write a lot of repeated, syntactically complicated code (e.g. expval = estimator.run()[0].data.evs anyone?) to do so. In Pennylane? Easy as return qml.expval(obs), qml.counts(obs). Syntactic sugar like this is always nice IMO.

I wouldn't go out of my way to make a statement pointing this out, because the tone that's best is one that's friendly and helpful -- not combative. But I think there is room to select an example where we can subtly showcase the difference in # of lines of code and how clean it is in comparison i.e. just write the code and let the code speak for itself. All this to say, an example where a user would have to initialize and use both the estimator and the sampler would be a good example to highlight a nice feature about the plugin and PL in general.

josh146

Thanks @isaacdevlugt, this is looking great! I've left a (conditional) approval, conditional on my review comments.

Something to note: This is another case where this should probably be two how-tos (and your intro somewhat backs this up!):

How to execute PennyLane workflows using IBM and Qiskit devices
How to convert your existing Qiskit code to PennyLane

I'm happy for it to be merged as is (I think it is a massive net benefit for readers overall!), but would have suggested the above instead if we had discussed earlier.

josh146 · 2024-06-14T15:12:00Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+Amazon Braket — you name it!
+
+With the first stable release of Qiskit in February 2024 (Qiskit 1.0), we subsequently shipped some
+excellent features and upgrades with the PennyLane-Qiskit plugin, allowing users familiar with


Suggested change

excellent features and upgrades with the PennyLane-Qiskit plugin, allowing users familiar with

excellent features and upgrades with the PennyLane-Qiskit plugin, allowing

anyone familiar with

This is mostly just personal preference, but I prefer not to use 'user' in content and documentation, as it can feel a bit impersonal. Rather, we can speak directly to the reader!

josh146 · 2024-06-14T15:13:23Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+On that note of IBM hardware, the PennyLane-Qiskit plugin enables you to integrate your existing
+Qiskit code and run circuits on IBM devices with PennyLane, encompassing two real-world scenarios:
+(1) working in PennyLane from the start and executing your work on an IBM device and (2) converting
+your existing Qiskit code to PennyLane and executing that on *any* device, including IBM devices,
+Amazon Braket — you name it!


😉 I think you know what I'm going to say here (will leave it for the review comment lol)

josh146 · 2024-06-14T15:14:12Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+
+One of PennyLane’s claims to fame is that it’s *hardware agnostic*; PennyLane doesn’t care about
+what you want to execute quantum circuits on. This is made possible by our `plugin
+suite <https://pennylane.ai/plugins/#plugins>`__, which contains several plugins that are maintained


Suggested change

suite <https://pennylane.ai/plugins/#plugins>`__, which contains several plugins that are maintained

suite <https://pennylane.ai/plugins/#plugins>`__, which provide additional simulator and hardware devices and other functionality that are maintained

josh146 · 2024-06-14T15:16:58Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+# If you want to distill how a PennyLane plugin works down to one thing, it’s all in the devices! In
+# PennyLane, you just create your circuit (a quantum function) and decorate it with
+# ``@qml.qnode(dev)``, where ``dev`` is (one of) a plugin’s device(s). In PennyLane and its plugins,
+# devices are called upon by their short name: ``qml.device("shortname", ...)``. If you’ve
+# seen PennyLane code before, you’ve probably seen ``"default.qubit"`` or ``"lightning.qubit"`` as
+# short names for our Python and C++ statevector simulators, respectively.


Suggested change

# If you want to distill how a PennyLane plugin works down to one thing, it’s all in the devices! In

# PennyLane, you just create your circuit (a quantum function) and decorate it with

# ``@qml.qnode(dev)``, where ``dev`` is (one of) a plugin’s device(s). In PennyLane and its plugins,

# devices are called upon by their short name: ``qml.device("shortname", ...)``. If you’ve

# seen PennyLane code before, you’ve probably seen ``"default.qubit"`` or ``"lightning.qubit"`` as

# short names for our Python and C++ statevector simulators, respectively.

# If you want to distill how a PennyLane plugin works down to one thing, it’s all in the provided devices! In

# PennyLane, you just :doc:`create your circuit (a quantum function) </introduction/circuits>` and decorate it with

# the QNode decorator :func:`@qml.qnode(dev) <~.qnode>`, where ``dev`` is (one of) a plugin’s device(s).

#

# In PennyLane and its plugins,

# devices are called upon by their short name, and can be loaded via the :func:`~.device` function:

#

# .. code-block:: python

#

# qml.device("shortname", *device_options)

#

# If you’ve

# seen PennyLane code before, you’ve probably seen ``"default.qubit"`` or ``"lightning.qubit"`` as

# short names for our Python and C++ statevector simulators, respectively.

A couple of things here:

Inserted a space between paragraphs for legibility

Always good practice to cross reference the docstring if users want to see more details!

'display' codeblocks can help emphasize the usage (similar to display mathmode)

It's also always good to link to other content. E.g., you could finish this paragraph with 'If you would like to read more about how to use PL and devices, see '.

josh146 · 2024-06-14T15:19:44Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+# In the PennyLane-Qiskit plugin, there are `several Qiskit
+# devices <https://docs.pennylane.ai/projects/qiskit/en/stable/#devices>`__ you can use, but here are


Suggested change

# In the PennyLane-Qiskit plugin, there are `several Qiskit

# devices <https://docs.pennylane.ai/projects/qiskit/en/stable/#devices>`__ you can use, but here are

# In the PennyLane-Qiskit plugin, there are `several IBM

# devices <https://docs.pennylane.ai/projects/qiskit/en/stable/#devices>`__ you can use, but here are

josh146 · 2024-06-14T15:23:23Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+# Next, we convert the Qiskit ``QuantumCircuit``, ``qc``, to PennyLane with ``qml.from_qiskit``. We
+# can append the measurements — expectation values (``qml.expval``) of ``pl_operators`` — with the
+# ``measurements`` keyword argument, which accepts a list of PennyLane measurements.


same here with cross referencing :)

josh146 · 2024-06-14T15:23:37Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+# What’s really useful about being able to append measurements to the end of a circuit with
+# ``qml.from_qiskit`` is being able to measure something that isn’t available in Qiskit 1.0 but is
+# available in PennyLane, like the classical shadow measurement protocol, for example. In PennyLane,
+# you can measure this with ``qml.classical_shadow``.


cross referencing

josh146 · 2024-06-14T15:24:25Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+######################################################################
+# .. figure:: ../_static/demonstration_assets/how_to_use_qiskit_1_with_pennylane/qiskit_parameterized_circuit.png
+# :align: center
+# :width: 70%


@isaacdevlugt this figure is very large, can we reduce the size?

josh146 · 2024-06-14T15:25:08Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+# :align: center
+# :width: 70%


Suggested change

# :align: center

# :width: 70%

# :align: left

# :width: 20%

josh146 · 2024-06-14T15:26:52Z

demonstrations/how_to_use_qiskit1_with_pennylane.py

+# `plugin homepage <https://docs.pennylane.ai/projects/qiskit/en/stable/>`__. In the upcoming v0.37 release,
+# we’ll be refreshing our integration with Qiskit 1.0 `runtimes <https://cloud.ibm.com/quantum>`__ and
+# `primitives <https://docs.quantum.ibm.com/api/qiskit/primitives>`__, so stay tuned for that! In the


Suggested change

# `plugin homepage <https://docs.pennylane.ai/projects/qiskit/en/stable/>`__. In the upcoming v0.37 release,

# we’ll be refreshing our integration with Qiskit 1.0 `runtimes <https://cloud.ibm.com/quantum>`__ and

# `primitives <https://docs.quantum.ibm.com/api/qiskit/primitives>`__, so stay tuned for that! In the

# `plugin homepage <https://docs.pennylane.ai/projects/qiskit/en/stable/>`__. In the

Demos are 'time invariant', so we avoid having content that would make it feel out of date accidentally :) So I would remove this here (although this would make much more sense in a blog post).

initial

97f873c

isaacdevlugt changed the title ~~initial~~ How to use Qiskit 1.0 with PennyLane May 15, 2024

isaacdevlugt commented May 15, 2024

View reviewed changes

demonstrations/tutorial_how_to_use_qiskit1.0_with_pennylane.py Outdated Show resolved Hide resolved

meta data

a0c2fc8

isaacdevlugt commented May 15, 2024

View reviewed changes

demonstrations/tutorial_how_to_use_qiskit1.0_with_pennylane.metadata.json Outdated Show resolved Hide resolved

isaacdevlugt commented May 15, 2024

View reviewed changes

demonstrations/tutorial_how_to_use_qiskit1.0_with_pennylane.metadata.json Outdated Show resolved Hide resolved

isaacdevlugt commented May 15, 2024

View reviewed changes

demonstrations/tutorial_how_to_use_qiskit1.0_with_pennylane.metadata.json Outdated Show resolved Hide resolved

isaacdevlugt added 2 commits May 15, 2024 17:11

bypass CI

25c795b

minor:

b072b0d

g

isaacdevlugt commented May 15, 2024

View reviewed changes

demonstrations/how_to_use_qiskit1.0_with_pennylane.metadata.json Outdated Show resolved Hide resolved

isaacdevlugt commented May 15, 2024

View reviewed changes

demonstrations/how_to_use_qiskit1.0_with_pennylane.metadata.json Outdated Show resolved Hide resolved

isaacdevlugt commented May 15, 2024

View reviewed changes

demonstrations/how_to_use_qiskit1.0_with_pennylane.py Outdated Show resolved Hide resolved

let's try this

d905e47

github-actions bot deployed to preview May 15, 2024 21:59 View deployment

isaacdevlugt and others added 3 commits June 4, 2024 13:14

new demo

b1d64c0

formatting

3cb7fa7

Merge branch 'master' into tutorial-use-qiskit1.0-with-pennylane

cea75e8

github-actions bot deployed to preview June 4, 2024 17:28 View deployment

removed code output blocks because of formatting

1dcf16d

github-actions bot deployed to preview June 4, 2024 17:56 View deployment

tesT

feb8f66

github-actions bot deployed to preview June 5, 2024 21:33 View deployment

minor

0de0c10

github-actions bot deployed to preview June 5, 2024 21:49 View deployment

co9olguy reviewed Jun 7, 2024

View reviewed changes

isaacdevlugt changed the title ~~How to use Qiskit 1.0 with PennyLane~~ [sc-63358] How to use Qiskit 1.0 with PennyLane Jun 12, 2024

Merge branch 'master' into tutorial-use-qiskit1.0-with-pennylane

4a70acf

github-actions bot deployed to preview June 12, 2024 16:36 View deployment

isaacdevlugt and others added 3 commits June 13, 2024 12:36

minor changes

4e31014

Merge branch 'tutorial-use-qiskit1.0-with-pennylane' of https://githu…

e5077db

…b.com/PennyLaneAI/qml into tutorial-use-qiskit1.0-with-pennylane

Merge branch 'master' into tutorial-use-qiskit1.0-with-pennylane

f94f0c6

isaacdevlugt commented Jun 13, 2024

View reviewed changes

isaacdevlugt added 2 commits June 13, 2024 12:38

minor

0565f8b

minor

15c97a8

github-actions bot deployed to preview June 13, 2024 16:48 View deployment

isaacdevlugt requested review from josh146, soranjh and austingmhuang June 13, 2024 20:17

isaacdevlugt commented Jun 13, 2024

View reviewed changes

austingmhuang reviewed Jun 13, 2024

View reviewed changes

josh146 approved these changes Jun 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[sc-63358] How to use Qiskit 1.0 with PennyLane #1104

[sc-63358] How to use Qiskit 1.0 with PennyLane #1104

isaacdevlugt commented May 15, 2024 •

edited

github-actions bot commented May 15, 2024

github-actions bot commented May 15, 2024 •

edited

co9olguy Jun 7, 2024

isaacdevlugt Jun 13, 2024

isaacdevlugt Jun 13, 2024

austingmhuang Jun 13, 2024 •

edited

austingmhuang Jun 13, 2024 •

edited

austingmhuang Jun 13, 2024

austingmhuang Jun 13, 2024 •

edited

austingmhuang Jun 13, 2024 •

edited

austingmhuang left a comment •

edited

josh146 left a comment •

edited

josh146 Jun 14, 2024

josh146 Jun 14, 2024

josh146 Jun 14, 2024

josh146 Jun 14, 2024

josh146 Jun 14, 2024

josh146 Jun 14, 2024

josh146 Jun 14, 2024

josh146 Jun 14, 2024

josh146 Jun 14, 2024

josh146 Jun 14, 2024

josh146 Jun 14, 2024

josh146 Jun 14, 2024

	excellent features and upgrades with the PennyLane-Qiskit plugin, allowing users familiar with
	excellent features and upgrades with the PennyLane-Qiskit plugin, allowing
	anyone familiar with

	suite <https://pennylane.ai/plugins/#plugins>`__, which contains several plugins that are maintained
	suite <https://pennylane.ai/plugins/#plugins>`__, which provide additional simulator and hardware devices and other functionality that are maintained

		# In the PennyLane-Qiskit plugin, there are `several Qiskit
		# devices <https://docs.pennylane.ai/projects/qiskit/en/stable/#devices>`__ you can use, but here are

[sc-63358] How to use Qiskit 1.0 with PennyLane #1104

Are you sure you want to change the base?

[sc-63358] How to use Qiskit 1.0 with PennyLane #1104

Conversation

isaacdevlugt commented May 15, 2024 • edited

github-actions bot commented May 15, 2024

github-actions bot commented May 15, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

austingmhuang Jun 13, 2024 • edited

Choose a reason for hiding this comment

austingmhuang Jun 13, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

austingmhuang Jun 13, 2024 • edited

Choose a reason for hiding this comment

austingmhuang Jun 13, 2024 • edited

Choose a reason for hiding this comment

austingmhuang left a comment • edited

Choose a reason for hiding this comment

josh146 left a comment • edited

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

isaacdevlugt commented May 15, 2024 •

edited

github-actions bot commented May 15, 2024 •

edited

austingmhuang Jun 13, 2024 •

edited

austingmhuang Jun 13, 2024 •

edited

austingmhuang Jun 13, 2024 •

edited

austingmhuang Jun 13, 2024 •

edited

austingmhuang left a comment •

edited

josh146 left a comment •

edited