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

Tape validation for the JAX interface (batch execute) #2011

Merged
merged 3 commits into from
Dec 10, 2021

Conversation

antalszava
Copy link
Contributor

@antalszava antalszava commented Dec 10, 2021

Adds a validation step to using the JAX interface akin to the previous version of the interface before batch execution.

@github-actions
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.

@codecov
Copy link

codecov bot commented Dec 10, 2021

Codecov Report

❗ No coverage uploaded for pull request base (v0.20.0-rc0@c116919). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@              Coverage Diff               @@
##             v0.20.0-rc0    #2011   +/-   ##
==============================================
  Coverage               ?   99.07%           
==============================================
  Files                  ?      221           
  Lines                  ?    16831           
  Branches               ?        0           
==============================================
  Hits                   ?    16675           
  Misses                 ?      156           
  Partials               ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c116919...ba23fe6. Read the comment docs.

Copy link
Contributor

@Jaybsoni Jaybsoni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, nice clean tests,

@@ -86,6 +87,28 @@ def execute(tapes, device, execute_fn, gradient_fn, gradient_kwargs, _n=1, max_d
)


def _validate_tapes(tapes):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be a good method to implement for all of the different devices and frameworks! Im not sure which ones support which operations!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I know, it's only the JAX interface that we have constraints on. 🤔

@antalszava antalszava merged commit 25757ea into v0.20.0-rc0 Dec 10, 2021
@antalszava antalszava deleted the jax_vector_valued_error branch December 10, 2021 18:51
@antalszava
Copy link
Contributor Author

[sc-12248]

antalszava added a commit that referenced this pull request Dec 14, 2021
* 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>
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.

None yet

2 participants