Top level import of templates #1779
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1779 +/- ##
=======================================
Coverage 98.91% 98.91%
=======================================
Files 207 207
Lines 15595 15599 +4
=======================================
+ Hits 15426 15430 +4
Misses 169 169
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
This is looking awesome, thank you @rmoyard for it! 😍 It Will be so simple to use templates.
There seem to be a couple of remaining occurrences that require a change:
- In the
docsfolder, there seem to be two occurrences ofqml_templatesleft:
else:
link = "code/qml_templates"-
The pages in
introduction/interfacesseem to have code examples such asqml.templates.AmplitudeEmbedding, etc. -
Minor: the https://github.com/PennyLaneAI/pennylane/blob/master/doc/development/adding_templates.rst page also has some occurrences of the full template path (though they render well either way).
There was a problem hiding this comment.
Awesome that the CI checks are now in place. 😊 🚀
One other set of replacements we could do is to change the code examples we have in the pennylane folder. Many would use for example qml.templates.StronglyEntanglingLayers, etc. Here we could make sure that users see the shorthand syntax.
doc/introduction/templates.rst
Outdated
| The template decorator can used to register a quantum function as a template. | ||
|
|
||
| .. autosummary:: | ||
| :toctree: | ||
|
|
||
| pennylane.templates.template |
There was a problem hiding this comment.
oh, the template decorator is deprecated, we should probably remove it :)
There was a problem hiding this comment.
(at the very least, lets remove it from here)
There was a problem hiding this comment.
@josh146 should we add a warning when it's used? (Or perhaps we'll be able to simply remove it as likely it was not too widely used).
There was a problem hiding this comment.
If there is already no warning, we should add a deprecation warning for 0.19 and then remove it in 0.20 🙂
doc/introduction/templates.rst
Outdated
| Layering Function | ||
| ----------------- | ||
|
|
||
| The layer function creates a new template by repeatedly applying a sequence of quantum | ||
| gates to a set of wires. You can import this function both via | ||
| ``qml.layer`` and ``qml.templates.layer``. | ||
|
|
||
| .. autosummary:: | ||
|
|
||
| pennylane.layer | ||
|
|
||
| Utility functions for input checks | ||
| ---------------------------------- | ||
|
|
||
| .. automodapi:: pennylane.templates.utils | ||
| :no-heading: | ||
| :include-all-objects: |
There was a problem hiding this comment.
@mariaschuld just double checking here on your thoughts.
Definitely we should remove the utility checks from the quickstart, iirc they are deprecated and should be removed?
The layer function is not deprecated, but I'm wondering if it is worth keeping.
There was a problem hiding this comment.
Yes, we should remove the utilities :)
No strong feelings about the layering function, does it just implement a for loop? If so, is it important for users? I know that the QAOA module uses it a lot!
There was a problem hiding this comment.
Yep, the layer() function is simply a for loop under the hood:
def layer(template, depth, *args, **kwargs):
for i in range(0, int(depth)):
arg_params = [k[i] for k in args]
template(*arg_params, **kwargs)
Description of the Change:
Previously, templates had to be used by first accessing .templates and then use the specific template name
qml.templates.QFT, now they are top level imported and can be used directly e.g.qml.QFT.QFTis also added back to the list of operations indefault.qubitanddefault.mixed, therefore it will use the matrix representation instead of decomposing first.The file
qaoa.pyfor qaoa embedding was renamedqaoaembedding.pybecause of collusion with the qaoa module.Benefits:
UI is simpler and the user does not need to know about the distinction between operations and templates.