Skip to content

Commit

Permalink
Add shots.bins() generator method (#5476)
Browse files Browse the repository at this point in the history
**Context:**
The current approach for sampling multiple shots involves handling shot
vectors by sampling multiple times and processing each shot
independently. However, a more efficient strategy would be to sample all
shots at once and then process each bin separately. The `shots.bins()`
method facilitates this by providing the lower and upper bounds for each
bin.

**Description of the Change:**
- The `shots.bins()` method generates a sequence of tuples, where each
tuple represents the lower and upper bounds of a bin.
- In `_measure_with_samples_diagonalizing_gates` sample once with total
number of shots and use `shots.bins()` to process each bin separately

**Benefits:**
This method is particularly useful for processing shot quantities in a
partitioned manner, as it allows for the separate handling of each bin's
range

**Possible Drawbacks:**

**Related GitHub Issues:**
Fixes #5433

---------

Co-authored-by: Christina Lee <[email protected]>
Co-authored-by: Christina Lee <[email protected]>
Co-authored-by: Nathan Killoran <[email protected]>
  • Loading branch information
4 people authored Apr 18, 2024
1 parent ca9637a commit 016d2cc
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 28 deletions.
3 changes: 3 additions & 0 deletions doc/releases/changelog-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,9 @@
* Removed the warning that an observable might not be hermitian in `qnode` executions. This enables jit-compilation.
[(#5506)](https://github.com/PennyLaneAI/pennylane/pull/5506)

* Implement `Shots.bins()` method.
[(#5476)](https://github.com/PennyLaneAI/pennylane/pull/5476)

<h3>Breaking changes 💔</h3>

* Operator dunder methods now combine like-operator arithmetic classes via `lazy=False`. This reduces the chance of `RecursionError` and makes nested
Expand Down
35 changes: 9 additions & 26 deletions pennylane/devices/qubit/sampling.py
Original file line number Diff line number Diff line change
Expand Up @@ -268,31 +268,6 @@ def _process_single_shot(samples):

return tuple(processed)

# if there is a shot vector, build a list containing results for each shot entry
if shots.has_partitioned_shots:
processed_samples = []
for s in shots:
# currently we call sample_state for each shot entry, but it may be
# better to call sample_state just once with total_shots, then use
# the shot_range keyword argument
try:
samples = sample_state(
state,
shots=s,
is_state_batched=is_state_batched,
wires=wires,
rng=rng,
prng_key=prng_key,
)
except ValueError as e:
if str(e) != "probabilities contain NaN":
raise e
samples = qml.math.full((s, len(wires)), 0)

processed_samples.append(_process_single_shot(samples))

return tuple(zip(*processed_samples))

try:
samples = sample_state(
state,
Expand All @@ -307,7 +282,15 @@ def _process_single_shot(samples):
raise e
samples = qml.math.full((shots.total_shots, len(wires)), 0)

return _process_single_shot(samples)
processed_samples = []
for lower, upper in shots.bins():
shot = _process_single_shot(samples[..., lower:upper, :])
processed_samples.append(shot)

if shots.has_partitioned_shots:
return tuple(zip(*processed_samples))

return processed_samples[0]


def _measure_classical_shadow(
Expand Down
17 changes: 17 additions & 0 deletions pennylane/measurements/shots.py
Original file line number Diff line number Diff line change
Expand Up @@ -261,3 +261,20 @@ def has_partitioned_shots(self):
def num_copies(self):
"""The total number of copies of any shot quantity."""
return sum(s.copies for s in self.shot_vector)

def bins(self):
"""
Yields:
tuple: A tuple containing the lower and upper bounds for each shot quantity in shot_vector.
Example:
>>> shots = Shots((1, 1, 2, 3))
>>> list(shots.bins())
[(0,1), (1,2), (2,4), (4,7)]
"""
lower_bound = 0
for sc in self.shot_vector:
for _ in range(sc.copies):
upper_bound = lower_bound + sc.shots
yield lower_bound, upper_bound
lower_bound = upper_bound
4 changes: 2 additions & 2 deletions tests/devices/qubit/test_sampling.py
Original file line number Diff line number Diff line change
Expand Up @@ -856,7 +856,7 @@ def test_nonsample_measure_shot_vector(self, shots, measurement, expected):
r = r[0]

assert r.shape == expected.shape
assert np.allclose(r, expected, atol=0.01)
assert np.allclose(r, expected, atol=0.02)


@pytest.mark.jax
Expand Down Expand Up @@ -1071,7 +1071,7 @@ def test_nonsample_measure_shot_vector(self, mocker, shots, measurement, expecte
r = r[0]

assert r.shape == expected.shape
assert np.allclose(r, expected, atol=0.01)
assert np.allclose(r, expected, atol=0.03)


class TestHamiltonianSamples:
Expand Down
20 changes: 20 additions & 0 deletions tests/measurements/test_shots.py
Original file line number Diff line number Diff line change
Expand Up @@ -283,3 +283,23 @@ def test_shots_rmul(self):
scaled_sh1 = 2 * sh1
rev_scaled_sh1 = sh1 * 2
assert scaled_sh1.total_shots == rev_scaled_sh1.total_shots


class TestShotsBins:
"""Tests Shots.bins() method."""

def test_when_shots_is_none(self):
"""Tests that the method returns no bins when shots is None."""
shots = Shots(None)
assert not list(shots.bins())

def test_when_shots_is_int(self):
"""Tests that the method returns the correct bins when shots is an int."""
shots = Shots(10)
assert list(shots.bins()) == [(0, 10)]

@pytest.mark.parametrize("sequence", [[1, 1, 3, 4], [(1, 2), 3, 4]])
def test_when_shots_is_sequence_with_copies(self, sequence):
"""Tests that the method returns the correct bins when shots is a sequence with copies."""
shots = Shots(sequence)
assert list(shots.bins()) == [(0, 1), (1, 2), (2, 5), (5, 9)]

0 comments on commit 016d2cc

Please sign in to comment.