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

Do not cast state to complex128 #5547

Merged
merged 15 commits into from
Apr 23, 2024
Merged

Do not cast state to complex128 #5547

merged 15 commits into from
Apr 23, 2024

Conversation

vincentmr
Copy link
Contributor

@vincentmr vincentmr commented Apr 19, 2024

Before submitting

Please complete the following checklist when submitting a PR:

  • All new features must include a unit test.
    If you've fixed a bug or added code that should be tested, add a test to the
    test directory!

  • All new functions and code must be clearly commented and documented.
    If you do make documentation changes, make sure that the docs build and
    render correctly by running make docs.

  • Ensure that the test suite passes, by running make test.

  • Add a new entry to the doc/releases/changelog-dev.md file, summarizing the
    change, and including a link back to the PR.

  • The PennyLane source code conforms to
    PEP8 standards.
    We check all of our code against Pylint.
    To lint modified files, simply pip install pylint, and then
    run pylint pennylane/path/to/file.py.

When all the above are checked, delete everything above the dashed
line and fill in the pull request template.


Context:
The LQ new device API does not preserve the dtype of measurement results,

import pennylane as qml
import numpy as np
dev = qml.device("lightning.qubit", wires=2, c_dtype=np.complex64)

@qml.qnode(dev)
def circ():
    return qml.state()

>>> circ().dtype
complex128

The issue comes from measurementprocess.process_state as this method changes the specified dtype to the default complex128.

Description of the Change:
Modify StateMP and DensityMatrixMP avoiding explicitly casting to complex128, relying on the various frameworks casting rules, by adding 0.0j. This does not work in TensorFlow for which the current behaviour is preserved.

Benefits:

Possible Drawbacks:

Related GitHub Issues:
[sc-60855]

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.

@vincentmr vincentmr marked this pull request as ready for review April 22, 2024 13:04
Copy link

codecov bot commented Apr 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.68%. Comparing base (a8bba50) to head (14bf29f).
Report is 5 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5547      +/-   ##
==========================================
- Coverage   99.69%   99.68%   -0.01%     
==========================================
  Files         410      410              
  Lines       38230    37943     -287     
==========================================
- Hits        38113    37825     -288     
- Misses        117      118       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mudit2812 mudit2812 self-requested a review April 23, 2024 17:53
Copy link
Contributor

@mudit2812 mudit2812 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! One open question, otherwise ready to approve.

tests/devices/test_lightning_qubit.py Outdated Show resolved Hide resolved
Copy link
Member

@maliasadi maliasadi left a comment

Choose a reason for hiding this comment

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

🙌

pennylane/measurements/state.py Show resolved Hide resolved
@vincentmr vincentmr merged commit f834328 into master Apr 23, 2024
38 checks passed
@vincentmr vincentmr deleted the feature/state_no_cast branch April 23, 2024 22:05
vincentmr added a commit that referenced this pull request Jul 17, 2024
### Before submitting

Please complete the following checklist when submitting a PR:

- [x] All new features must include a unit test.
If you've fixed a bug or added code that should be tested, add a test to
the
      test directory!

- [x] All new functions and code must be clearly commented and
documented.
If you do make documentation changes, make sure that the docs build and
      render correctly by running `make docs`.

- [x] Ensure that the test suite passes, by running `make test`.

- [x] Add a new entry to the `doc/releases/changelog-dev.md` file,
summarizing the
      change, and including a link back to the PR.

- [x] The PennyLane source code conforms to
      [PEP8 standards](https://www.python.org/dev/peps/pep-0008/).
We check all of our code against [Pylint](https://www.pylint.org/).
      To lint modified files, simply `pip install pylint`, and then
      run `pylint pennylane/path/to/file.py`.

When all the above are checked, delete everything above the dashed
line and fill in the pull request template.


------------------------------------------------------------------------------------------------------------

**Context:**
The changes made in #5547 led to a performance regression in Lightning
because a superfluous state vector copy is made when adding `0.j`, which
was introduced to cast the output to complex.

**Description of the Change:**
Use `qml.math.cast` instead.

**Benefits:**
Avoid unnecessary sum of `0.j`

**Possible Drawbacks:**

**Related GitHub Issues:**
[sc-65127]
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.

4 participants