Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add quick start page for importing workflows #5281

Merged
merged 37 commits into from
Mar 1, 2024

Conversation

Mandrenkov
Copy link
Contributor

@Mandrenkov Mandrenkov commented Feb 28, 2024

Context:

Currently, PennyLane is lacking a quick start page which explains how to import circuits defined in other frameworks into PennyLane. This could highlight some of the recent additions made to the io module.

Description of the Change:

Added an "Importing worklows" quick start page. This includes examples of importing circuits from:

  1. Qiskit
  2. OpenQASM 2.0
  3. pyQuil

An additional section is included for importing Qiskit SparsePauliOp instances.

Benefits:

  • It is easier for users to learn about importing third-party circuits and operators into PennyLane.

Possible Drawbacks:

None.

Related GitHub Issues:

None.

Copy link

codecov bot commented Feb 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (v0.35.0-rc0@2db01d8). Click here to learn what that means.

Additional details and impacted files
@@              Coverage Diff               @@
##             v0.35.0-rc0    #5281   +/-   ##
==============================================
  Coverage               ?   99.65%           
==============================================
  Files                  ?      399           
  Lines                  ?    36622           
  Branches               ?        0           
==============================================
  Hits                   ?    36494           
  Misses                 ?      128           
  Partials               ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@trbromley trbromley added this to the v0.35 milestone Feb 29, 2024
@Mandrenkov Mandrenkov changed the title Add Importing Circuits quick start page Add quick start page for importing circuits Feb 29, 2024
@Mandrenkov Mandrenkov changed the title Add quick start page for importing circuits Add "Importing Circuits" quick start page Feb 29, 2024
@Mandrenkov Mandrenkov changed the title Add "Importing Circuits" quick start page Add quick start page for importing circuits Feb 29, 2024
@Mandrenkov Mandrenkov marked this pull request as ready for review February 29, 2024 20:45

This comment was marked as outdated.

Copy link
Contributor

@lillian542 lillian542 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great, Mikhail! 🚀

doc/introduction/importing_circuits.rst Outdated Show resolved Hide resolved
doc/introduction/importing_circuits.rst Outdated Show resolved Hide resolved
doc/introduction/importing_circuits.rst Outdated Show resolved Hide resolved
doc/introduction/importing_circuits.rst Outdated Show resolved Hide resolved
doc/introduction/importing_circuits.rst Outdated Show resolved Hide resolved
doc/introduction/importing_circuits.rst Outdated Show resolved Hide resolved
doc/introduction/importing_circuits.rst Outdated Show resolved Hide resolved
doc/introduction/importing_circuits.rst Outdated Show resolved Hide resolved
doc/introduction/importing_circuits.rst Outdated Show resolved Hide resolved
doc/introduction/importing_circuits.rst Outdated Show resolved Hide resolved
Mandrenkov and others added 2 commits March 1, 2024 10:58
Co-authored-by: lillian542 <38584660+lillian542@users.noreply.github.com>
Co-authored-by: lillian542 <38584660+lillian542@users.noreply.github.com>
Copy link
Contributor

@lillian542 lillian542 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple of suggestions, and one correction to the QASM circuit.

Maybe we should include an example showing that the Qiskit circuits can be differentiable? But maybe that's overkill for a quick start and they should check the qml.from_qiskit docs.

doc/introduction/importing_workflows.rst Show resolved Hide resolved
doc/introduction/importing_workflows.rst Outdated Show resolved Hide resolved
doc/introduction/importing_workflows.rst Outdated Show resolved Hide resolved
doc/introduction/importing_workflows.rst Outdated Show resolved Hide resolved
Co-authored-by: lillian542 <38584660+lillian542@users.noreply.github.com>
@Mandrenkov
Copy link
Contributor Author

Thanks for taking another look, @lillian542!

Maybe we should include an example showing that the Qiskit circuits can be differentiable? But maybe that's overkill for a quick start and they should check the qml.from_qiskit docs.

I discussed this with @trbromley offline and we agreed that although this would be nice it is not particularly urgent and can wait until the v0.36.0 release.

Copy link
Contributor

@trbromley trbromley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just two comments, but approved otherwise

doc/introduction/importing_workflows.rst Outdated Show resolved Hide resolved
doc/introduction/importing_workflows.rst Outdated Show resolved Hide resolved
Mandrenkov and others added 3 commits March 1, 2024 16:44
Co-authored-by: Thomas R. Bromley <49409390+trbromley@users.noreply.github.com>
Co-authored-by: Thomas R. Bromley <49409390+trbromley@users.noreply.github.com>
@trbromley trbromley added the merge-ready ✔️ All tests pass and the PR is ready to be merged. label Mar 1, 2024
Copy link
Contributor

@lillian542 lillian542 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks ready to go, thanks @Mandrenkov! 🎉

@Mandrenkov Mandrenkov enabled auto-merge (squash) March 1, 2024 22:12
@Mandrenkov Mandrenkov changed the title Add quick start page for importing circuits Add quick start page for importing workflows Mar 1, 2024
@Mandrenkov Mandrenkov merged commit c91a154 into v0.35.0-rc0 Mar 1, 2024
39 checks passed
@Mandrenkov Mandrenkov deleted the sc-57815-importing-circuits-quick-start branch March 1, 2024 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-ready ✔️ All tests pass and the PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants