scipy.optimize.show_options

scipy.optimize.show_options(solver=None, method=None, disp=True)[source]

Show documentation for additional options of optimization solvers.

These are method-specific options that can be supplied through the options dict.

Parameters:

solver : str

Type of optimization solver. One of ‘minimize’, ‘minimize_scalar’, ‘root’, or ‘linprog’.

method : str, optional

If not given, shows all methods of the specified solver. Otherwise, show only the options for the specified method. Valid values corresponds to methods’ names of respective solver (e.g. ‘BFGS’ for ‘minimize’).

disp : bool, optional

Whether to print the result rather than returning it.

Returns:

text

Either None (for disp=False) or the text string (disp=True)

Notes

The solver-specific methods are:

scipy.optimize.minimize

scipy.optimize.root

scipy.optimize.minimize_scalar

scipy.optimize.linprog