-
Notifications
You must be signed in to change notification settings - Fork 575
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
Resolve error from texted-based circuit drawer for tapes #1994
Conversation
Tapes appearing in the operations list of circuits (or other tapes) are now drawn as an opaque tape object, and its contents are appended to the circuit drawing as a subcircuit.
When a circuit to be printed contains tapes nested within, the index printed to identify each tape, matrix argument, etc. is now passed to lower levels of nesting (and passed back up) to retain unique names for circuit elements.
Hello. You may have forgotten to update the changelog!
|
Codecov Report
@@ Coverage Diff @@
## v0.20.0-rc0 #1994 +/- ##
==============================================
Coverage ? 99.12%
==============================================
Files ? 221
Lines ? 16790
Branches ? 0
==============================================
Hits ? 16643
Misses ? 147
Partials ? 0 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! 🎉 Thanks for resolving this @dime10 🌟 😍
Had a couple of suggestions, but nothing blocking. 👍
pennylane/drawer/circuit_drawer.py
Outdated
@@ -59,23 +59,24 @@ def __init__( | |||
charset=None, | |||
show_all_wires=False, | |||
max_length=None, | |||
_offsets=None, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A docstring entry is missing for this argument.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was wondering if we exclude it from the public API somehow as it's only used internally but I'll add a docstring :)
|
||
|
||
class RepresentationResolver: | ||
"""Resolves the string representation of PennyLane objects. | ||
|
||
Args: | ||
charset (CharSet, optional): The CharSet to be used for representation resolution. | ||
offsets (dict(string, int), optional): Offset the printed index of different symbol types in nested circuits. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor suggestion: may be good to rename this argument to make it more descriptive: e.g., custom_offsets
or offset_per_unit
or something better 😄 .
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about label_offsets?
from .circuit_drawer import CircuitDrawer | ||
|
||
grid, obs = op.graph.greedy_layers() | ||
charset_string = next((k for k, v in CHARSETS.items() if v is self.charset), None) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How come we'd need a generator solution, would this line correspond to something like this?
charset_string = self.charset if self.charset in CHARSETS else None
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah originally I was using tape.draw() which only accepts a string descriptor of the charset (self.charset stores the charset class), but since I'm using CircuitDrawer directly now this can be removed. The generator construct is just one way to reverse a dictionary mapping (CHARSETS is a dictionary of {string: class}).
Thanks a lot for your review @antalszava :) |
[sc-11982] |
* Fix metric tensor for circuits with inverted gates (#1987) * fix metric tensor for inverse gates * changelog * modify test for block diagonal * undo tmp change * AmplitudeEmbedding: Fix warning from implicit cast of complex to real (#1990) * Fix warning from implicit cast of complex to real * Changelog * Fix warning without failing other tests * V0.20.0: remove deprecated features (#1981) * remove the decorator * remove the decorator tests * remove the remaining template decorator use * Remove the default.tensor devices * no mention of default.tensor.tf * remove fourier.spectrum * no default.tensor entry points * no beta devices ref in docs * remove the diag_approx keyword argument of qml.metric_tensor and qml.QNGOptimizer * changelog * changelog formatting * Remove the metric_tensor method of the old QNode; remove tests and adjust an example for QNG * remove unused variable * Fix error mitigation tests * Resolve error from texted-based circuit drawer for tapes (#1994) * Add support for drawing tapes to textdrawer Tapes appearing in the operations list of circuits (or other tapes) are now drawn as an opaque tape object, and its contents are appended to the circuit drawing as a subcircuit. * Fix charset of tape subcircuits * Add persistent indices to ops in nested circuits When a circuit to be printed contains tapes nested within, the index printed to identify each tape, matrix argument, etc. is now passed to lower levels of nesting (and passed back up) to retain unique names for circuit elements. * Add tests for drawing nested tapes * Changelog * Review: docstrings, arg name, generator * Make multi_dispatch treat scipy same as numpy (#2001) * Make multi_dispatch treat scipy same as numpy * Changelog * Add test to assert warning is no longer raised * Use pytest.mark instead of warnings module for filter Adding a warning filter using the warnings module seems to persist across unit tests. * Remove empty circuits and device tests to check supported operations (#1979) * check supported operations in more places * add PauliX to measurment qnodes * Incrementing the version number to `0.21.0-dev` (#1988) * changelogs * changelog * version number bumps * clean changelog file * RC to master (#1995) * Fix metric tensor for circuits with inverted gates (#1987) * fix metric tensor for inverse gates * changelog * modify test for block diagonal * undo tmp change * AmplitudeEmbedding: Fix warning from implicit cast of complex to real (#1990) * Fix warning from implicit cast of complex to real * Changelog * Fix warning without failing other tests * V0.20.0: remove deprecated features (#1981) * remove the decorator * remove the decorator tests * remove the remaining template decorator use * Remove the default.tensor devices * no mention of default.tensor.tf * remove fourier.spectrum * no default.tensor entry points * no beta devices ref in docs * remove the diag_approx keyword argument of qml.metric_tensor and qml.QNGOptimizer * changelog * changelog formatting * Remove the metric_tensor method of the old QNode; remove tests and adjust an example for QNG * remove unused variable * Fix error mitigation tests Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> * eliminate empty circuits, minor rewriting * black, changelog, fix probs * fix merging with rc branch * state non empty circuit Co-authored-by: antalszava <antalszava@gmail.com> Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> * Update doc/releases/changelog-dev.md * Update pennylane/drawer/representation_resolver.py * Update pennylane/drawer/representation_resolver.py * have a single self.label_offsets dictionary for linting purposes * organize tape drawing into its own method * no too many return statements check * format Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> Co-authored-by: antalszava <antalszava@gmail.com>
* Merge release candidate into master (#2003) * Fix metric tensor for circuits with inverted gates (#1987) * fix metric tensor for inverse gates * changelog * modify test for block diagonal * undo tmp change * AmplitudeEmbedding: Fix warning from implicit cast of complex to real (#1990) * Fix warning from implicit cast of complex to real * Changelog * Fix warning without failing other tests * V0.20.0: remove deprecated features (#1981) * remove the decorator * remove the decorator tests * remove the remaining template decorator use * Remove the default.tensor devices * no mention of default.tensor.tf * remove fourier.spectrum * no default.tensor entry points * no beta devices ref in docs * remove the diag_approx keyword argument of qml.metric_tensor and qml.QNGOptimizer * changelog * changelog formatting * Remove the metric_tensor method of the old QNode; remove tests and adjust an example for QNG * remove unused variable * Fix error mitigation tests * Resolve error from texted-based circuit drawer for tapes (#1994) * Add support for drawing tapes to textdrawer Tapes appearing in the operations list of circuits (or other tapes) are now drawn as an opaque tape object, and its contents are appended to the circuit drawing as a subcircuit. * Fix charset of tape subcircuits * Add persistent indices to ops in nested circuits When a circuit to be printed contains tapes nested within, the index printed to identify each tape, matrix argument, etc. is now passed to lower levels of nesting (and passed back up) to retain unique names for circuit elements. * Add tests for drawing nested tapes * Changelog * Review: docstrings, arg name, generator * Make multi_dispatch treat scipy same as numpy (#2001) * Make multi_dispatch treat scipy same as numpy * Changelog * Add test to assert warning is no longer raised * Use pytest.mark instead of warnings module for filter Adding a warning filter using the warnings module seems to persist across unit tests. * Remove empty circuits and device tests to check supported operations (#1979) * check supported operations in more places * add PauliX to measurment qnodes * Incrementing the version number to `0.21.0-dev` (#1988) * changelogs * changelog * version number bumps * clean changelog file * RC to master (#1995) * Fix metric tensor for circuits with inverted gates (#1987) * fix metric tensor for inverse gates * changelog * modify test for block diagonal * undo tmp change * AmplitudeEmbedding: Fix warning from implicit cast of complex to real (#1990) * Fix warning from implicit cast of complex to real * Changelog * Fix warning without failing other tests * V0.20.0: remove deprecated features (#1981) * remove the decorator * remove the decorator tests * remove the remaining template decorator use * Remove the default.tensor devices * no mention of default.tensor.tf * remove fourier.spectrum * no default.tensor entry points * no beta devices ref in docs * remove the diag_approx keyword argument of qml.metric_tensor and qml.QNGOptimizer * changelog * changelog formatting * Remove the metric_tensor method of the old QNode; remove tests and adjust an example for QNG * remove unused variable * Fix error mitigation tests Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> * eliminate empty circuits, minor rewriting * black, changelog, fix probs * fix merging with rc branch * state non empty circuit Co-authored-by: antalszava <antalszava@gmail.com> Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> * Update doc/releases/changelog-dev.md * Update pennylane/drawer/representation_resolver.py * Update pennylane/drawer/representation_resolver.py * have a single self.label_offsets dictionary for linting purposes * organize tape drawing into its own method * no too many return statements check * format Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> Co-authored-by: antalszava <antalszava@gmail.com> * Style2 Co-authored-by: Christina Lee <christina@xanadu.ai> Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> Co-authored-by: antalszava <antalszava@gmail.com>
* Fix metric tensor for circuits with inverted gates (#1987) * fix metric tensor for inverse gates * changelog * modify test for block diagonal * undo tmp change * AmplitudeEmbedding: Fix warning from implicit cast of complex to real (#1990) * Fix warning from implicit cast of complex to real * Changelog * Fix warning without failing other tests * V0.20.0: remove deprecated features (#1981) * remove the decorator * remove the decorator tests * remove the remaining template decorator use * Remove the default.tensor devices * no mention of default.tensor.tf * remove fourier.spectrum * no default.tensor entry points * no beta devices ref in docs * remove the diag_approx keyword argument of qml.metric_tensor and qml.QNGOptimizer * changelog * changelog formatting * Remove the metric_tensor method of the old QNode; remove tests and adjust an example for QNG * remove unused variable * Fix error mitigation tests * Resolve error from texted-based circuit drawer for tapes (#1994) * Add support for drawing tapes to textdrawer Tapes appearing in the operations list of circuits (or other tapes) are now drawn as an opaque tape object, and its contents are appended to the circuit drawing as a subcircuit. * Fix charset of tape subcircuits * Add persistent indices to ops in nested circuits When a circuit to be printed contains tapes nested within, the index printed to identify each tape, matrix argument, etc. is now passed to lower levels of nesting (and passed back up) to retain unique names for circuit elements. * Add tests for drawing nested tapes * Changelog * Review: docstrings, arg name, generator * Make multi_dispatch treat scipy same as numpy (#2001) * Make multi_dispatch treat scipy same as numpy * Changelog * Add test to assert warning is no longer raised * Use pytest.mark instead of warnings module for filter Adding a warning filter using the warnings module seems to persist across unit tests. * Remove empty circuits and device tests to check supported operations (#1979) * check supported operations in more places * add PauliX to measurment qnodes * Incrementing the version number to `0.21.0-dev` (#1988) * changelogs * changelog * version number bumps * clean changelog file * RC to master (#1995) * Fix metric tensor for circuits with inverted gates (#1987) * fix metric tensor for inverse gates * changelog * modify test for block diagonal * undo tmp change * AmplitudeEmbedding: Fix warning from implicit cast of complex to real (#1990) * Fix warning from implicit cast of complex to real * Changelog * Fix warning without failing other tests * V0.20.0: remove deprecated features (#1981) * remove the decorator * remove the decorator tests * remove the remaining template decorator use * Remove the default.tensor devices * no mention of default.tensor.tf * remove fourier.spectrum * no default.tensor entry points * no beta devices ref in docs * remove the diag_approx keyword argument of qml.metric_tensor and qml.QNGOptimizer * changelog * changelog formatting * Remove the metric_tensor method of the old QNode; remove tests and adjust an example for QNG * remove unused variable * Fix error mitigation tests Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> * eliminate empty circuits, minor rewriting * black, changelog, fix probs * fix merging with rc branch * state non empty circuit Co-authored-by: antalszava <antalszava@gmail.com> Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> * Update doc/releases/changelog-dev.md * Update pennylane/drawer/representation_resolver.py * Update pennylane/drawer/representation_resolver.py * have a single self.label_offsets dictionary for linting purposes * organize tape drawing into its own method * no too many return statements check * format * [WIP] Jit probs bug (#1998) * trying to use jax unique function to allow for compilation * testing * Overrided the estimate_probability method in the default_qubit_jax device to allow for jit-ing when working with qml.probs * Apply suggestions from code review * missed comment * lint * Added tests * fixed bug with fill value * cleaning up * Fix missing function call in metric tensor example (#2008) * Update docs of `qml.fourier.reconstruct` and `qml.QubitDensityMatrix` (#2005) * reconstruct fixes * QubitDensityMatrix fix * revert merge master commit * minor doc fixes (#2009) * fix typo in CVNeuralNetLayers UsageDetails * Fix some minor doc example for drawer (#2010) * Merge release candidate into master (#2003) * Fix metric tensor for circuits with inverted gates (#1987) * fix metric tensor for inverse gates * changelog * modify test for block diagonal * undo tmp change * AmplitudeEmbedding: Fix warning from implicit cast of complex to real (#1990) * Fix warning from implicit cast of complex to real * Changelog * Fix warning without failing other tests * V0.20.0: remove deprecated features (#1981) * remove the decorator * remove the decorator tests * remove the remaining template decorator use * Remove the default.tensor devices * no mention of default.tensor.tf * remove fourier.spectrum * no default.tensor entry points * no beta devices ref in docs * remove the diag_approx keyword argument of qml.metric_tensor and qml.QNGOptimizer * changelog * changelog formatting * Remove the metric_tensor method of the old QNode; remove tests and adjust an example for QNG * remove unused variable * Fix error mitigation tests * Resolve error from texted-based circuit drawer for tapes (#1994) * Add support for drawing tapes to textdrawer Tapes appearing in the operations list of circuits (or other tapes) are now drawn as an opaque tape object, and its contents are appended to the circuit drawing as a subcircuit. * Fix charset of tape subcircuits * Add persistent indices to ops in nested circuits When a circuit to be printed contains tapes nested within, the index printed to identify each tape, matrix argument, etc. is now passed to lower levels of nesting (and passed back up) to retain unique names for circuit elements. * Add tests for drawing nested tapes * Changelog * Review: docstrings, arg name, generator * Make multi_dispatch treat scipy same as numpy (#2001) * Make multi_dispatch treat scipy same as numpy * Changelog * Add test to assert warning is no longer raised * Use pytest.mark instead of warnings module for filter Adding a warning filter using the warnings module seems to persist across unit tests. * Remove empty circuits and device tests to check supported operations (#1979) * check supported operations in more places * add PauliX to measurment qnodes * Incrementing the version number to `0.21.0-dev` (#1988) * changelogs * changelog * version number bumps * clean changelog file * RC to master (#1995) * Fix metric tensor for circuits with inverted gates (#1987) * fix metric tensor for inverse gates * changelog * modify test for block diagonal * undo tmp change * AmplitudeEmbedding: Fix warning from implicit cast of complex to real (#1990) * Fix warning from implicit cast of complex to real * Changelog * Fix warning without failing other tests * V0.20.0: remove deprecated features (#1981) * remove the decorator * remove the decorator tests * remove the remaining template decorator use * Remove the default.tensor devices * no mention of default.tensor.tf * remove fourier.spectrum * no default.tensor entry points * no beta devices ref in docs * remove the diag_approx keyword argument of qml.metric_tensor and qml.QNGOptimizer * changelog * changelog formatting * Remove the metric_tensor method of the old QNode; remove tests and adjust an example for QNG * remove unused variable * Fix error mitigation tests Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> * eliminate empty circuits, minor rewriting * black, changelog, fix probs * fix merging with rc branch * state non empty circuit Co-authored-by: antalszava <antalszava@gmail.com> Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> * Update doc/releases/changelog-dev.md * Update pennylane/drawer/representation_resolver.py * Update pennylane/drawer/representation_resolver.py * have a single self.label_offsets dictionary for linting purposes * organize tape drawing into its own method * no too many return statements check * format Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> Co-authored-by: antalszava <antalszava@gmail.com> * Style2 Co-authored-by: Christina Lee <christina@xanadu.ai> Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> Co-authored-by: antalszava <antalszava@gmail.com> * Tape validation for the JAX interface (batch execute) (#2011) * add tape validation to the JAX interface to provide users with a descriptive error message * formatting * changelog * Fix behaviour of `qml.gradients.gradient_transform` for multiple array arguments (#1989) * Fix gradient_transform for complex QNode shapes Previously, the gradient transform did not account for the shape of classical jacobians produced by `qml.jacobian` for complex QNode argument scenarious, leading to a shape mismatch error during tensor contraction of the classical and quantum jacobian. This is resolved by distinguishing between the case of a single classical Jacobian for a single QNode argument, and multiple classical Jacobians stacked together when all QNode arguments have the same shape. The two cases require different tensor manipulations as `qml.jacobian` behaves differently in each. Two test cases are added that include multiple vector arguments to a QNode and non-trainable QNode arguments mixed with trainable ones. * Format * Changelog * Fix coverage by removing some "fallback" branches and adding dummy test. * Update doc/releases/changelog-dev.md Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca> * Review: small corrections * Proposal: leave old behaviour as fallback branch * Review: remove tf & torch logic, comment * Review: raise warning for unknown cjac shape Co-authored-by: Antal Szava <antalszava@gmail.com> Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca> * Fix docstrings for `CommutingEvolution` (#2012) * Example and docstrings * Undo. * Use the correct GPU device internally with `default.qubit.torch` (#1982) * changes * format * docstring * lint * Update pennylane/devices/default_qubit_torch.py Co-authored-by: Christina Lee <christina@xanadu.ai> * Update pennylane/devices/default_qubit_torch.py Co-authored-by: Christina Lee <christina@xanadu.ai> * no cover; extend docstring * format; correct typo * revert * no cover for GPU part * format Co-authored-by: Christina Lee <christina@xanadu.ai> * updated docstring example (#2019) * Fix Barrier example * `v0.20.0` release notes (#1977) * current release * rename latest changelog * reorder the entries, create sections * version, release notes file * Update doc/releases/changelog-0.20.0.md * Update doc/releases/changelog-0.20.0.md Co-authored-by: Josh Izaac <josh146@gmail.com> * Update doc/releases/changelog-0.20.0.md Co-authored-by: Josh Izaac <josh146@gmail.com> * init module: breaking * Apply suggested changes * Apply suggested changes * rendering issues * mutable kwarg * apply suggestions * move to breaking changes * Lie opt example * Update doc/releases/changelog-0.20.0.md Co-authored-by: Josh Izaac <josh146@gmail.com> * transformation example in the notes * updates * Fix examples * fix refs * contributors * More PRs listed * PauliError * PauliError * custom ops as attribute * Update changelog-0.20.0.md * Update changelog-0.20.0.md Co-authored-by: Josh Izaac <josh146@gmail.com> * readd changelog item * correct version numbers * nl * disallow qml.probs with default.qubit.jax when using a shot vector * no else Co-authored-by: David Wierichs <davidwierichs@gmail.com> Co-authored-by: David Ittah <dime10@users.noreply.github.com> Co-authored-by: Christina Lee <christina@xanadu.ai> Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca> Co-authored-by: Romain <rmoyard@gmail.com> Co-authored-by: Josh Izaac <josh146@gmail.com>
Context:
As discovered in issue #1967, the text-based circuit drawer throws an error when the operations list of a circuit contains a tape. This can happen manually when nesting a tape inside a circuit or tape, e.g.:
but also when an operation needs to be decomposed before printing, such as an adjoint template without a defined
.adjoint()
method that manipulates the.inv
attribute instead, e.g. (v0.19.0 only, fixed in current dev branch):Description of the Change:
The issue is resolved by adding support for drawing tapes as operations to the circuit drawer.
The contents of the tape are also drawn separately and attached to the main circuit drawing in a manner similar to how matrix arguments are already included.
Nested tapes are also supported and rendered by recursive traversal, e.g.:
is drawn as:
Benefits: No errors are thrown when the drawer attempts to render a tape.
Possible Drawbacks:
Related GitHub Issues: Closes #1967