deprecate qml.matrix with wire_order=None #5039
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hello. You may have forgotten to update the changelog!
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5039 +/- ##
==========================================
- Coverage 99.67% 99.66% -0.02%
==========================================
Files 394 394
Lines 35670 35389 -281
==========================================
- Hits 35554 35270 -284
- Misses 116 119 +3 ☔ View full report in Codecov by Sentry. |
mudit2812
approved these changes
Jan 12, 2024
# Conflicts: # doc/development/deprecations.rst # doc/releases/changelog-dev.md
mudit2812
pushed a commit
that referenced
this pull request
Jan 19, 2024
**Context:**
Wire-ordering can surprise people because PennyLane gives no promises.
For example:
```pycon
>>> qs = qml.tape.QuantumScript([qml.Identity(1), qml.CNOT([0, 1])])
>>> qml.matrix(qs)
array([[1., 0., 0., 0.],
[0., 0., 0., 1.],
[0., 0., 1., 0.],
[0., 1., 0., 0.]])
```
This is in wire-order `[1, 0]` because that's the order in which they
appeared in the tape. Most users would expect the other way.
**Description of the Change:**
Deprecate the default `wire_order=None` value in `qml.matrix` in certain
cases. The warning is raised if:
- the object is a tape with more than one wire
- the object is a QNode and the device does not provide wires
- the object is a qfunc
**Benefits:**
Users won't be surprised when they get a matrix in an unexpected wire
order
**Possible Drawbacks:**
More deprecations, the user has to enter wire_order even though it's
often safe to assume they meant ascending integers (but not often
enough, so here we are)
**Related GitHub Issues:**
It was discussed in #3131
[sc-51277]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context:
Wire-ordering can surprise people because PennyLane gives no promises. For example:
This is in wire-order
[1, 0]because that's the order in which they appeared in the tape. Most users would expect the other way.Description of the Change:
Deprecate the default
wire_order=Nonevalue inqml.matrixin certain cases. The warning is raised if:Benefits:
Users won't be surprised when they get a matrix in an unexpected wire order
Possible Drawbacks:
More deprecations, the user has to enter wire_order even though it's often safe to assume they meant ascending integers (but not often enough, so here we are)
Related GitHub Issues:
It was discussed in #3131
[sc-51277]