Add custom pattern to broadcast
#603
Conversation
Codecov Report
@@ Coverage Diff @@
## master #603 +/- ##
=======================================
Coverage 98.92% 98.92%
=======================================
Files 82 82
Lines 5099 5109 +10
=======================================
+ Hits 5044 5054 +10
Misses 55 55
Continue to review full report at Codecov.
|
| return qml.expval(qml.PauliZ(0)) | ||
|
|
||
| with pytest.raises(ValueError, match="a custom pattern must be a list"): | ||
| circuit() |
There was a problem hiding this comment.
Nice tests! For a unit test, you could do something that tests that the gates were applied to the correct wires, by using the operation recorder:
def circuit():
broadcast(unitary=qml.CNOT, pattern=custom_pattern, wires=range(4))
with OperatonRecorder() as rec:
circuit()
assert rec.queue[0].name == "CNOT"
assert rec.queue[0].wires = custom_pattern[0]etc.
There was a problem hiding this comment.
Oh yes, I wanted to add that one!
There was a problem hiding this comment.
Decided to do one where I check the output instead!
| broadcast(unitary=qml.CNOT, pattern=pattern, | ||
| wires=range(5)) | ||
| return qml.expval(qml.PauliZ(0)) |
|
|
||
| .. currentmodule:: pennylane.templates | ||
|
|
||
| .. autofunction:: broadcast |
There was a problem hiding this comment.
This gets automatically added
| @@ -36,13 +36,24 @@ State preperations | |||
| Custom templates | |||
| ---------------- | |||
|
|
|||
| Custom templates can be constructed using the template decorator. | |||
| The template decorator can used to register a quantum function as a template. | |||
There was a problem hiding this comment.
I realised that we did not have the function in the docs...
pennylane/__init__.py
Outdated
| @@ -30,7 +30,7 @@ | |||
| import pennylane.init | |||
| import pennylane.templates | |||
| import pennylane.qnn | |||
| from pennylane.templates import template, broadcast | |||
| from pennylane.templates import template | |||
There was a problem hiding this comment.
If we want to display broadcast in the API of the templates module, docs complains that there are two functions of the same name, pennylane.broadcast and pennylane.templates.broadcast.
I currently don't remember why we want top-level import of this function, but this would fix it.
There was a problem hiding this comment.
@josh146 would you know? I have a feeling we discussed this before...
There was a problem hiding this comment.
I decided to keep this PR free of the import debate and simply import it in the templates API, but using the qml.broadcast.rst file.
| @@ -416,6 +426,8 @@ def circuit(pars): | |||
|
|
|||
| .. code-block:: python | |||
|
|
|||
| dev = qml.device('default.qubit', wires=4) | |||
There was a problem hiding this comment.
Just added those for consistency.
|
Coverage should not have changed, locally I get 100%. |
Context:
Adds a custom pattern to the
broadcastfunction. The pattern is specified by passing lists of wires to the function - the unitary is then applied to these wires.Description of the Change:
Benefits: This is needed for a new template in the pipeline, and allows users to employ the function in a more flexible manner.