Daily rc sync to master 2022-08-15 (#2952)

* Update the Hermiticity check of `qml.Hermitian` to use `qml.math` (#2895)

* fix

* changelog

* lint

* important typo fix (#2901)

* test lightning (#2903)

* Update the readme and PennyLane Logo (#2912)

* Update PennyLane Logo

* remove wordmark from readme

* update citation

* et al

* Update the logo

* replace with svg

* Add warning to `qml.cond` docs about unsupported cases (#2883)

* docs

* docs

* `qml.simplify` can reduce number of rotation parameters (#2905)

* move rotation simplify into op method

* add additional example

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

* seed and flaky (#2917)

* Fixes a bug where kUpCCGSD wasn't working with the parameter-shift rule (#2913)

* First commit

* Added PR link

* More accurate description in changelog

* Test PS rule against backprop

* Fixed error with test

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

* Add module documentation for `ops` (#2730)

* Update phase decomp test (#2697)

* Update interfaces.rst (#2698)

* Allow templates to be decomposed (#2704)

* Allow templates to be decomposed

* Add TODO to clean

* Update changelog

* Fix pylint error

Co-authored-by: Edward Jiang <edward.jiang@resident.xanadu.ai>

* Deprecate `qml.ExpvalCost` (#2571)

* Add UserWarning to ExpvalCost and catch said warning in all tests containing ExpvalCost

* added warning in doc string

* added to the changelog in 0.23.1

* Update pennylane/vqe/vqe.py

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

* Update pennylane/vqe/vqe.py

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

* Update pennylane/vqe/vqe.py

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

* Update pennylane/vqe/vqe.py

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

* Update tests/optimize/test_qng.py

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

* Update tests/qchem/of_tests/test_convert.py

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

* Update tests/test_qaoa.py

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

* Update tests/test_vqe.py

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

* Update tests/transforms/test_adjoint_metric_tensor.py

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

* Update tests/optimize/test_optimize_shot_adapative.py

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

* overlooked to catch the new warning in test_dipole_of

* switched to the right changelog

Co-authored-by: Qottmann <qottmann@LT0290.ad.icfo.net>
Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: Romain Moyard <rmoyard@gmail.com>

* Update JAX jit forward mode forward evaluation (#2700)

* update logic

* update logic

* test case

* test assertion

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

* Improve ising gates documentation (#2711)

* Update doc

* Update

* Update pennylane/ops/qubit/parametric_ops.py

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

* Apply suggestions from code review

* CHange

* Typo

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

* Support classical fisher gradients when using Autograd (#2688)

* Support classical fisher gradients when using Autograd

* Update doc/releases/changelog-dev.md

* added test for jax and autograd

* black

* added xfail tests

* added comment in doc string about torch and tf not diffable

Co-authored-by: Qottmann <korbinian.kottmann@gmail.com>
Co-authored-by: Romain Moyard <rmoyard@gmail.com>

* Support classical Fisher gradients when using TF and torch (#2710)

* Support classical fisher gradients when using Autograd

* Update doc/releases/changelog-dev.md

* added test for jax and autograd

* black

* added xfail tests

* added comment in doc string about torch and tf not diffable

* Fix differentiability for tensorflow and torch

* Remove warning

* Fix TF not iterable error

* Trigger CI

* added example in doc-string about diffability

* close-block becomes code-block lol

* Update pennylane/qinfo/transforms.py

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

* Change pytest mark

Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: Qottmann <korbinian.kottmann@gmail.com>
Co-authored-by: Romain Moyard <rmoyard@gmail.com>

* Remove `hardware` argument in `qml.qinfo.quantum_fisher` (#2695)

* removed hardware argument, adapted doc string

* updated tests

* black

* Update pennylane/qinfo/transforms.py

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

* Update pennylane/qinfo/transforms.py

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

* add default.qubit condition and change doc string

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

* Add `qinfo` measurements in supported configurations docs (#2712)

* Add documentation for new qinfo measurements

* Add docs for finite diff

* Fix JAX tests

* Change param shift to red

* Move entropy param shift tests

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

* Use access_state (#2719)

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

* Update docs v0.24 (#2724)

* private func has no indices arg

* update the circuit name in the example

* reduced_dm doc update

* correct Hamiltonian creation for classical Fisher

* Delete exactly one space from reduced_dm docstring to correct rendering

* Update outputting quantum_fisher example

* Move summary to start (#2727)

* add ops module section

* only include functions and op_math

* added weights initialization example (#2735)

* Wires not updated for a hamiltonian with in-place addition (#2738)

* fixed hamiltonian wire bug

* changelog

* try other way

* Cleanup docs (#2736)

* Documentation changes for `batch_partial` (#2737)

* Update docs

* Add double backticks

* Add other backtick :xd:

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

* Fix sphinx class/method links (#2729)

Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>

* trying something else

* Fix rendering of matrix rep of ECR (#2741)

* fix rendering of matrix rep of ECR

* lint

* trigger ci

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

* Fix doc quantum information and ising (#2732)

* Ising doc

* Move entropy test

* Math doc

* Measurement doc

* qinfo doc

* Update pennylane/qinfo/transforms.py

Co-authored-by: Edward Jiang <34989448+eddddddy@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Edward Jiang <34989448+eddddddy@users.noreply.github.com>

* Update pennylane/math/quantum.py

* Update

* Fix kwargs for fidelity (#2740)

* update

* Typo

* Update pennylane/qinfo/transforms.py

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

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

* Reduced dm

* Apply suggestions from code review

Co-authored-by: Edward Jiang <34989448+eddddddy@users.noreply.github.com>

* remove reduce dm

Co-authored-by: Edward Jiang <34989448+eddddddy@users.noreply.github.com>
Co-authored-by: Christina Lee <christina@xanadu.ai>

* hope

* Add quantum info measurements to introduction doc page (#2734)

* add quantum info measurements to introduction page

* minor doc fixes

* more minor fixes

* revert kwargs change

* Apply suggestions from code review

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

* maybe this time

* probably not going to work but worth a try

* Apply suggestions from code review

Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>

* update with master

* updates

* merge something

* update docstring

* line length problem

* fix controlled signature

* fix s_prod

* add control class notes

* update docs for Sprod and Sum

* typo

* small fix

* fixing docs

* added pragma no-cover to signature property

* Apply suggestions from code review

* clean up

* fix sprod demo

* add info to quick start operations guide

* typo

* added example

* re-link top level imports to prevent duplication of docstring pages generated by sphinx

* typo

* change constructor imports to toplevel

* Apply suggestions from code review

* add equal to ops.functions docstring

* Update doc/introduction/operations.rst

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

* Update pennylane/ops/op_math/controlled_class.py

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

* Update pennylane/ops/op_math/sum.py

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

* lint

Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: Edward Jiang <34989448+eddddddy@users.noreply.github.com>
Co-authored-by: Edward Jiang <edward.jiang@resident.xanadu.ai>
Co-authored-by: Korbinian Kottmann <43949391+Qottmann@users.noreply.github.com>
Co-authored-by: Qottmann <qottmann@LT0290.ad.icfo.net>
Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: Romain Moyard <rmoyard@gmail.com>
Co-authored-by: Qottmann <korbinian.kottmann@gmail.com>
Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>
Co-authored-by: David Ittah <dime10@users.noreply.github.com>

* Fix check batching bug (#2900)

* check batching only if batching supported

* Update doc/releases/changelog-0.25.0.md

* just change op arithmetic properties

* just raise errors

* Update pennylane/operation.py

* modify has_matrix and matrix

* remove test

* Update tests/ops/op_math/test_controlled_op.py

* Update tests/ops/op_math/test_sprod.py

Co-authored-by: David Wierichs <davidwierichs@gmail.com>

* prod tests, controlled name

* more interface tests

Co-authored-by: David Wierichs <davidwierichs@gmail.com>

* Update development guide to explain `dev.stopping.condition` (#2925)

* update developer docs to reflect default qubit change

* typo

* Update doc/development/adding_operators.rst

* add code examples

* Fix test randomness for `ShotAdaptiveOptimizer` (#2929)

* return types

* Update test

* Typo

* State finite shots warn (#2918)

* first draft to gauge test failures

* skip config tests when finite shots and state based return

* skip tape shape test cases

* device test

* updated device test

* new return types tests

* remove errors, catch the warnings

* changelog

* run tests

Co-authored-by: Albert Mitjans <a.mitjanscoma@gmail.com>

* Add a test for logic that accidentally got in untested (#2930)

* add test

* Trigger CI

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

* Fix symbolic `Controlled` operator documentation (#2934)

* Minor documentation fixes (#2933)

* native instead of propriertary

* misc documentation fixes

* Update doc/introduction/measurements.rst

* remove do_queue from adjoint docstring

* docs: 📝 Fix docstring. (#2941)

* Fix-docs (#2942)

* docs: 📝 Fix docstring.

* docs: 📝 Fix docstring.

* Set is_sampled to True when using Counts return type (#2928)

* fix (Tape): 🐛 Set is_sampled to True when using Counts return type.

* fix (Device): 🐛 Fix Counts check.

* test: 🧪 Adapt tests.

* chore (changelog): ✏️ Add feature to changelog.

* test: 🧪 Delete duplicated import.

* test: 🧪 Add test.

* Update doc/releases/changelog-0.25.0.md

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

Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>
Co-authored-by: Romain Moyard <rmoyard@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>

* Modify resource docs (#2944)

* `qml.equal` considers in-place inversion. (#2947)

* equal considers inversion

* Update doc/releases/changelog-0.25.0.md

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

* Fix docker & update pypi uploader (#2936)

* return types

* Typoo

* Typo

* Update uploader

* needs update

* Return tests.

* typoo

* update examples for prod (#2948)

* Update `qml.math.allclose` to work for trainable Torch tensors (motivated by `qml.equal`) (#2937)

* docs updates; fix qml.equal Torch Runtime Error issue for requires_grad=True

* revert tests/math/test_functions.py

* test allclose with trainable Torch Tensor

* revert removing a test; update tests based on review

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

* Update `qml.Flipsign` docs example (#2949)

* formatting the flipsign example

* example return type

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

* Release notes `v0.25.0` (#2902)

* return types

* Typo

* Update doc/releases/changelog-0.25.0.md

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

* Suggestion form Antal

* Update doc/releases/changelog-0.25.0.md

Co-authored-by: Isaac De Vlugt <34751083+isaacdevlugt@users.noreply.github.com>

* Suggestions

* chore (changelog): ✏️ Fix PR link.

* Moved new return type into another new feature section

* Minor

* Minor

* Updated Op-Arithmetic changelog

* Op arithmetic and re-did previous commits that were undone

* Moved item to improvements

* Controlled class feature shuffled, code example added

* Minor

* Double check names and PRs

* minor

* stopping condition breaking change

* Minor typos and shuffled one entry into Op arithmetic

* Removed hyperlinks to docs for formatting

* Apply suggestions from Josh's code review

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

* add details for hf deprecation

* Suggestions from Josh's review

* minor

* Simpler PS broadcast example

* Minor

* Fix broken link

* Check examples new features

* Flipsign

* Image update for param shift broadcast speedup

* Controlled update

* Minor change to code example for FirstQuantization

* Minor

* Controlled entry

* Josh's suggestion

* Apply suggestions from Josh's code review

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

Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: Isaac De Vlugt <34751083+isaacdevlugt@users.noreply.github.com>
Co-authored-by: AlbertMitjans <a.mitjanscoma@gmail.com>
Co-authored-by: Isaac De Vlugt <isaacdevlugt@gmail.com>
Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>
Co-authored-by: albi3ro <chrissie.c.l@gmail.com>
Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: soranjh <soranjh@yahoo.com>

* Doc for `enable_return` and `disable_return` (#2950)

* return types

* Add doc

* typo

* Update pennylane/return_types.py

* Typo

* Update

* Typo

* Update pennylane/return_types.py

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

* Update pennylane/return_types.py

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

* Update pennylane/return_types.py

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

* New try

* Trigger CI

* replace pycon

* Apply suggestions from code review

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

* remove python

* return

* Apply suggestions from code review

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

* exclude files from pr

Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: David Wierichs <davidwierichs@gmail.com>
Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: Christina Lee <christina@xanadu.ai>
Co-authored-by: Romain Moyard <rmoyard@gmail.com>
Co-authored-by: Isaac De Vlugt <34751083+isaacdevlugt@users.noreply.github.com>
Co-authored-by: Edward Jiang <34989448+eddddddy@users.noreply.github.com>
Co-authored-by: Edward Jiang <edward.jiang@resident.xanadu.ai>
Co-authored-by: Korbinian Kottmann <43949391+Qottmann@users.noreply.github.com>
Co-authored-by: Qottmann <qottmann@LT0290.ad.icfo.net>
Co-authored-by: Qottmann <korbinian.kottmann@gmail.com>
Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>
Co-authored-by: David Ittah <dime10@users.noreply.github.com>
Co-authored-by: Albert Mitjans <a.mitjanscoma@gmail.com>
Co-authored-by: soranjh <40344468+soranjh@users.noreply.github.com>
Co-authored-by: Isaac De Vlugt <isaacdevlugt@gmail.com>
Co-authored-by: albi3ro <chrissie.c.l@gmail.com>
Co-authored-by: soranjh <soranjh@yahoo.com>
Co-authored-by: GitHub Actions Bot <>

.github/workflows/upload.yml

@@ -121,7 +121,7 @@ jobs:
         run: |
           python -m pytest tests -m all_interfaces -n auto
 
-  qcut:
+  qcut-tests:
     runs-on: ubuntu-latest
 
     steps:
@@ -166,7 +166,7 @@ jobs:
         run: |
           python -m pytest tests -m qcut -n auto
 
-  qchem:
+  qchem-tests:
     runs-on: ubuntu-latest
 
     steps:
@@ -204,6 +204,49 @@ jobs:
         run: |
           python -m pytest tests -m qchem -n auto
 
+  # Testing the new return types suite
+  return-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.4.1
+        with:
+          access_token: ${{ github.token }}
+
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip && pip install wheel --upgrade
+          pip install -r requirements-ci.txt --upgrade
+          pip install -r requirements-dev.txt --upgrade
+
+      - name: Install PyTorch
+        run: pip3 install torch==$TORCH_VERSION -f https://download.pytorch.org/whl/torch_stable.html
+
+      - name: Install TensorFlow
+        run: pip3 install tensorflow~=$TF_VERSION keras~=$TF_VERSION
+
+      - name: Install JAX
+        run: pip3 install jax jaxlib
+
+      - name: Install PennyLane
+        run: |
+          python setup.py bdist_wheel
+          pip install dist/PennyLane*.whl
+
+      - name: Run tests
+        run: |
+          python -m pytest tests/returntypes -n auto
+
   device-tests:
     runs-on: ubuntu-latest
 
@@ -263,7 +306,7 @@ jobs:
   upload:
     runs-on: ubuntu-latest
     # Make sure that the PennyLane is not released unless the tests are passing.
-    needs: [core-and-interface-tests, all-interfaces-tests, qcut, qchem, device-tests]
+    needs: [core-and-interface-tests, all-interfaces-tests, qcut-tests, qchem-tests, return-tests, device-tests]
     steps:
       - uses: actions/checkout@v2
         with: