SPSA

class qiskit.algorithms.optimizers.SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)

Bases: Optimizer

Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer.

SPSA [1] is an gradient descent method for optimizing systems with multiple unknown parameters. As an optimization method, it is appropriately suited to large-scale population models, adaptive modeling, and simulation optimization.

The main feature of SPSA is the stochastic gradient approximation, which requires only two measurements of the objective function, regardless of the dimension of the optimization problem.

Additionally to standard, first-order SPSA, where only gradient information is used, this implementation also allows second-order SPSA (2-SPSA) [2]. In 2-SPSA we also estimate the Hessian of the loss with a stochastic approximation and multiply the gradient with the inverse Hessian to take local curvature into account and improve convergence. Notably this Hessian estimate requires only a constant number of function evaluations unlike an exact evaluation of the Hessian, which scales quadratically in the number of function evaluations.

The optimization process can includes a calibration phase if neither the learning_rate nor perturbation is provided, which requires additional functional evaluations. (Note that either both or none must be set.) For further details on the automatic calibration, please refer to the supplementary information section IV. of [3].

Examples

This short example runs SPSA for the ground state calculation of the Z ^ Z observable where the ansatz is a PauliTwoDesign circuit.

import numpy as np
from qiskit.algorithms.optimizers import SPSA
from qiskit.circuit.library import PauliTwoDesign
from qiskit.opflow import Z, StateFn
 
ansatz = PauliTwoDesign(2, reps=1, seed=2)
observable = Z ^ Z
initial_point = np.random.random(ansatz.num_parameters)
 
def loss(x):
    bound = ansatz.assign_parameters(x)
    return np.real((StateFn(observable, is_measurement=True) @ StateFn(bound)).eval())
 
spsa = SPSA(maxiter=300)
result = spsa.optimize(ansatz.num_parameters, loss, initial_point=initial_point)

To use the Hessian information, i.e. 2-SPSA, you can add second_order=True to the initializer of the SPSA class, the rest of the code remains the same.

two_spsa = SPSA(maxiter=300, second_order=True)
result = two_spsa.optimize(ansatz.num_parameters, loss, initial_point=initial_point)

The termination_checker can be used to implement a custom termination criterion.

import numpy as np
from qiskit.algorithms.optimizers import SPSA
 
def objective(x):
    return np.linalg.norm(x) + .04*np.random.rand(1)
 
class TerminationChecker:
 
    def __init__(self, N : int):
        self.N = N
        self.values = []
 
    def __call__(self, nfev, parameters, value, stepsize, accepted) -> bool:
        self.values.append(value)
 
        if len(self.values) > self.N:
            last_values = self.values[-self.N:]
            pp = np.polyfit(range(self.N), last_values, 1)
            slope = pp[0] / self.N
 
            if slope > 0:
                return True
        return False
 
spsa = SPSA(maxiter=200, termination_checker=TerminationChecker(10))
parameters, value, niter = spsa.optimize(2, objective, initial_point=[0.5, 0.5])
print(f'SPSA completed after {niter} iterations')

References

[1]: J. C. Spall (1998). An Overview of the Simultaneous Perturbation Method for Efficient Optimization, Johns Hopkins APL Technical Digest, 19(4), 482–492. Online at jhuapl.edu.

[2]: J. C. Spall (1997). Accelerated second-order stochastic optimization using only function measurements, Proceedings of the 36th IEEE Conference on Decision and Control, 1417-1424 vol.2. Online at IEEE.org.

[3]: A. Kandala et al. (2017). Hardware-efficient Variational Quantum Eigensolver for Small Molecules and Quantum Magnets. Nature 549, pages242–246(2017). arXiv:1704.05018v2

Parameters

• maxiter (int) – The maximum number of iterations. Note that this is not the maximal number of function evaluations.
• blocking (bool) – If True, only accepts updates that improve the loss (up to some allowed increase, see next argument).
• allowed_increase (float | None) – If blocking is True, this argument determines by how much the loss can increase with the proposed parameters and still be accepted. If None, the allowed increases is calibrated automatically to be twice the approximated standard deviation of the loss function.
• trust_region (bool) – If True, restricts the norm of the update step to be $\leq 1$.
• learning_rate (float | np.ndarray | Callable[[], Iterator] | None) – The update step is the learning rate is multiplied with the gradient. If the learning rate is a float, it remains constant over the course of the optimization. If a NumPy array, the $i$-th element is the learning rate for the $i$-th iteration. It can also be a callable returning an iterator which yields the learning rates for each optimization step. If learning_rate is set perturbation must also be provided.
• perturbation (float | np.ndarray | Callable[[], Iterator] | None) – Specifies the magnitude of the perturbation for the finite difference approximation of the gradients. See learning_rate for the supported types. If perturbation is set learning_rate must also be provided.
• last_avg (int) – Return the average of the last_avg parameters instead of just the last parameter values.
• resamplings (int |dict[int, int]) – The number of times the gradient (and Hessian) is sampled using a random direction to construct a gradient estimate. Per default the gradient is estimated using only one random direction. If an integer, all iterations use the same number of resamplings. If a dictionary, this is interpreted as {iteration: number of resamplings per iteration}.
• perturbation_dims (int | None) – The number of perturbed dimensions. Per default, all dimensions are perturbed, but a smaller, fixed number can be perturbed. If set, the perturbed dimensions are chosen uniformly at random.
• second_order (bool) – If True, use 2-SPSA instead of SPSA. In 2-SPSA, the Hessian is estimated additionally to the gradient, and the gradient is preconditioned with the inverse of the Hessian to improve convergence.
• regularization (float | None) – To ensure the preconditioner is symmetric and positive definite, the identity times a small coefficient is added to it. This generator yields that coefficient.
• hessian_delay (int) – Start multiplying the gradient with the inverse Hessian only after a certain number of iterations. The Hessian is still evaluated and therefore this argument can be useful to first get a stable average over the last iterations before using it as preconditioner.
• lse_solver (Callable[[np.ndarray, np.ndarray], np.ndarray] | None) – The method to solve for the inverse of the Hessian. Per default an exact LSE solver is used, but can e.g. be overwritten by a minimization routine.
• initial_hessian (np.ndarray | None) – The initial guess for the Hessian. By default the identity matrix is used.
• callback (CALLBACK | None) – A callback function passed information in each iteration step. The information is, in this order: the number of function evaluations, the parameters, the function value, the stepsize, whether the step was accepted.
• termination_checker (TERMINATIONCHECKER | None) – A callback function executed at the end of each iteration step. The arguments are, in this order: the parameters, the function value, the number of function evaluations, the stepsize, whether the step was accepted. If the callback returns True, the optimization is terminated. To prevent additional evaluations of the objective method, if the objective has not yet been evaluated, the objective is estimated by taking the mean of the objective evaluations used in the estimate of the gradient.

Raises

ValueError – If learning_rate or perturbation is an array with less elements than the number of iterations.

Attributes

bounds_support_level

gradient_support_level

initial_point_support_level

is_bounds_ignored

is_bounds_required

is_bounds_supported

is_gradient_ignored

is_gradient_required

is_gradient_supported

is_initial_point_ignored

is_initial_point_required

is_initial_point_supported

setting

settings

Methods

calibrate

estimate_stddev

get_support_level

gradient_num_diff

minimize

optimize

print_options

set_max_evals_grouped

set_options

wrap_function