Add Hermitian Support for Finite-Shot Measurement Statistics #451
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -136,7 +136,7 @@ jobs: | |||||
|
|
||||||
| - name: Install Dependencies (Python) | ||||||
| run: | | ||||||
| python${{ matrix.python_version }} -m pip install wheel numpy pybind11 PyYAML scipy | ||||||
|
|
||||||
| # Required for MHLO and building MLIR with protected symbols. | ||||||
| # (Don't forget to add the build directory to PATH in subsequent steps, so | ||||||
|
|
@@ -230,7 +230,7 @@ jobs: | |||||
|
|
||||||
| - name: Install Dependencies (Python) | ||||||
| run: | | ||||||
| python${{ matrix.python_version }} -m pip install wheel numpy pybind11 PyYAML scipy | ||||||
|
|
||||||
| - name: Get Cached LLVM Source | ||||||
| id: cache-llvm-source | ||||||
|
|
@@ -285,13 +285,14 @@ jobs: | |||||
| # Build Catalyst-Runtime | ||||||
| - name: Build Catalyst-Runtime | ||||||
| run: | | ||||||
| # TODO: Remove tmp tag 'add_dldso' before merge | ||||||
| cmake -S runtime -B runtime-build -G Ninja \ | ||||||
| -DCMAKE_BUILD_TYPE=Release \ | ||||||
| -DCMAKE_LIBRARY_OUTPUT_DIRECTORY=$GITHUB_WORKSPACE/runtime-build/lib \ | ||||||
| -DPYTHON_EXECUTABLE=$(which python${{ matrix.python_version }}) \ | ||||||
| -Dpybind11_DIR=$(python${{ matrix.python_version }} -c "import pybind11; print(pybind11.get_cmake_dir())") \ | ||||||
| -DENABLE_LIGHTNING_KOKKOS=ON \ | ||||||
| -DLIGHTNING_GIT_TAG="add_dldso" \ | ||||||
|
There was a problem hiding this comment. Just leaving a comment here about our procedure to target development versions of lightning:
This ensures that the main branch of Catalyst builds reproducibly and correctly for CI & developers. |
||||||
| -DKokkos_ENABLE_SERIAL=ON \ | ||||||
| -DKokkos_ENABLE_OPENMP=ON \ | ||||||
| -DENABLE_WARNINGS=OFF \ | ||||||
|
|
@@ -356,7 +357,12 @@ jobs: | |||||
| name: Test Wheels (Python ${{ matrix.python_version }}) on ${{ matrix.os }} | ||||||
| runs-on: ${{ matrix.os }} | ||||||
|
|
||||||
| steps: | ||||||
| - name: Set up Python ${{ matrix.python_version }} | ||||||
| uses: actions/setup-python@v4 | ||||||
| with: | ||||||
| python-version: ${{ matrix.python_version }} | ||||||
|
|
||||||
| - name: Checkout Catalyst repo | ||||||
| uses: actions/checkout@v3 | ||||||
|
|
||||||
|
|
@@ -366,14 +372,9 @@ jobs: | |||||
| name: catalyst-manylinux2014_x86_64-wheel-py-${{ matrix.python_version }}.zip | ||||||
| path: dist | ||||||
|
|
||||||
| - name: Install Python dependencies | ||||||
| run: | | ||||||
| python${{ matrix.python_version }} -m pip install pytest pytest-xdist scipy | ||||||
|
There was a problem hiding this comment. I'm hesitant whether this is needed here (and in fact may be detrimental). At this point we are testing the built package, any (mandatory) dependencies should be handled by the package itself, and we should only install testing requirements or optional feature dependencies here.
Suggested change
|
||||||
|
|
||||||
| - name: Install PennyLane Plugins | ||||||
| run: | | ||||||
|
|
||||||
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -44,6 +44,10 @@ | |
| `DIAGNOSTICS_RESULTS_PATH=/path/to/file.yml`. | ||
| [(#528)](https://github.com/PennyLaneAI/catalyst/pull/528) | ||
|
|
||
| * Catalyst now supports `qml.expval` and `qml.var` of `qml.Hermitian` observables | ||
| when finite shots are specified. | ||
| [(#451)](https://github.com/PennyLaneAI/catalyst/pull/451) | ||
|
|
||
| <h3>Improvements</h3> | ||
|
|
||
| * An updated quantum device specification format is now supported by Catalyst. The toml schema 2 | ||
|
|
@@ -666,7 +670,8 @@ Haochen Paul Wang. | |
| This release contains contributions from (in alphabetical order): | ||
|
|
||
| Ali Asadi, | ||
| David Ittah, | ||
| Shuli Shu. | ||
|
|
||
| # Release 0.4.0 | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -124,25 +124,26 @@ def circuit(): | |
| result = qjit(circuit)() | ||
| assert np.allclose(result, expected, atol=tol_stochastic, rtol=tol_stochastic) | ||
|
|
||
| def test_hermitian(self, backend, tol_stochastic): | ||
| """Test expval Hermitian observables with shots.""" | ||
| n_wires = 3 | ||
| n_shots = 10000 | ||
| dev = qml.device(backend, wires=n_wires, shots=n_shots) | ||
|
|
||
| @qml.qnode(dev) | ||
| def circuit(x, y): | ||
| qml.RX(x, wires=0) | ||
| qml.RX(y, wires=1) | ||
| qml.CNOT(wires=[0, 1]) | ||
| A = np.array( | ||
| [[complex(1.0, 0.0), complex(2.0, 0.0)], [complex(2.0, 0.0), complex(1.0, 0.0)]] | ||
| ) | ||
| return qml.expval(qml.Hermitian(A, wires=2)) | ||
|
|
||
| expected = circuit(np.pi / 4, np.pi / 4) | ||
| result = qjit(circuit)(np.pi / 4, np.pi / 4) | ||
|
|
||
| assert np.allclose(result, expected, atol=tol_stochastic, rtol=tol_stochastic) | ||
|
|
||
| def test_paulix_pauliy(self, backend, tol_stochastic): | ||
| """Test that a tensor product involving PauliX and PauliY works correctly""" | ||
|
|
@@ -332,25 +333,26 @@ def circuit(): | |
| result = qjit(circuit)() | ||
| assert np.allclose(result, expected, atol=tol_stochastic, rtol=tol_stochastic) | ||
|
|
||
| def test_hermitian_shots(self, backend, tol_stochastic): | ||
| """Test var Hermitian observables with shots.""" | ||
| n_wires = 3 | ||
| n_shots = 10000 | ||
| dev = qml.device(backend, wires=n_wires, shots=n_shots) | ||
|
|
||
| @qml.qnode(dev) | ||
| def circuit(x, y): | ||
| qml.RX(x, wires=0) | ||
| qml.RX(y, wires=1) | ||
| qml.CNOT(wires=[0, 1]) | ||
| A = np.array( | ||
| [[complex(1.0, 0.0), complex(2.0, 0.0)], [complex(2.0, 0.0), complex(1.0, 0.0)]] | ||
| ) | ||
| return qml.var(qml.Hermitian(A, wires=2)) | ||
|
|
||
| expected = circuit(np.pi / 4, np.pi / 4) | ||
| result = qjit(circuit)(np.pi / 4, np.pi / 4) | ||
|
|
||
| assert np.allclose(result, expected, atol=tol_stochastic, rtol=tol_stochastic) | ||
|
|
||
| def test_paulix_pauliy(self, backend, tol_stochastic): | ||
| """Test that a tensor product involving PauliX and PauliY works correctly""" | ||
|
|
@@ -472,6 +474,23 @@ def circuit(theta): | |
| result = qjit(circuit)(0.432) | ||
| assert np.allclose(result, expected, atol=tol_stochastic, rtol=tol_stochastic) | ||
|
|
||
| # TODO: Support probs with observables | ||
| def test_probs_obs(self, backend): | ||
| """Test probs with an observable""" | ||
|
|
||
| n_wires = 1 | ||
| n_shots = 10000 | ||
| dev = qml.device(backend, wires=n_wires, shots=n_shots) | ||
|
|
||
| matrix = 1 / np.sqrt(2) * np.array([[1, 1], [1, -1]]) | ||
|
|
||
| @qml.qnode(dev) | ||
| def circuit(theta): | ||
| qml.RX(theta, wires=[0]) | ||
| return qml.probs(op=qml.Hermitian(matrix, wires=0)) | ||
|
|
||
| with pytest.raises(AssertionError): | ||
| qjit(circuit)(0.432) | ||
|
|
||
| class TestOtherMeasurements: | ||
| """Test other measurement processes.""" | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,7 @@ pip>=22.3 # Due to a bug in `pip install -e .` vs read-only system-wide site-pac | |
| numpy | ||
| pybind11>=2.8.0 | ||
| PyYAML | ||
| scipy | ||
|
|
||
| # formatting/linting | ||
| black | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just double checking because these are build-time dependencies. Is
scipya built-time dependency if we are going the dynamic loading approach?