Implementing SamplerV2 (#2090)

* Implementing SamplerV2

* fix lint error

* fix test

* fix test

* fix test

* add options and function from_backend

* lint

* build test

* build test

.github/workflows/build.yml

@@ -183,7 +183,7 @@ jobs:
       - name: Build wheels
         env:
           CIBW_BEFORE_ALL: "yum install -y yum-utils wget && wget -q https://developer.download.nvidia.com/compute/cuda/11.8.0/local_installers/cuda-repo-rhel7-11-8-local-11.8.0_520.61.05-1.x86_64.rpm && rpm -i cuda-repo-rhel7-11-8-local-11.8.0_520.61.05-1.x86_64.rpm && yum clean all && yum -y install cuda && yum -y install openblas-devel && yum-config-manager --add-repo https://developer.download.nvidia.com/compute/cuda/repos/rhel7/x86_64/cuda-rhel7.repo && yum clean all"
-          CIBW_BEFORE_BUILD : "pip install nvidia-cuda-runtime-cu11 nvidia-cublas-cu11 nvidia-cusolver-cu11 nvidia-cusparse-cu11 cuquantum-cu11"
+          CIBW_BEFORE_BUILD : "pip cache purge && pip install nvidia-cuda-runtime-cu11 nvidia-cublas-cu11 nvidia-cusolver-cu11 nvidia-cusparse-cu11 cuquantum-cu11"
           CIBW_SKIP: "*-manylinux_i686 pp* cp36* cp37* cp38* cp39* cp310* cp311* *musllinux*"
           CIBW_ENVIRONMENT: QISKIT_AER_PACKAGE_NAME=qiskit-aer-gpu-cu11 QISKIT_AER_CUDA_MAJOR=11 CMAKE_VERBOSE_MAKEFILE=true AER_THRUST_BACKEND=CUDA CUDACXX=/usr/local/cuda/bin/nvcc AER_CUDA_ARCH="7.0 7.2 7.5 8.0 8.6 8.7" AER_PYTHON_CUDA_ROOT=/opt/_internal AER_CIBUILD=true
           CIBW_REPAIR_WHEEL_COMMAND: 'auditwheel repair --exclude libcudart.so.11.0 --exclude libcustatevec.so.1 --exclude libcutensornet.so.2 --exclude libcutensor.so.1 --exclude libcutensorMg.so.1 --exclude libcusolver.so.11 --exclude libcusolverMg.so.11 --exclude libcusparse.so.11 --exclude libcublas.so.11 --exclude libcublasLt.so.11 -w {dest_dir} {wheel}'

qiskit_aer/primitives/__init__.py

@@ -34,3 +34,4 @@
 from .estimator import Estimator
 from .estimator_v2 import EstimatorV2
 from .sampler import Sampler
+from .sampler_v2 import SamplerV2

qiskit_aer/primitives/estimator_v2.py

@@ -73,6 +73,10 @@ def __init__(
         method = "density_matrix" if "noise_model" in self.options.backend_options else "automatic"
         self._backend = AerSimulator(method=method, **self.options.backend_options)
 
+    def from_backend(self, backend, **options):
+        """use external backend"""
+        self._backend.from_backend(backend, **options)
+
     @property
     def options(self) -> Options:
         """Return the options"""

qiskit_aer/primitives/sampler_v2.py

@@ -0,0 +1,288 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2022.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""
+Sampler V2 class.
+"""
+
+from __future__ import annotations
+
+from typing import Iterable
+from dataclasses import dataclass, field
+import warnings
+
+import numpy as np
+from numpy.typing import NDArray
+
+from qiskit import ClassicalRegister, QiskitError, QuantumCircuit
+from qiskit.circuit import ControlFlowOp
+
+from qiskit.primitives.base import BaseSamplerV2
+from qiskit.primitives.base.validation import _has_measure
+from qiskit.primitives.containers import (
+    BitArray,
+    PrimitiveResult,
+    PubResult,
+    SamplerPubLike,
+    make_data_bin,
+)
+from qiskit.primitives.containers.sampler_pub import SamplerPub
+from qiskit.primitives.containers.bit_array import _min_num_bytes
+from qiskit.primitives.primitive_job import PrimitiveJob
+
+from qiskit_aer import AerSimulator
+
+
+@dataclass
+class _MeasureInfo:
+    creg_name: str
+    num_bits: int
+    num_bytes: int
+    qreg_indices: list[int]
+
+
+@dataclass
+class Options:
+    """Options for :class:`~.SamplerV2`."""
+
+    backend_options: dict = field(default_factory=dict)
+    """backend_options: Options passed to AerSimulator."""
+
+    run_options: dict = field(default_factory=dict)
+    """run_options: Options passed to run."""
+
+
+class SamplerV2(BaseSamplerV2):
+    """
+    Aer implementation of SamplerV2 class.
+
+    Each tuple of ``(circuit, <optional> parameter values, <optional> shots)``, called a sampler
+    primitive unified bloc (PUB), produces its own array-valued result. The :meth:`~run` method can
+    be given many pubs at once.
+
+    * ``backend_options``: Options passed to AerSimulator.
+      Default: {}.
+
+    * ``run_options``: Options passed to :meth:`AerSimulator.run`.
+      Default: {}.
+
+    """
+
+    def __init__(
+        self,
+        *,
+        default_shots: int = 1024,
+        seed: np.random.Generator | int | None = None,
+        options: dict | None = None,
+    ):
+        """
+        Args:
+            default_shots: The default shots for the sampler if not specified during run.
+            seed: The seed or Generator object for random number generation.
+                If None, a random seeded default RNG will be used.
+            options:
+                the backend options (``backend_options``), and
+                the runtime options (``run_options``).
+
+        """
+        self._default_shots = default_shots
+        self._seed = seed
+
+        self._options = Options(**options) if options else Options()
+        self._backend = AerSimulator(**self.options.backend_options)
+
+    def from_backend(self, backend, **options):
+        """use external backend"""
+        self._backend.from_backend(backend, **options)
+
+    @property
+    def default_shots(self) -> int:
+        """Return the default shots"""
+        return self._default_shots
+
+    @property
+    def seed(self) -> np.random.Generator | int | None:
+        """Return the seed or Generator object for random number generation."""
+        return self._seed
+
+    @property
+    def options(self) -> Options:
+        """Return the options"""
+        return self._options
+
+    def run(
+        self, pubs: Iterable[SamplerPubLike], *, shots: int | None = None
+    ) -> PrimitiveJob[PrimitiveResult[PubResult]]:
+        if shots is None:
+            shots = self._default_shots
+        coerced_pubs = [SamplerPub.coerce(pub, shots) for pub in pubs]
+        if any(len(pub.circuit.cregs) == 0 for pub in coerced_pubs):
+            warnings.warn(
+                "One of your circuits has no output classical registers and so the result "
+                "will be empty. Did you mean to add measurement instructions?",
+                UserWarning,
+            )
+
+        job = PrimitiveJob(self._run, coerced_pubs)
+        job._submit()
+        return job
+
+    def _run(self, pubs: Iterable[SamplerPub]) -> PrimitiveResult[PubResult]:
+        results = [self._run_pub(pub) for pub in pubs]
+        return PrimitiveResult(results)
+
+    def _run_pub(self, pub: SamplerPub) -> PubResult:
+        circuit, qargs, meas_info = _preprocess_circuit(pub.circuit)
+
+        # convert to parameter bindings
+        parameter_values = pub.parameter_values
+        parameter_binds = {}
+        param_array = parameter_values.as_array(circuit.parameters)
+        parameter_binds = {p: param_array[..., i].ravel() for i, p in enumerate(circuit.parameters)}
+
+        arrays = {
+            item.creg_name: np.zeros(
+                parameter_values.shape + (pub.shots, item.num_bytes), dtype=np.uint8
+            )
+            for item in meas_info
+        }
+
+        if qargs:
+            circuit.measure_all()
+            result = self._backend.run(
+                circuit,
+                shots=pub.shots,
+                seed_simulator=self._seed,
+                parameter_binds=[parameter_binds],
+            ).result()
+            all_counts = result.get_counts()
+
+            for index, counts in np.ndenumerate(all_counts):
+                samples = []
+                for k, v in counts.items():
+                    k = k.replace(" ", "")
+                    kk = ""
+                    for q in qargs:
+                        kk = k[circuit.num_qubits - 1 - q] + kk
+
+                    samples.append((np.fromiter(kk, dtype=np.uint8), v))
+
+                samples_array = np.array([sample for sample, v in samples for _ in range(0, v)])
+
+                for item in meas_info:
+                    ary = _samples_to_packed_array(samples_array, item.num_bits, item.qreg_indices)
+                    arrays[item.creg_name][index] = ary
+        else:
+            for index in np.ndenumerate(parameter_values.shape):
+                samples = [""] * pub.shots
+                samples_array = np.array(
+                    [np.fromiter(sample, dtype=np.uint8) for sample in samples]
+                )
+                for item in meas_info:
+                    ary = _samples_to_packed_array(samples_array, item.num_bits, item.qreg_indices)
+                    arrays[item.creg_name][index] = ary
+
+        data_bin_cls = make_data_bin(
+            [(item.creg_name, BitArray) for item in meas_info],
+            shape=parameter_values.shape,
+        )
+        meas = {
+            item.creg_name: BitArray(arrays[item.creg_name], item.num_bits) for item in meas_info
+        }
+        data_bin = data_bin_cls(**meas)
+        return PubResult(data_bin, metadata={"shots": pub.shots})
+
+
+def _preprocess_circuit(circuit: QuantumCircuit):
+    num_bits_dict = {creg.name: creg.size for creg in circuit.cregs}
+    mapping = _final_measurement_mapping(circuit)
+    qargs = sorted(set(mapping.values()))
+    qargs_index = {v: k for k, v in enumerate(qargs)}
+    circuit = circuit.remove_final_measurements(inplace=False)
+    if _has_control_flow(circuit):
+        raise QiskitError("StatevectorSampler cannot handle ControlFlowOp")
+    if _has_measure(circuit):
+        raise QiskitError("StatevectorSampler cannot handle mid-circuit measurements")
+    # num_qubits is used as sentinel to fill 0 in _samples_to_packed_array
+    sentinel = len(qargs)
+    indices = {key: [sentinel] * val for key, val in num_bits_dict.items()}
+    for key, qreg in mapping.items():
+        creg, ind = key
+        indices[creg.name][ind] = qargs_index[qreg]
+    meas_info = [
+        _MeasureInfo(
+            creg_name=name,
+            num_bits=num_bits,
+            num_bytes=_min_num_bytes(num_bits),
+            qreg_indices=indices[name],
+        )
+        for name, num_bits in num_bits_dict.items()
+    ]
+    return circuit, qargs, meas_info
+
+
+def _samples_to_packed_array(
+    samples: NDArray[np.uint8], num_bits: int, indices: list[int]
+) -> NDArray[np.uint8]:
+    # samples of `Statevector.sample_memory` will be in the order of
+    # qubit_last, ..., qubit_1, qubit_0.
+    # reverse the sample order into qubit_0, qubit_1, ..., qubit_last and
+    # pad 0 in the rightmost to be used for the sentinel introduced by _preprocess_circuit.
+    ary = np.pad(samples[:, ::-1], ((0, 0), (0, 1)), constant_values=0)
+    # place samples in the order of clbit_last, ..., clbit_1, clbit_0
+    ary = ary[:, indices[::-1]]
+    # pad 0 in the left to align the number to be mod 8
+    # since np.packbits(bitorder='big') pads 0 to the right.
+    pad_size = -num_bits % 8
+    ary = np.pad(ary, ((0, 0), (pad_size, 0)), constant_values=0)
+    # pack bits in big endian order
+    ary = np.packbits(ary, axis=-1)
+    return ary
+
+
+def _final_measurement_mapping(circuit: QuantumCircuit) -> dict[tuple[ClassicalRegister, int], int]:
+    """Return the final measurement mapping for the circuit.
+
+    Parameters:
+        circuit: Input quantum circuit.
+
+    Returns:
+        Mapping of classical bits to qubits for final measurements.
+    """
+    active_qubits = set(range(circuit.num_qubits))
+    active_cbits = set(range(circuit.num_clbits))
+
+    # Find final measurements starting in back
+    mapping = {}
+    for item in circuit[::-1]:
+        if item.operation.name == "measure":
+            loc = circuit.find_bit(item.clbits[0])
+            cbit = loc.index
+            qbit = circuit.find_bit(item.qubits[0]).index
+            if cbit in active_cbits and qbit in active_qubits:
+                for creg in loc.registers:
+                    mapping[creg] = qbit
+                active_cbits.remove(cbit)
+        elif item.operation.name not in ["barrier", "delay"]:
+            for qq in item.qubits:
+                _temp_qubit = circuit.find_bit(qq).index
+                if _temp_qubit in active_qubits:
+                    active_qubits.remove(_temp_qubit)
+
+        if not active_cbits or not active_qubits:
+            break
+
+    return mapping
+
+
+def _has_control_flow(circuit: QuantumCircuit) -> bool:
+    return any(isinstance(instruction.operation, ControlFlowOp) for instruction in circuit)

releasenotes/notes/sampler_v2-be0fc5c29a8e2c14.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - |
+    Adding SamplerV2 implementation based on BaseSamplerV2 using AerSimulator.
+    This is implemented based on qiskit.primitives.StatevectorSampler, but
+    this can simulate using any simulation methods other than statevector
+    by passing AerSimulator object with any methods.