Prepare 0.17.0 release

qiskit/algorithms/minimum_eigen_solvers/qaoa.py

@@ -33,8 +33,8 @@ class QAOA(VQE):
 
     `QAOA <https://arxiv.org/abs/1411.4028>`__ is a well-known algorithm for finding approximate
     solutions to combinatorial-optimization problems.
-    The QAOA implementation directly extends :class:`VQE` and inherits VQE's
-    general hybrid optimization structure.
+
+    The QAOA implementation directly extends :class:`VQE` and inherits VQE's optimization structure.
     However, unlike VQE, which can be configured with arbitrary ansatzes,
     QAOA uses its own fine-tuned ansatz, which comprises :math:`p` parameterized global
     :math:`x` rotations and :math:`p` different parameterizations of the problem hamiltonian.

qiskit/algorithms/minimum_eigen_solvers/vqe.py

@@ -45,8 +45,8 @@
 class VQE(VariationalAlgorithm, MinimumEigensolver):
     r"""The Variational Quantum Eigensolver algorithm.
 
-    `VQE <https://arxiv.org/abs/1304.3061>`__ is a hybrid algorithm that uses a
-    variational technique and interleaves quantum and classical computations in order to find
+    `VQE <https://arxiv.org/abs/1304.3061>`__ is a quantum algorithm that uses a
+    variational technique to find
     the minimum eigenvalue of the Hamiltonian :math:`H` of a given system.
 
     An instance of VQE requires defining two algorithmic sub-components:

qiskit/circuit/library/__init__.py

@@ -55,6 +55,7 @@
    RCCXGate
    RC3XGate
    Reset
+   RGate
    RXGate
    RXXGate
    RYGate
@@ -94,6 +95,7 @@
    GRX
    GRY
    GRZ
+   RVGate
 
 Boolean Logic Circuits
 ======================
@@ -136,6 +138,7 @@
    PolynomialPauliRotations
    PiecewiseLinearPauliRotations
    PiecewisePolynomialPauliRotations
+   PiecewiseChebyshev
 
 Adders
 ++++++
@@ -275,6 +278,44 @@
    templates.nct.template_nct_9d_9
    templates.nct.template_nct_9d_10
 
+Clifford template circuits
+==========================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   clifford_2_1
+   clifford_2_2
+   clifford_2_3
+   clifford_2_4
+   clifford_3_1
+   clifford_4_1
+   clifford_4_2
+   clifford_4_3
+   clifford_4_4
+   clifford_5_1
+   clifford_6_1
+   clifford_6_2
+   clifford_6_3
+   clifford_6_4
+   clifford_6_5
+   clifford_8_1
+   clifford_8_2
+   clifford_8_3
+
+RZXGate template circuits
+=========================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   rzx_yz
+   rzx_xz
+   rzx_cy
+   rzx_zz1
+   rzx_zz2
+   rzx_zz3
+
 """
 
 from .standard_gates import *
@@ -313,6 +354,7 @@
     WeightedAdder,
     QuadraticForm,
     LinearAmplitudeFunction,
+    PiecewiseChebyshev,
 )
 from .n_local import (
     NLocal,

qiskit/circuit/library/arithmetic/__init__.py

@@ -21,3 +21,4 @@
 from .weighted_adder import WeightedAdder
 from .quadratic_form import QuadraticForm
 from .linear_amplitude_function import LinearAmplitudeFunction
+from .piecewise_chebyshev import PiecewiseChebyshev

qiskit/circuit/library/arithmetic/piecewise_chebyshev.py

@@ -45,7 +45,7 @@ class PiecewiseChebyshev(BlueprintCircuit):
             qc = QuantumCircuit(pw_approximation.num_qubits)
             qc.h(list(range(num_state_qubits)))
             qc.append(pw_approximation.to_instruction(), qc.qubits)
-            print(qc.draw(output='mpl'))
+            qc.draw(output='mpl')
 
     References:
 

qiskit/circuit/library/generalized_gates/rv.py

@@ -18,7 +18,7 @@
 
 
 class RVGate(Gate):
-    r"""Rotation around arbitrary rotation axis v where |v| is
+    r"""Rotation around arbitrary rotation axis :math:`v` where :math:`|v|` is
     angle of rotation in radians.
 
     **Circuit symbol:**
@@ -33,13 +33,13 @@ class RVGate(Gate):
 
     .. math::
 
-    \newcommand{\th}{|\vec{v}|}
-    \newcommand{\sinc}{\text{sinc}}
-        R(\vec{v}) = e^{-i \vec{v}\cdot\vec{\sigma}} =
-            \begin{pmatrix}
-                \cos{\th} -i v_z \sinc(\th) & -(i v_x + v_y) \sinc(\th) \\
-                -(i v_x - v_y) \sinc(\th) & \cos(\th) + i v_z \sinc(\th)
-            \end{pmatrix}
+        \newcommand{\th}{|\vec{v}|}
+        \newcommand{\sinc}{\text{sinc}}
+            R(\vec{v}) = e^{-i \vec{v}\cdot\vec{\sigma}} =
+                \begin{pmatrix}
+                    \cos{\th} -i v_z \sinc(\th) & -(i v_x + v_y) \sinc(\th) \\
+                    -(i v_x - v_y) \sinc(\th) & \cos(\th) + i v_z \sinc(\th)
+                \end{pmatrix}
     """
 
     def __init__(self, v_x, v_y, v_z, basis='U'):

qiskit/circuit/library/templates/__init__.py

@@ -75,9 +75,12 @@
 from .clifford.clifford_2_1 import clifford_2_1
 from .clifford.clifford_2_2 import clifford_2_2
 from .clifford.clifford_2_3 import clifford_2_3
+from .clifford.clifford_2_4 import clifford_2_4
 from .clifford.clifford_3_1 import clifford_3_1
 from .clifford.clifford_4_1 import clifford_4_1
 from .clifford.clifford_4_2 import clifford_4_2
+from .clifford.clifford_4_3 import clifford_4_3
+from .clifford.clifford_4_4 import clifford_4_4
 from .clifford.clifford_5_1 import clifford_5_1
 from .clifford.clifford_6_1 import clifford_6_1
 from .clifford.clifford_6_2 import clifford_6_2
@@ -86,3 +89,4 @@
 from .clifford.clifford_6_5 import clifford_6_5
 from .clifford.clifford_8_1 import clifford_8_1
 from .clifford.clifford_8_2 import clifford_8_2
+from .clifford.clifford_8_3 import clifford_8_3

qiskit/quantum_info/__init__.py

@@ -103,6 +103,7 @@
 .. autosummary::
    :toctree: ../stubs/
 
+   hellinger_distance
    hellinger_fidelity
 
 Synthesis
@@ -115,6 +116,7 @@
    TwoQubitBasisDecomposer
    two_qubit_cnot_decompose
    Quaternion
+   decompose_clifford
 """
 
 from .operators import (Operator, ScalarOp, Pauli, Clifford, SparsePauliOp)
@@ -139,6 +141,7 @@
                      random_cnotdihedral)
 
 from .synthesis import (OneQubitEulerDecomposer, TwoQubitBasisDecomposer,
-                        two_qubit_cnot_decompose, Quaternion)
+                        two_qubit_cnot_decompose, Quaternion,
+                        decompose_clifford)
 
-from .analysis import hellinger_fidelity
+from .analysis import hellinger_distance, hellinger_fidelity

qiskit/quantum_info/analysis/__init__.py

@@ -12,4 +12,4 @@
 
 """Module for functions for post processing results."""
 from .average import average_data
-from.distance import hellinger_fidelity
+from .distance import hellinger_fidelity, hellinger_distance

qiskit/quantum_info/synthesis/__init__.py

@@ -15,3 +15,4 @@
 from .two_qubit_decompose import TwoQubitBasisDecomposer, two_qubit_cnot_decompose
 from .one_qubit_decompose import OneQubitEulerDecomposer
 from .quaternion import Quaternion
+from .clifford_decompose import decompose_clifford

qiskit/transpiler/__init__.py

@@ -395,6 +395,15 @@
    FencedDAGCircuit
    FencedPropertySet
 
+Abstract Passes
+---------------
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   TransformationPass
+   AnalysisPass
+
 Exceptions
 ----------
 

qiskit/transpiler/passes/__init__.py

@@ -83,6 +83,7 @@
 
    ALAPSchedule
    ASAPSchedule
+   RZXCalibrationBuilder
 
 Circuit Analysis
 ================
@@ -114,6 +115,8 @@
 
    CheckMap
    CheckCXDirection
+   CheckGateDirection
+   CXDirection
    GateDirection
    MergeAdjacentBarriers
    BarrierBeforeFinalMeasurements
@@ -179,6 +182,7 @@
 # circuit scheduling
 from .scheduling import ALAPSchedule
 from .scheduling import ASAPSchedule
+from .scheduling import RZXCalibrationBuilder
 from .scheduling import TimeUnitConversion
 
 # additional utility passes

qiskit/transpiler/passes/optimization/commutative_cancellation.py

@@ -43,8 +43,9 @@ def __init__(self, basis_gates=None):
         CommutativeCancellation initializer.
 
         Args:
-            basis_gates (list[str]): Basis gates to consider, e.g. `['u3', 'cx']`. For the effects
-                of this pass, the basis is the set intersection between the `basis` parameter
+            basis_gates (list[str]): Basis gates to consider, e.g.
+                ``['u3', 'cx']``. For the effects of this pass, the basis is
+                the set intersection between the ``basis_gates`` parameter
                 and the gates in the dag.
         """
         super().__init__()

qiskit/transpiler/passes/scheduling/calibration_creators.py

@@ -110,7 +110,8 @@ def rescale_cr_inst(instruction: Play, theta: float, sample_mult: int = 16) -> P
             sample_mult: All pulses must be a multiple of sample_mult.
 
         Returns:
-            Play: The play instruction with the stretched compressed GaussianSquare pulse.
+            qiskit.pulse.Play: The play instruction with the stretched compressed
+                GaussianSquare pulse.
 
         Raises:
             QiskitError: if the pulses are not GaussianSquare.

qiskit/transpiler/passes/utils/check_cx_direction.py

@@ -17,7 +17,7 @@
 
 
 class CheckCXDirection(CheckGateDirection):
-    """Deprecated: use CheckGateDirection pass."""
+    """Deprecated: use :class:`qiskit.transpiler.passes.CheckGateDirection` pass instead."""
 
     def __init__(self, coupling_map):
         super().__init__(coupling_map)

qiskit/transpiler/passes/utils/cx_direction.py

@@ -17,7 +17,7 @@
 
 
 class CXDirection(GateDirection):
-    """Deprecated: use GateDirection pass."""
+    """Deprecated: use :class:`qiskit.transpiler.passes.GateDirection` pass instead."""
 
     def __init__(self, coupling_map):
         super().__init__(coupling_map)

qiskit/visualization/__init__.py

@@ -94,6 +94,14 @@
 
    visualize_transition
 
+Array/Matrix Visualizations
+===========================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   array_to_latex
+
 Exceptions
 ==========
 

qiskit/visualization/array.py

@@ -207,17 +207,17 @@ def array_to_latex(array, precision=5, prefix="", source=False, max_size=8):
             source (bool): If ``False``, will return IPython.display.Latex object. If display is
                            ``True``, will instead return the LaTeX source string.
             max_size (list(int) or int): The maximum size of the output Latex array.
-                      * If list(```int```), then the 0th element of the list specifies the maximum
-                        width (including dots characters) and the 1st specifies the maximum height
-                        (also inc. dots characters).
-                      * If a single ```int``` then this value sets the maximum width _and_ maximum
-                        height.
+
+                * If list(``int``), then the 0th element of the list specifies the maximum
+                  width (including dots characters) and the 1st specifies the maximum height
+                  (also inc. dots characters).
+                * If a single ``int`` then this value sets the maximum width _and_ maximum
+                  height.
 
         Returns:
-            if ``source`` is ``True``:
-                ``str``: LaTeX string representation of the array.
-            else:
-                ``IPython.display.Latex``: LaTeX representation of the array.
+            str or IPython.display.Latex: If ``source`` is ``True``, a ``str`` of the LaTeX
+                representation of the array, else an ``IPython.display.Latex`` representation of
+                the array.
 
         Raises:
             TypeError: If array can not be interpreted as a numerical numpy array.

releasenotes/notes/0.17/1q_euler_decomp_u3_to_u1_u2-ca3bea2ca55ca961.yaml

@@ -0,0 +1,17 @@
+---
+upgrade:
+  - |
+    The preset pass managers
+    :class:`~qiskit.transpiler.preset_passmanagers.level_1_pass_manager`,
+    :class:`~qiskit.transpiler.preset_passmanagers.level_2_pass_manager`,
+    and :class:`~qiskit.transpiler.preset_passmanagers.level_3_pass_manager`
+    (which are used for ``optimization_level`` 1, 2, and 3 in the
+    :func:`~qiskit.compiler.transpile` and
+    :func:`~qiskit.execute_function.execute` functions) now unconditionally
+    use the :class:`~qiskit.transpiler.passes.Optimize1qGatesDecomposition`
+    pass for 1 qubit gate optimization. Previously, these pass managers would
+    use the :class:`~qiskit.transpiler.passes.Optimize1qGates` pass if the basis
+    gates contained ``u1``, ``u2``, or ``u3``. If you want to still use
+    the old :class:`~qiskit.transpiler.passes.Optimize1qGates` you will need
+    to construct a custom :class:`~qiskit.transpiler.PassManager` with the
+    pass.

releasenotes/notes/0.17/5405-Slow-transpilation-of-ExcitationPreserving-297f3afd4a987cac.yaml

@@ -0,0 +1,24 @@
+---
+upgrade:
+  - |
+    Following transpilation of a parameterized
+    :class:`~qiskit.circuit.QuantumCircuit`, the
+    :attr:`~qiskit.circuit.QuantumCircuit.global_phase` attribute of output
+    circuit may no longer be returned in a simplified form, if the global phase
+    is a :class:`~qiskit.circuit.ParameterExpression`.
+
+    For example::
+
+      qc = QuantumCircuit(1)
+      theta = Parameter('theta')
+
+      qc.rz(theta, 0)
+      qc.rz(-theta, 0)
+
+      print(transpile(qc, basis_gates=['p']).global_phase)
+
+    previously returned ``0``, but will now return ``-0.5*theta + 0.5*theta``.
+    This change was necessary was to avoid a large runtime performance
+    penalty as simplifying symbolic expressions can be quite slow, especially
+    if there are many :class:`~qiskit.circuit.ParameterExpression` objects
+    in a circuit.

releasenotes/notes/0.17/DAGNode.semantic_eq-to-use-qcarg-circuit-index-for-arg-equality-07cb556ec9fda5f2.yaml

@@ -0,0 +1,15 @@
+---
+deprecations:
+  - |
+    Two new arguments have been added to
+    :meth:`qiskit.dagcircuit.DAGNode.semantic_eq`, ``bit_indices1`` and
+    ``bit_indices2``, which are expected to map the
+    :class:`~qiskit.circuit.Bit` instances in each
+    :class:`~qiskit.dagcircuit.DAGNode` to their index in ``qubits`` or
+    ``clbits`` list of their respective
+    :class:`~qiskit.dagcircuit.DAGCircuit`. During the deprecation period,
+    these arguments are optional and when **not** specified the mappings will
+    be automatically constructed based on the ``register`` and ``index``
+    properties of each :class:`~qiskit.circuit.Bit` instance. However, in a
+    future release, they will be required arguments and the mapping will need
+    to be supplied by the user.

releasenotes/notes/0.17/ParameterVectors-aren't-unrolled-by-execute-c8bd393818e926b0.yaml

@@ -0,0 +1,15 @@
+---
+fixes:
+  - |
+    Fixed an issue where the :func:`~qiskit.execute_function.execute` function
+    would raise :class:`~qiskit.exceptions.QiskitError` exception when a
+    :class:`~qiskit.circuit.ParameterVector` object was passed in for the
+    ``parameter_bind`` kwarg. parameter. For example, it is now possible to
+    call something like::
+
+      execute(circuit, backend, parameter_binds=[{pv1: [...], pv2: [...]}])
+
+    where ``pv1`` and ``pv2`` are :class:`~qiskit.circuit.ParameterVector`
+    objects.
+    Fixed `#5467 <https://github.com/Qiskit/qiskit-terra/issues/5467>`__
+