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

Expand documentation for qml.from_qiskit() (abandoned) #5259

Closed
wants to merge 22 commits into from

Conversation

lillian542
Copy link
Contributor

@lillian542 lillian542 commented Feb 26, 2024

Add additional documentation and examples to the qml.from_qiskit() function.

Copy link
Contributor

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

@lillian542
Copy link
Contributor Author

[sc-57149]

Copy link

codecov bot commented Feb 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

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

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

**Must not be merged before the creation of the release candidate branch
for 0.35.0**

Updates PennyLane as we're entering a new development version (release
of v0.35.0 coming up):

- Create changelog-dev.md
- Add changelog-dev.md to release-notes.md
- Increments the version number to v0.36.0-dev


```
rc    master
|     |
|     - (**THIS PR**)add changelog-dev.md, add changelog-dev reference to release_notes.md, bump version to 0.36.0-dev
|    /
|   /
|  /
| /
|/
- rename changelog-dev.md to changelog-0.35.0.md, change changelog-dev reference to changelog-0.35 reference in release_notes.md, move "current release" label from changelog-0.34 to changelog-0.35, change version from 0.35.0-dev to 0.25.0
|
| 
```

---------

Co-authored-by: Matthew Silverman <[email protected]>
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.

Thanks @lillian542 for starting this!

pennylane/io.py Outdated Show resolved Hide resolved
pennylane/io.py Outdated Show resolved Hide resolved
pennylane/io.py Outdated Show resolved Hide resolved
pennylane/io.py Outdated Show resolved Hide resolved
pennylane/io.py Outdated Show resolved Hide resolved
pennylane/io.py Outdated Show resolved Hide resolved
pennylane/io.py Outdated Show resolved Hide resolved
pennylane/io.py Outdated Show resolved Hide resolved
pennylane/io.py Outdated Show resolved Hide resolved
pennylane/io.py Outdated Show resolved Hide resolved
@trbromley trbromley added this to the v0.35 milestone Feb 27, 2024
timmysilv and others added 4 commits February 28, 2024 09:40
**Context:**
PRs on forks fail the docs CI when trying to upload freeze changes, so
I'd like to just skip that part if the PR is from a fork.

**Description of the Change:**
Skip those steps if on a fork, as described
[here](https://github.com/orgs/community/discussions/25217).

**Benefits:**
External contributor PRs won't fail unexpectedly

**Possible Drawbacks:**
N/A - it will run often enough by us internally that the docs freeze
file will be kept up-to-date regardless

**Related GitHub Issues:**
- Example failure:
https://github.com/PennyLaneAI/pennylane/actions/runs/8039250831/job/21956066233?pr=5256
- Confirmed it skips on forks:
https://github.com/PennyLaneAI/pennylane/actions/runs/8071064111/job/22049837508?pr=5272
Automatic sync from the release candidate to master during a feature
freeze.

---------

Co-authored-by: Josh Izaac <[email protected]>
Co-authored-by: Nathan Killoran <[email protected]>
Co-authored-by: Matthew Silverman <[email protected]>
Co-authored-by: Astral Cai <[email protected]>
Co-authored-by: Mikhail Andrenkov <[email protected]>
Co-authored-by: GitHub Actions Bot <>
Co-authored-by: lillian542 <[email protected]>
Co-authored-by: Thomas R. Bromley <[email protected]>
@Mandrenkov Mandrenkov changed the base branch from master to v0.35.0-rc0 February 28, 2024 16:10
@Mandrenkov Mandrenkov changed the title Expand the qml.from_qiskit docs Expand documentation for qml.from_qiskit() Feb 28, 2024
@Mandrenkov Mandrenkov marked this pull request as ready for review February 28, 2024 20:40
@Mandrenkov
Copy link
Contributor

Thanks for the review, @trbromley! I've replied to your suggestions and made some additional changes.

@Mandrenkov Mandrenkov requested a review from trbromley February 28, 2024 20:40
pennylane/io.py Outdated Show resolved Hide resolved
pennylane/io.py Outdated Show resolved Hide resolved
pennylane/io.py Outdated Show resolved Hide resolved
pennylane/io.py Outdated Show resolved Hide resolved
pennylane/io.py Show resolved Hide resolved
pennylane/io.py Outdated Show resolved Hide resolved
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.

Thanks @Mandrenkov! Approved once we resolve the remaining comments.

@trbromley
Copy link
Contributor

Any worries about 7d05c63? We could always create a new PR since the changes here are pretty localized, if we're worried about a polluted branch.

@Mandrenkov
Copy link
Contributor

Thanks for taking another look, @trbromley!

Any worries about 7d05c63? We could always create a new PR since the changes here are pretty localized, if we're worried about a polluted branch.

Yeah, it may be cleaner to just make a new branch and apply the changes by hand. I'll open up a new PR and link it here.

Mandrenkov added a commit that referenced this pull request Feb 28, 2024
@Mandrenkov Mandrenkov changed the title Expand documentation for qml.from_qiskit() Expand documentation for qml.from_qiskit() (abandoned) Feb 28, 2024
@Mandrenkov
Copy link
Contributor

Closed in favour of #5279.

@Mandrenkov Mandrenkov closed this Feb 28, 2024
@Mandrenkov Mandrenkov deleted the qiskit_conversion_docs branch February 28, 2024 22:08
Mandrenkov added a commit that referenced this pull request Feb 28, 2024
**Context:**

The documentation for `qml.from_qiskit()` is lacking in both breadth, depth, and examples.

Note that this PR forks #5259 due to 7d05c63.

**Description of the Change:**

* Expanded the `qml.from_qiskit()` docstring.
* Applied analagous style changes to the `qml.from_qiskit_op()` docstring.
* Added a reference target `mid_circuit_measurements`.

**Benefits:**

* Users can use the `qml.from_qiskit()` function with more ease and confidence.

**Possible Drawbacks:**

None.

**Related GitHub Issues:**

None.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants