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.

Sign up for GitHub

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

Jump to bottom

Update the norm check for QubitStateVector in default.qubit (v0.19.1) #1924

Merged
merged 5 commits into from
Nov 22, 2021
Merged

Update the norm check for QubitStateVector in default.qubit (v0.19.1) #1924

merged 5 commits into from
Nov 22, 2021

Conversation

antalszava
Copy link
Contributor

@antalszava antalszava commented Nov 22, 2021 •
edited
Loading

Context:

There is a check in default.qubit to ensure that the input statevector is normalized for the QubitStateVector operation.

For certain tensors, in particular those that are abstract (have no numeric value at the time), this check would result in an error. For this reason, there is first a condition checking whether that the input tensor is abstract or not.

The issue seems to arise still, however, because it seems that the output of extracting the norm for an input tensor could still be abstract.

This issue arises with:

  • JAX Jitting when using jax==0.2.10 and jaxlib==0.1.64
  • Input tensors with a complex dtype
  • Specifying the input statevector outside of the QNode (without making it an input parameter of the QNode). If the input statevector was an input parameter, jitting would continue to work.

Description of the Change:

  • The abstraction check is changed to check the normalized statevector rather than the input statevector;
  • Prepares a new changelog for the v0.19.1 bug fix.

Benefits:
JAX Jitting works with QubitStateVector even with earlier JAX versions.

Possible Drawbacks:
N/A

Related GitHub Issues:
QML repository failures for the dev and master checks:

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

@antalszava
Copy link
Contributor Author

Note: this PR is identical to #1923, just merges into a v0.19.1 release candidate branch.

Compare the v0.19.0 tag with v0.19.1-rc0: v0.19.0...v0.19.1-rc0.

josh146
josh146 approved these changes Nov 22, 2021
View reviewed changes
Copy link
Member

@josh146 josh146 left a comment

Choose a reason for hiding this comment

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

thanks @antalszava! Just needs the bugfix entry in the changelog :)

josh146
josh146 reviewed Nov 22, 2021
View reviewed changes
doc/releases/changelog-0.19.1.md
@@ -0,0 +1,16 @@
:orphan:
Copy link
Member

Choose a reason for hiding this comment

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

don't forget to also add this file to release_notes.md!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the catch!

@codecov
Copy link

codecov bot commented Nov 22, 2021

Codecov Report

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

Impacted file tree graph

@@              Coverage Diff               @@
##             v0.19.1-rc0    #1924   +/-   ##
==============================================
  Coverage               ?   98.96%           
==============================================
  Files                  ?      218           
  Lines                  ?    16391           
  Branches               ?        0           
==============================================
  Hits                   ?    16222           
  Misses                 ?      169           
  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 a087aab...cbd808c. Read the comment docs.

@antalszava antalszava merged commit 3d71f9f into v0.19.1-rc0 Nov 22, 2021
@antalszava antalszava deleted the fix_qubitstatevector_norm_check branch November 22, 2021 17:55
This was referenced Nov 22, 2021
Closed
Merged
josh146 added a commit that referenced this pull request Nov 29, 2021
@antalszava @dwierichs
@rmoyard @josh146 @mariaschuld @albi3ro @soranjh @KetpuntoG @agran2018 @CatalinaAlbornoz @co9olguy
Merge 0.19.1 into master (#1942)
31e984c 
* extend the changelog item of the init module deprecation (#1833)

* add sorting to `get_parameters`

* undo accidental direct push to v0.19.0-rc0

* Remove template decorator from PennyLane functions (#1808) (#1835)

* Remove template decorator.

* Correct import and changelog.

* Change interferometer.

* Update pennylane/templates/broadcast.py

Co-authored-by: antalszava <antalszava@gmail.com>

* Update doc/releases/changelog-dev.md

Co-authored-by: antalszava <antalszava@gmail.com>

* Update pennylane/templates/broadcast.py

Co-authored-by: antalszava <antalszava@gmail.com>

* Update from review.

* More import removed.

* Update parametric ops.

* Update pennylane/templates/subroutines/arbitrary_unitary.py

Co-authored-by: antalszava <antalszava@gmail.com>

Co-authored-by: antalszava <antalszava@gmail.com>

Co-authored-by: Romain <rmoyard@gmail.com>

* Update `QNGOptimizer` to handle deprecations (#1834)

* pass approx option in QNG if need be

* convert to array instead of list; add recwarn to QNG test case

* Update pennylane/optimize/qng.py

Co-authored-by: Josh Izaac <josh146@gmail.com>

* add expval(H) with two input params test case

* deprecate diag_approx keyword for QNGOptimizer

* format

* docstring

* changelog

Co-authored-by: Josh Izaac <josh146@gmail.com>

* Sorted `tape.get_parameters` (#1836)

* sorted `get_parameters`

* adapt PR count

* fix metric tensor tests

* also sort in `set_parameters`

* Fix bug to ensure qml.math.dot works in autograph mode (#1842)

* Fix bug to ensure qml.math.dot works in autograph mode

* changelog

Co-authored-by: antalszava <antalszava@gmail.com>

* Update `expand_fn` (rc) (#1838)

* expand_fn

* changes just as in master

* new lines

* Ensure that the correct version of keras is installed for TensorFlow CI (#1847)

* Add deprecation warning for default.tensor (#1851)

* add warning and test

* add changelog

* Update pennylane/beta/devices/default_tensor.py

Co-authored-by: antalszava <antalszava@gmail.com>

Co-authored-by: antalszava <antalszava@gmail.com>

* fix docstrings in hf module (#1853)

* fix hf docstrings

* Update pennylane/hf/hartree_fock.py

Co-authored-by: Romain <rmoyard@gmail.com>

Co-authored-by: Romain <rmoyard@gmail.com>

* Docstring updates of new features before the release (#1859)

* doc format

* docstring example

* Hide :orphan: from displaying in the release notes (#1863)

* Update single_dispatch.py (#1857)

* Add support for abstract tensors in AmplitudeEmbedding (#1845)

* Add support for abstract tensors in AmplitudeEmbedding

* add tests

* update changelog

* Apply suggestions from code review

Co-authored-by: Romain <rmoyard@gmail.com>

* fix

* fix

* fix

* Add batchtracer support

* Update tests/math/test_is_abstract.py

Co-authored-by: antalszava <antalszava@gmail.com>

Co-authored-by: Romain <rmoyard@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>

* Add documentation for the hf module (#1839)

* create rst file for hf module

* Documentation Updates (#1868)

* documentation updates

* Update doc/introduction/interfaces/numpy.rst

* Apply suggestions from code review

Co-authored-by: antalszava <antalszava@gmail.com>

* scipy minimize update

* collections of qnode section re-added

* new lines

Co-authored-by: antalszava <antalszava@gmail.com>

* Update deprecated use of `qml.grad`/`qml.jacobian` in docstrings (#1860)

* autograd device requires_grad

* math.quantum example

* tracker

* tracker 2nd

* batch_transform

* batch_params

* fix batch params docstring

* update

* Update pennylane/transforms/batch_params.py

Co-authored-by: antalszava <antalszava@gmail.com>

* `qml.math.is_independent` no deprecation warnings with `qml.grad`/`qml.jacobian` (#1862)

* is_independent no deprecation warning

* is_independent no deprecation warning tests

* docstring

* formatting

* mark arrayboxes as trainable still; adjust test case (no autograd warning)

* define requires_grad=True for random args only with Autograd (not JAX) to avoid errors with JAX tracers

* add in warning checks such that warnings are for sure not emitted

* Update pennylane/transforms/batch_params.py

Co-authored-by: Christina Lee <christina@xanadu.ai>

* Update pennylane/transforms/batch_params.py

Co-authored-by: Christina Lee <christina@xanadu.ai>

* Update pennylane/transforms/batch_params.py

Co-authored-by: Christina Lee <christina@xanadu.ai>

* Update pennylane/transforms/batch_params.py

Co-authored-by: Christina Lee <christina@xanadu.ai>

* Update pennylane/transforms/batch_params.py

Co-authored-by: Christina Lee <christina@xanadu.ai>

* Update pennylane/transforms/batch_params.py

Co-authored-by: Christina Lee <christina@xanadu.ai>

Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: Romain <rmoyard@gmail.com>
Co-authored-by: Christina Lee <christina@xanadu.ai>

* change example (#1875)

* `v0.19.0` release notes (#1852)

* pl + qchem versions

* draft release notes

* example + changelog-dev.md

* changelog-dev

* batch_params output

* shorten U decomp example to print well

* need orbitals kwarg when using hf_state as positional came after kwarg

* need orbitals kwarg when using hf_state as positional came after kwarg

* trainable params

* orphan

* contributors

* notes

* HF solver example

* HF solver example

* HF solver text

* doc item for #1724

* item for 1769

* doc item for #1792

* #1804, #1802

* #1824

* pyscf pin

* PR links

* resolve changelog (#1858)

Co-authored-by: agran2018 <45397799+agran2018@users.noreply.github.com>

* Update release_notes.md

* Apply HF wording suggestion from Josh

* fix batch params docstring

* update

* merge batch_params dim_output

* new shape for the output of the batch_params example

* Update doc/releases/changelog-0.19.0.md

Co-authored-by: Josh Izaac <josh146@gmail.com>

* transforms order change as suggested

* Update doc/releases/changelog-0.19.0.md

Co-authored-by: Josh Izaac <josh146@gmail.com>

* Update doc/releases/changelog-0.19.0.md

Co-authored-by: Josh Izaac <josh146@gmail.com>

* shorten ex as suggested

* shorten insert example

* move classical jac change to improvements as suggested

* Update doc/releases/changelog-0.19.0.md

Co-authored-by: Josh Izaac <josh146@gmail.com>

* Update doc/releases/changelog-0.19.0.md

Co-authored-by: Josh Izaac <josh146@gmail.com>

* Update doc/releases/changelog-0.19.0.md

Co-authored-by: Josh Izaac <josh146@gmail.com>

* move is_independent to improvements

* remove sentence as suggested

* Update doc/releases/changelog-0.19.0.md

Co-authored-by: Josh Izaac <josh146@gmail.com>

* Update doc/releases/changelog-0.19.0.md

Co-authored-by: Josh Izaac <josh146@gmail.com>

* change the order of the improvements based on the suggestions

* rephrase qml.grad/qml.jacobian deprecation date

* Update doc/releases/changelog-0.19.0.md

* no current release tag for v0.18.0

* no -dev

* fix

* fix

* correct GateFabric api link

* JAX interface as improvement

* create_expand_fn suggestion

* requires_grad.png

* GateFabric full path

Co-authored-by: agran2018 <45397799+agran2018@users.noreply.github.com>
Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: Romain <rmoyard@gmail.com>

* Tkt rc (#1870)

* changed readme and index tkt

* kept changelog

* Changed docs image

* Deleted changelog

* Apply suggestions from code review

Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: Nathan Killoran <co9olguy@users.noreply.github.com>

* removed readme tkt

* Removed readme

* README.md form release candidate

Co-authored-by: Catalina Albornoz <catalina@xanadu.ai>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: Nathan Killoran <co9olguy@users.noreply.github.com>

* contributors

* Update the norm check for `QubitStateVector` in `default.qubit` (v0.19.1) (#1924)

* norm check fix

* 0.19.1 changelog

* 0.19.1 bump

* pr number

* changelog for 0.19.1 in the release notes

* torch coerce change, qml.math for Hermitian

* test changes

* readd torch_device kwarg

* format

* use torch device arg and add cuda_was_set branch

* polish

* TestApply cover with torch_device; update the def for OrbitalRotation to be compatible with CUDA

* Add notes to tests using execute; CRX + CRY convert_like; Integration tests passing

* passthru test

* more tests

* format

* coerce refine + test

* tidy

* branch off for Torch

* def self._torch_device_requested and extend check in execute

* test and further adjustments

* format

* changelog

* Mark the kernel test not converging as xfail (#1918)

* mark the kernel test not converging as xfail

* format

* skipif

* skipif marker

* format

* changelog

* lint

* todo no longer relevant

* PauliRot identity matrix consider Torch

* format

* paulirot identity matrix test

* add gpu marker

* more torch_device usage

* more fixes with finite diff; update tests

* qml.math.allclose

* Move the state to device conversion from apply_operation to the execute method because it logically belongs there better

* Move the state to device conversion within if statement, add comment; change a test to avoid raising a warning

* format

* error message; gpu marker on the coercion test in qml.math; error matching

* format

* warning

* warning test

* no print

* format

* Fix parametric ops GPU compatibility (`v0.19.1`) (#1927)

* torch coerce change, qml.math for Hermitian

* test changes

* readd torch_device kwarg

* format

* use torch device arg and add cuda_was_set branch

* polish

* TestApply cover with torch_device; update the def for OrbitalRotation to be compatible with CUDA

* Add notes to tests using execute; CRX + CRY convert_like; Integration tests passing

* passthru test

* more tests

* format

* coerce refine + test

* tidy

* branch off for Torch

* def self._torch_device_requested and extend check in execute

* test and further adjustments

* format

* changelog

* Mark the kernel test not converging as xfail (#1918)

* mark the kernel test not converging as xfail

* format

* skipif

* skipif marker

* format

* changelog

* lint

* todo no longer relevant

* PauliRot identity matrix consider Torch

* format

* paulirot identity matrix test

* add gpu marker

* more torch_device usage

* more fixes with finite diff; update tests

* qml.math.allclose

* Move the state to device conversion from apply_operation to the execute method because it logically belongs there better

* Move the state to device conversion within if statement, add comment; change a test to avoid raising a warning

* format

* error message; gpu marker on the coercion test in qml.math; error matching

* format

* warning

* warning test

* no print

* format

* contributors for the bug fix release

* changelog

* Update doc/development/release_notes.md

* import order

* Update tests/devices/test_default_qubit_torch.py

* resolve conflicts

* remove _apply_operation as a whole

* use f string instead of format call to make codefactor happy

* use f string instead of format call in default.qubit to make codefactor happy

* more f strings; {} instead of dict()

* format

* PauliRot Torch run on CPU too to increase coverage

* format

Co-authored-by: dwierichs <davidwierichs@gmail.com>
Co-authored-by: Romain <rmoyard@gmail.com>
Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: Maria Schuld <mariaschuld@gmail.com>
Co-authored-by: Christina Lee <christina@xanadu.ai>
Co-authored-by: soranjh <40344468+soranjh@users.noreply.github.com>
Co-authored-by: Guillermo Alonso-Linaje <65235481+KetpuntoG@users.noreply.github.com>
Co-authored-by: agran2018 <45397799+agran2018@users.noreply.github.com>
Co-authored-by: CatalinaAlbornoz <albornoz.catalina@hotmail.com>
Co-authored-by: Catalina Albornoz <catalina@xanadu.ai>
Co-authored-by: Nathan Killoran <co9olguy@users.noreply.github.com>
@antalszava
Copy link
Contributor Author

[sc-11456]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@josh146 josh146 josh146 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@antalszava @josh146