bundles / scipy 1.17.1 / scipy / optimize / _minimize / minimize
function
scipy.optimize._minimize:minimize
source: /scipy/optimize/_minimize.py :54
Signature
def minimize ( fun , x0 , args = () , method = None , jac = None , hess = None , hessp = None , bounds = None , constraints = () , tol = None , callback = None , options = None ) Summary
Minimization of scalar function of one or more variables.
Parameters
fun: callableThe objective function to be minimized
fun(x, *args) -> floatwhere
xis a 1-D array with shape (n,) andargsis a tuple of the fixed parameters needed to completely specify the function.Suppose the callable has signature
f0(x, *my_args, **my_kwargs), wheremy_argsandmy_kwargsare required positional and keyword arguments. Rather than passingf0as the callable, wrap it to accept onlyx; e.g., passfun=lambda x: f0(x, *my_args, **my_kwargs)as the callable, wheremy_args(tuple) andmy_kwargs(dict) have been gathered before invoking this function.x0: ndarray, shape (n,)Initial guess. Array of real elements of size (n,), where
nis the number of independent variables.args: tuple, optionalExtra arguments passed to the objective function and its derivatives (
fun,jacandhessfunctions).method: str or callable, optionalType of solver. Should be one of
'Nelder-Mead'
(see here) <optimize.minimize-neldermead>'Powell'
(see here) <optimize.minimize-powell>'CG'
(see here) <optimize.minimize-cg>'BFGS'
(see here) <optimize.minimize-bfgs>'Newton-CG'
(see here) <optimize.minimize-newtoncg>'L-BFGS-B'
(see here) <optimize.minimize-lbfgsb>'TNC'
(see here) <optimize.minimize-tnc>'COBYLA'
(see here) <optimize.minimize-cobyla>'COBYQA'
(see here) <optimize.minimize-cobyqa>'SLSQP'
(see here) <optimize.minimize-slsqp>'trust-constr'
(see here) <optimize.minimize-trustconstr>'dogleg'
(see here) <optimize.minimize-dogleg>'trust-ncg'
(see here) <optimize.minimize-trustncg>'trust-exact'
(see here) <optimize.minimize-trustexact>'trust-krylov'
(see here) <optimize.minimize-trustkrylov>custom - a callable object, see below for description.
If not given, chosen to be one of
BFGS,L-BFGS-B,SLSQP, depending on whether or not the problem has constraints or bounds.jac: {callable, '2-point', '3-point', 'cs', bool}, optionalMethod for computing the gradient vector. Only for CG, BFGS, Newton-CG, L-BFGS-B, TNC, SLSQP, dogleg, trust-ncg, trust-krylov, trust-exact and trust-constr. If it is a callable, it should be a function that returns the gradient vector
jac(x, *args) -> array_like, shape (n,)where
xis an array with shape (n,) andargsis a tuple with the fixed parameters. Ifjacis a Boolean and is True,funis assumed to return a tuple(f, g)containing the objective function and the gradient. Methods 'Newton-CG', 'trust-ncg', 'dogleg', 'trust-exact', and 'trust-krylov' require that either a callable be supplied, or thatfunreturn the objective and gradient. If None or False, the gradient will be estimated using 2-point finite difference estimation with an absolute step size. Alternatively, the keywords {'2-point', '3-point', 'cs'} can be used to select a finite difference scheme for numerical estimation of the gradient with a relative step size. These finite difference schemes obey any specifiedbounds.hess: {callable, '2-point', '3-point', 'cs', HessianUpdateStrategy}, optionalMethod for computing the Hessian matrix. Only for Newton-CG, dogleg, trust-ncg, trust-krylov, trust-exact and trust-constr. If it is callable, it should return the Hessian matrix
hess(x, *args) -> {LinearOperator, spmatrix, array}, (n, n)where
xis a (n,) ndarray andargsis a tuple with the fixed parameters. The keywords {'2-point', '3-point', 'cs'} can also be used to select a finite difference scheme for numerical estimation of the hessian. Alternatively, objects implementing the HessianUpdateStrategy interface can be used to approximate the Hessian. Available quasi-Newton methods implementing this interface are:Not all of the options are available for each of the methods; for availability refer to the notes.
hessp: callable, optionalHessian of objective function times an arbitrary vector p. Only for Newton-CG, trust-ncg, trust-krylov, trust-constr. Only one of
hessporhessneeds to be given. Ifhessis provided, thenhesspwill be ignored.hesspmust compute the Hessian times an arbitrary vectorhessp(x, p, *args) -> ndarray shape (n,)where
xis a (n,) ndarray,pis an arbitrary vector with dimension (n,) andargsis a tuple with the fixed parameters.bounds: sequence or `Bounds`, optionalBounds on variables for Nelder-Mead, L-BFGS-B, TNC, SLSQP, Powell, trust-constr, COBYLA, and COBYQA methods. There are two ways to specify the bounds:
Instance of Bounds class.
Sequence of
(min, max)pairs for each element inx. None is used to specify no bound.
constraints: {Constraint, dict} or List of {Constraint, dict}, optionalConstraints definition. Only for COBYLA, COBYQA, SLSQP and trust-constr.
Constraints for 'trust-constr', 'cobyqa', and 'cobyla' are defined as a single object or a list of objects specifying constraints to the optimization problem. Available constraints are:
Constraints for COBYLA, SLSQP are defined as a list of dictionaries. Each dictionary with fields:
type
type
fun
fun
jac
jac
args
args
Equality constraint means that the constraint function result is to be zero whereas inequality means that it is to be non-negative.
tol: float, optionalTolerance for termination. When
tolis specified, the selected minimization algorithm sets some relevant solver-specific tolerance(s) equal totol. For detailed control, use solver-specific options.options: dict, optionalA dictionary of solver options. All methods except
TNCaccept the following generic options:maxiter
maxiter
disp
disp
For method-specific options, see
show_options().callback: callable, optionalA callable called after each iteration.
All methods except TNC support a callable with the signature
callback(intermediate_result: OptimizeResult)where
intermediate_resultis a keyword parameter containing an OptimizeResult with attributesxandfun, the present values of the parameter vector and objective function. Not all attributes of OptimizeResult may be present. The name of the parameter must beintermediate_resultfor the callback to be passed an OptimizeResult. These methods will also terminate if the callback raisesStopIteration.All methods except trust-constr (also) support a signature like
callback(xk)where
xkis the current parameter vector.Introspection is used to determine which of the signatures above to invoke.
Returns
res: OptimizeResultThe optimization result represented as a
OptimizeResultobject. Important attributes are:xthe solution array,successa Boolean flag indicating if the optimizer exited successfully andmessagewhich describes the cause of the termination. See OptimizeResult for a description of other attributes.
Notes
This section describes the available solvers that can be selected by the 'method' parameter. The default method is BFGS.
Unconstrained minimization
Method CG <optimize.minimize-cg> uses a nonlinear conjugate gradient algorithm by Polak and Ribiere, a variant of the Fletcher-Reeves method described in [5] pp.120-122. Only the first derivatives are used.
Method BFGS <optimize.minimize-bfgs> uses the quasi-Newton method of Broyden, Fletcher, Goldfarb, and Shanno (BFGS) [5] pp. 136. It uses the first derivatives only. BFGS has proven good performance even for non-smooth optimizations. This method also returns an approximation of the Hessian inverse, stored as hess_inv in the OptimizeResult object.
Method Newton-CG <optimize.minimize-newtoncg> uses a Newton-CG algorithm [5] pp. 168 (also known as the truncated Newton method). It uses a CG method to the compute the search direction. See also TNC method for a box-constrained minimization with a similar algorithm. Suitable for large-scale problems.
Method dogleg <optimize.minimize-dogleg> uses the dog-leg trust-region algorithm [5] for unconstrained minimization. This algorithm requires the gradient and Hessian; furthermore the Hessian is required to be positive definite.
Method trust-ncg <optimize.minimize-trustncg> uses the Newton conjugate gradient trust-region algorithm [5] for unconstrained minimization. This algorithm requires the gradient and either the Hessian or a function that computes the product of the Hessian with a given vector. Suitable for large-scale problems.
Method trust-krylov <optimize.minimize-trustkrylov> uses the Newton GLTR trust-region algorithm [14], [15] for unconstrained minimization. This algorithm requires the gradient and either the Hessian or a function that computes the product of the Hessian with a given vector. Suitable for large-scale problems. On indefinite problems it requires usually less iterations than the trust-ncg method and is recommended for medium and large-scale problems.
Method trust-exact <optimize.minimize-trustexact> is a trust-region method for unconstrained minimization in which quadratic subproblems are solved almost exactly [13]. This algorithm requires the gradient and the Hessian (which is not required to be positive definite). It is, in many situations, the Newton method to converge in fewer iterations and the most recommended for small and medium-size problems.
Bound-Constrained minimization
Method Nelder-Mead <optimize.minimize-neldermead> uses the Simplex algorithm [1], [2]. This algorithm is robust in many applications. However, if numerical computation of derivative can be trusted, other algorithms using the first and/or second derivatives information might be preferred for their better performance in general.
Method L-BFGS-B <optimize.minimize-lbfgsb> uses the L-BFGS-B algorithm [6], [7] for bound constrained minimization.
Method Powell <optimize.minimize-powell> is a modification of Powell's method [3], [4] which is a conjugate direction method. It performs sequential one-dimensional minimizations along each vector of the directions set (direc field in options and info), which is updated at each iteration of the main minimization loop. The function need not be differentiable, and no derivatives are taken. If bounds are not provided, then an unbounded line search will be used. If bounds are provided and the initial guess is within the bounds, then every function evaluation throughout the minimization procedure will be within the bounds. If bounds are provided, the initial guess is outside the bounds, and direc is full rank (default has full rank), then some function evaluations during the first iteration may be outside the bounds, but every function evaluation after the first iteration will be within the bounds. If direc is not full rank, then some parameters may not be optimized and the solution is not guaranteed to be within the bounds.
Method TNC <optimize.minimize-tnc> uses a truncated Newton algorithm [5], [8] to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the Newton-CG method described above as it wraps a C implementation and allows each variable to be given upper and lower bounds.
Constrained Minimization
Method COBYLA <optimize.minimize-cobyla> uses the PRIMA implementation [19] of the Constrained Optimization BY Linear Approximation (COBYLA) method [9], [10], [11]. The algorithm is based on linear approximations to the objective function and each constraint.
Method COBYQA <optimize.minimize-cobyqa> uses the Constrained Optimization BY Quadratic Approximations (COBYQA) method [18]. The algorithm is a derivative-free trust-region SQP method based on quadratic approximations to the objective function and each nonlinear constraint. The bounds are treated as unrelaxable constraints, in the sense that the algorithm always respects them throughout the optimization process.
Method SLSQP <optimize.minimize-slsqp> uses Sequential Least SQuares Programming to minimize a function of several variables with any combination of bounds, equality and inequality constraints. The method wraps the SLSQP Optimization subroutine originally implemented by Dieter Kraft [12]. Note that the wrapper handles infinite values in bounds by converting them into large floating values.
Method trust-constr <optimize.minimize-trustconstr> is a trust-region algorithm for constrained optimization. It switches between two implementations depending on the problem definition. It is the most versatile constrained minimization algorithm implemented in SciPy and the most appropriate for large-scale problems. For equality constrained problems it is an implementation of Byrd-Omojokun Trust-Region SQP method described in [17] and in [5], p. 549. When inequality constraints are imposed as well, it switches to the trust-region interior point method described in [16]. This interior point algorithm, in turn, solves inequality constraints by introducing slack variables and solving a sequence of equality-constrained barrier problems for progressively smaller values of the barrier parameter. The previously described equality constrained SQP method is used to solve the subproblems with increasing levels of accuracy as the iterate gets closer to a solution.
Finite-Difference Options
For Method trust-constr <optimize.minimize-trustconstr> the gradient and the Hessian may be approximated using three finite-difference schemes: {'2-point', '3-point', 'cs'}. The scheme 'cs' is, potentially, the most accurate but it requires the function to correctly handle complex inputs and to be differentiable in the complex plane. The scheme '3-point' is more accurate than '2-point' but requires twice as many operations. If the gradient is estimated via finite-differences the Hessian must be estimated using one of the quasi-Newton strategies.
Method specific options for the hess keyword
+--------------+------+----------+-------------------------+-----+ | method/Hess | None | callable | '2-point/'3-point'/'cs' | HUS | +==============+======+==========+=========================+=====+ | Newton-CG | x | (n, n) | x | x | | | | LO | | | +--------------+------+----------+-------------------------+-----+ | dogleg | | (n, n) | | | +--------------+------+----------+-------------------------+-----+ | trust-ncg | | (n, n) | x | x | +--------------+------+----------+-------------------------+-----+ | trust-krylov | | (n, n) | x | x | +--------------+------+----------+-------------------------+-----+ | trust-exact | | (n, n) | | | +--------------+------+----------+-------------------------+-----+ | trust-constr | x | (n, n) | x | x | | | | LO | | | | | | sp | | | +--------------+------+----------+-------------------------+-----+
where LO=LinearOperator, sp=Sparse matrix, HUS=HessianUpdateStrategy
Custom minimizers
It may be useful to pass a custom minimization method, for example when using a frontend to this method such as scipy.optimize.basinhopping or a different library. You can simply pass a callable as the method parameter.
The callable is called as method(fun, x0, args, **kwargs, **options) where kwargs corresponds to any other parameters passed to minimize (such as callback, hess, etc.), except the options dict, which has its contents also passed as method parameters pair by pair. Also, if jac has been passed as a bool type, jac and fun are mangled so that fun returns just the function values and jac is converted to a function returning the Jacobian. The method shall return an OptimizeResult object.
The provided method callable must be able to accept (and possibly ignore) arbitrary parameters; the set of parameters accepted by minimize may expand in future versions and then these parameters will be passed to the method. You can find an example in the scipy.optimize tutorial.
Examples
Let us consider the problem of minimizing the Rosenbrock function. This function (and its respective derivatives) is implemented in `rosen` (resp. `rosen_der`, `rosen_hess`) in the `scipy.optimize`.from scipy.optimize import minimize, rosen, rosen_der
✓x0 = [1.3, 0.7, 0.8, 1.9, 1.2] res = minimize(rosen, x0, method='Nelder-Mead', tol=1e-6)✓
res.x
✗res = minimize(rosen, x0, method='BFGS', jac=rosen_der, options={'gtol': 1e-6, 'disp': True})✓
res.x
✗print(res.message)
✓res.hess_inv
✗fun = lambda x: (x[0] - 1)**2 + (x[1] - 2.5)**2
✓cons = ({'type': 'ineq', 'fun': lambda x: x[0] - 2 * x[1] + 2}, {'type': 'ineq', 'fun': lambda x: -x[0] - 2 * x[1] + 6}, {'type': 'ineq', 'fun': lambda x: -x[0] + 2 * x[1] + 2})✓
bnds = ((0, None), (0, None))
✓res = minimize(fun, (2, 0), method='SLSQP', bounds=bnds, constraints=cons)
✓cons[0]['fun'](res.x)
✓res.multipliers
✓eps = 0.01 cons[0]['fun'] = lambda x: x[0] - 2 * x[1] + 2 - eps✓
eps * res.multipliers[0] # Expected change in f0
✗f0 = res.fun # Keep track of the previous optimal value res = minimize(fun, (2, 0), method='SLSQP', bounds=bnds, constraints=cons) f1 = res.fun # New optimal value f1 - f0✓
See also
- minimize_scalar
Interface to minimization algorithms for scalar univariate functions
- show_options
Additional options accepted by the solvers
Aliases
-
scipy.optimize.minimize
Referenced by
This package
- release:0.15.0-notes
- release:1.0.0-notes
- release:1.1.0-notes
- release:1.11.0-notes
- release:1.12.0-notes
- release:1.14.0-notes
- release:1.16.0-notes
- release:1.4.0-notes
- release:1.8.0-notes
- scipy.optimize._basinhopping:basinhopping
- scipy.optimize._differentialevolution:differential_evolution
- scipy.optimize._differentialevolution:DifferentialEvolutionSolver
- scipy.optimize._lbfgsb_py:_minimize_lbfgsb
- scipy.optimize._lbfgsb_py:fmin_l_bfgs_b
- scipy.optimize._minimize:minimize_scalar
- scipy.optimize._optimize:show_options