QAOA¶

class
QAOA
(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)[source]¶ Bases:
qiskit.algorithms.minimum_eigen_solvers.vqe.VQE
The Quantum Approximate Optimization Algorithm.
QAOA is a wellknown algorithm for finding approximate solutions to combinatorialoptimization problems.
The QAOA implementation directly extends
VQE
and inherits VQE’s optimization structure. However, unlike VQE, which can be configured with arbitrary ansatzes, QAOA uses its own finetuned ansatz, which comprises \(p\) parameterized global \(x\) rotations and \(p\) different parameterizations of the problem hamiltonian. QAOA is thus principally configured by the single integer parameter, p, which dictates the depth of the ansatz, and thus affects the approximation quality.An optional array of \(2p\) parameter values, as the initial_point, may be provided as the starting beta and gamma parameters (as identically named in the original QAOA paper) for the QAOA ansatz.
An operator or a parameterized quantum circuit may optionally also be provided as a custom mixer Hamiltonian. This allows, as discussed in this paper for quantum annealing, and in this paper for QAOA, to run constrained optimization problems where the mixer constrains the evolution to a feasible subspace of the full Hilbert space.
 Parameters
optimizer (
Optional
[Optimizer
]) – A classical optimizer.reps (
int
) – the integer parameter \(p\) as specified in https://arxiv.org/abs/1411.4028, Has a minimum valid value of 1.initial_state (
Optional
[QuantumCircuit
]) – An optional initial state to prepend the QAOA circuit withmixer (
Union
[QuantumCircuit
,OperatorBase
,None
]) – the mixer Hamiltonian to evolve with or a custom quantum circuit. Allows support of optimizations in constrained subspaces as per https://arxiv.org/abs/1709.03489 as well as warmstarting the optimization as introduced in http://arxiv.org/abs/2009.10095.initial_point (
Optional
[ndarray
]) – An optional initial point (i.e. initial parameter values) for the optimizer. IfNone
then it will simply compute a random one.gradient (
Union
[GradientBase
,Callable
[[Union
[ndarray
,List
]],List
],None
]) – An optional gradient operator respectively a gradient function used for optimization.expectation (
Optional
[ExpectationBase
]) – The Expectation converter for taking the average value of the Observable over the ansatz state function. When None (the default) anExpectationFactory
is used to select an appropriate expectation based on the operator and backend. When using Aer qasm_simulator backend, with paulis, it is however much faster to leverage custom Aer function for the computation but, although VQE performs much faster with it, the outcome is ideal, with no shot noise, like using a state vector simulator. If you are just looking for the quickest performance when choosing Aer qasm_simulator and the lack of shot noise is not an issue then set include_custom parameter here to True (defaults to False).include_custom (
bool
) – When expectation parameter here is None setting this to True will allow the factory to include the custom Aer pauli expectation.max_evals_grouped (
int
) – Max number of evaluations performed simultaneously. Signals the given optimizer that more than one set of parameters can be supplied so that potentially the expectation values can be computed in parallel. Typically this is possible when a finite difference gradient is used by the optimizer such that multiple points to compute the gradient can be passed and if computed in parallel improve overall execution time. Ignored if a gradient operator or function is given.callback (
Optional
[Callable
[[int
,ndarray
,float
,float
],None
]]) – a callback that can access the intermediate data during the optimization. Four parameter values are passed to the callback as follows during each evaluation by the optimizer for its current set of parameters as it works towards the minimum. These are: the evaluation count, the optimizer parameters for the ansatz, the evaluated mean and the evaluated standard deviation.quantum_instance (
Union
[Backend
,BaseBackend
,QuantumInstance
,None
]) – Quantum Instance or Backend
Methods
set parameterized circuits to None
Computes minimum eigenvalue.
Return the circuits used to compute the expectation value.
Generate the ansatz circuit and expectation value measurement, and return their runnable composition.
Optimize to find the minimum cost value.
Returns a function handle to evaluates the energy at given parameters for the ansatz.
Get the circuit with the optimal parameters.
Get the minimal cost or energy found by the VQE.
Get the simulation outcome of the optimal circuit.
Helper function to get probability vectors for a set of params
get probabilities for counts
Preparing the setting of VQE into a string.
Whether computing the expectation value of auxiliary operators is supported.
Attributes

ansatz
¶ Returns the ansatz.
 Return type
Optional
[QuantumCircuit
]

expectation
¶ The expectation value algorithm used to construct the expectation measurement from the observable.
 Return type
Optional
[ExpectationBase
]

gradient
¶ Returns the gradient.
 Return type
Union
[GradientBase
,Callable
,None
]

initial_point
¶ Returns initial point
 Return type
Optional
[ndarray
]

initial_state
¶ Returns: Returns the initial state.
 Return type
Optional
[QuantumCircuit
]

mixer
¶ Returns: Returns the mixer.
 Return type
Union
[QuantumCircuit
,OperatorBase
]

optimal_params
¶ The optimal parameters for the ansatz.
 Return type
ndarray

optimizer
¶ Returns optimizer
 Return type
Optional
[Optimizer
]

quantum_instance
¶ Returns quantum instance.
 Return type
Optional
[QuantumInstance
]

setting
¶ Prepare the setting of VQE as a string.