Add deprecation warning for default.tensor #1851
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hello. You may have forgotten to update the changelog!
|
|
@antalszava can we sneak this into the current release? And should I delete the device's tests, that are now raising warnings? |
josh146
approved these changes
Nov 4, 2021
There was a problem hiding this comment.
thanks @mariaschuld! Don't forget to also include this in the 'deprecations' section of the changelog
Codecov Report
@@ Coverage Diff @@
## v0.19.0-rc0 #1851 +/- ##
==============================================
Coverage ? 98.96%
==============================================
Files ? 218
Lines ? 16377
Branches ? 0
==============================================
Hits ? 16208
Misses ? 169
Partials ? 0 Continue to review full report at Codecov.
|
Oh I just got the email reminder :) |
antalszava
approved these changes
Nov 4, 2021
| @@ -925,6 +925,10 @@ | |||
|
|
|||
| <h3>Deprecations</h3> | |||
|
|
|||
| * The `default.tensor` device from the beta folder has not been maintained in | |||
There was a problem hiding this comment.
Just to make sure, the same with default.tensor.tf, right?
There was a problem hiding this comment.
Well, it is kind of a subcase of default.tensor so I think it is included here?
Co-authored-by: antalszava <antalszava@gmail.com>
josh146
added a commit
that referenced
this pull request
Nov 9, 2021
* 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> * Re-add the dev changelog to the release notes * tests/transforms/test_batch_params.py from master * use {} for dicts to make codecov happy * update batch params 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>
josh146
added a commit
that referenced
this pull request
Nov 29, 2021
* 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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context:
The
default.tensordevice has never been moved out of the beta folder, and uses a very old device API (that would have to be reassessed in the upcoming device class refactor) as well as old tests (that would have to be rewritten for the current operator class refactor).We therefore decided to deprecate the device rather than maintaining it.
Description of the Change:
Raises a deprecation warning if the device is loaded.
Benefits:
We have plans to use more powerful tensor simulators to build devices in future.
Possible Drawbacks:
At the moment there is no alternative device we can guide users towards.