Consider adding a warning when a cudaq.State is used as a buffer, causing copying of the state to host
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 1.1k
- Forks
- 456
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 165
Description
Required prerequisites
- Consult the security policy. If reporting a security vulnerability, do not report the bug using this form. Use the process described in the policy to report the issue.
- Make sure you've read the documentation. Your issue may be addressed there.
- Search the issue tracker to verify that this hasn't already been reported. +1 or comment there if it has.
- If possible, make a PR with a failing test to give us a starting point to work on!
Describe the bug
Some python statements cause cudaq.State act to as a buffer, causing copying of the data from the device to the host. Should we add a warning in those cases?
Steps to reproduce the bug
import numpy as np
import cudaq
c = np.array([1, 2j, 3, 4j, 5, 6j, 7, 8j], dtype=np.complex64)
state = cudaq.State.from_data(c)
state = state/np.linalg.norm(state) # Copies the state to host twice
@cudaq.kernel
def kernel(vec: list[complex]):
q = cudaq.qvector(vec)
counts = cudaq.sample(kernel, c)
print(counts)
Expected behavior
Output a warning when we copy data to the host (if possible, with the source information)
Is this a regression? If it is, put the last known working version (or commit) here.
Not a regression
Environment
- CUDA Quantum version:
- Python version:
- C++ compiler:
- Operating system:
Suggestions
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the cudaq.State.from_data path and the Python buffer conversions exercised by state/np.linalg.norm(state) and cudaq.sample(kernel, c). Reproduce the device-to-host copies, then determine where a warning can include source information. Done means the warning appears for these cases without incorrectly warning on ordinary use, with regression coverage for the reported examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- numpy, python
- Domain
- performance
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100