-
Notifications
You must be signed in to change notification settings - Fork 558
/
sample.py
157 lines (121 loc) · 6.16 KB
/
sample.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
# Copyright 2018-2021 Xanadu Quantum Technologies Inc.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# pylint: disable=protected-access
"""
This module contains the qml.sample measurement.
"""
import warnings
from typing import Tuple, Union
import numpy as np
import pennylane as qml
from pennylane.operation import Observable
from pennylane.wires import Wires
from .measurements import MeasurementProcess, Sample
def sample(op: Union[Observable, None] = None, wires=None):
r"""Sample from the supplied observable, with the number of shots
determined from the ``dev.shots`` attribute of the corresponding device,
returning raw samples. If no observable is provided then basis state samples are returned
directly from the device.
Note that the output shape of this measurement process depends on the shots
specified on the device.
Args:
op (Observable or None): a quantum observable object
wires (Sequence[int] or int or None): the wires we wish to sample from, ONLY set wires if
op is ``None``
Raises:
QuantumFunctionError: `op` is not an instance of :class:`~.Observable`
ValueError: Cannot set wires if an observable is provided
The samples are drawn from the eigenvalues :math:`\{\lambda_i\}` of the observable.
The probability of drawing eigenvalue :math:`\lambda_i` is given by
:math:`p(\lambda_i) = |\langle \xi_i | \psi \rangle|^2`, where :math:`| \xi_i \rangle`
is the corresponding basis state from the observable's eigenbasis.
**Example**
.. code-block:: python3
dev = qml.device("default.qubit", wires=2, shots=4)
@qml.qnode(dev)
def circuit(x):
qml.RX(x, wires=0)
qml.Hadamard(wires=1)
qml.CNOT(wires=[0, 1])
return qml.sample(qml.PauliY(0))
Executing this QNode:
>>> circuit(0.5)
array([ 1., 1., 1., -1.])
If no observable is provided, then the raw basis state samples obtained
from device are returned (e.g., for a qubit device, samples from the
computational device are returned). In this case, ``wires`` can be specified
so that sample results only include measurement results of the qubits of interest.
.. code-block:: python3
dev = qml.device("default.qubit", wires=2, shots=4)
@qml.qnode(dev)
def circuit(x):
qml.RX(x, wires=0)
qml.Hadamard(wires=1)
qml.CNOT(wires=[0, 1])
return qml.sample()
Executing this QNode:
>>> circuit(0.5)
array([[0, 1],
[0, 0],
[1, 1],
[0, 0]])
.. note::
QNodes that return samples cannot, in general, be differentiated, since the derivative
with respect to a sample --- a stochastic process --- is ill-defined. The one exception
is if the QNode uses the parameter-shift method (``diff_method="parameter-shift"``), in
which case ``qml.sample(obs)`` is interpreted as a single-shot expectation value of the
observable ``obs``.
"""
if op is not None and not op.is_hermitian: # None type is also allowed for op
warnings.warn(f"{op.name} might not be hermitian.")
if wires is not None:
if op is not None:
raise ValueError(
"Cannot specify the wires to sample if an observable is "
"provided. The wires to sample will be determined directly from the observable."
)
wires = Wires(wires)
return _Sample(Sample, obs=op, wires=wires)
# TODO: Make public when removing the ObservableReturnTypes enum
class _Sample(MeasurementProcess):
"""Measurement process that returns the samples of a given observable."""
def process(self, samples: np.ndarray, shot_range: Tuple[int] = None, bin_size: int = None):
name = self.obs.name if self.obs is not None else None
# Select the samples from samples that correspond to ``shot_range`` if provided
if shot_range is not None:
# Indexing corresponds to: (potential broadcasting, shots, wires). Note that the last
# colon (:) is required because shots is the second-to-last axis and the
# Ellipsis (...) otherwise would take up broadcasting and shots axes.
samples = samples[..., slice(*shot_range), :]
if len(self.wires) != 0:
# if wires are provided, then we only return samples from those wires
samples = samples[..., np.array(self.wires)]
num_wires = samples.shape[-1] # wires is the last dimension
if self.obs is None:
# if no observable was provided then return the raw samples
return samples if bin_size is None else samples.reshape(num_wires, bin_size, -1)
if name in {"PauliX", "PauliY", "PauliZ", "Hadamard"}:
# Process samples for observables with eigenvalues {1, -1}
samples = 1 - 2 * qml.math.squeeze(samples)
else:
# Replace the basis state in the computational basis with the correct eigenvalue.
# Extract only the columns of the basis samples required based on ``wires``.
powers_of_two = 2 ** np.arange(num_wires)[::-1]
indices = samples @ powers_of_two
indices = np.array(indices) # Add np.array here for Jax support.
try:
samples = self.obs.eigvals()[indices]
except qml.operation.EigvalsUndefinedError as e:
# if observable has no info on eigenvalues, we cannot return this measurement
raise qml.operation.EigvalsUndefinedError(
f"Cannot compute samples of {self.obs.name}."
) from e
return samples if bin_size is None else samples.reshape((bin_size, -1))