{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The option " }, { "__type": "ParamRef", "__tag": 4071, "name": "ftol" }, { "__type": "Text", "__tag": 4046, "value": " is exposed via the " }, { "__type": "CrossRef", "__tag": 4002, "value": "scipy.optimize.minimize", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "*", "kind": "api", "path": "scipy.optimize._minimize:minimize" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " interface, but calling " }, { "__type": "CrossRef", "__tag": 4002, "value": "scipy.optimize.fmin_l_bfgs_b", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "*", "kind": "api", "path": "scipy.optimize._lbfgsb_py:fmin_l_bfgs_b" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " directly exposes " }, { "__type": "InlineRole", "__tag": 4003, "value": "factr", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ". The relationship between the two is " }, { "__type": "InlineCode", "__tag": 4051, "value": "ftol = factr * numpy.finfo(float).eps" }, { "__type": "Text", "__tag": 4046, "value": ". I.e., " }, { "__type": "InlineRole", "__tag": 4003, "value": "factr", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " multiplies the default machine floating-point precision to arrive at " }, { "__type": "ParamRef", "__tag": 4071, "name": "ftol" }, { "__type": "Text", "__tag": 4046, "value": ". If the minimization is slow to converge the optimizer may halt if the total number of function evaluations exceeds " }, { "__type": "ParamRef", "__tag": 4071, "name": "maxfun" }, { "__type": "Text", "__tag": 4046, "value": ", or the number of algorithm iterations has reached " }, { "__type": "ParamRef", "__tag": 4071, "name": "maxiter" }, { "__type": "Text", "__tag": 4046, "value": " (whichever comes first). If this is the case then " }, { "__type": "InlineCode", "__tag": 4051, "value": "result.success=False" }, { "__type": "Text", "__tag": 4046, "value": ", and an appropriate error message is contained in " }, { "__type": "InlineCode", "__tag": 4051, "value": "result.message" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Minimize a scalar function of one or more variables using the L-BFGS-B algorithm." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "disp", "annotation": "None or int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Deprecated option that previously controlled the text printed on the screen during the problem solution. Now the code does not emit any output and this keyword has no function." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "deprecated", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "deprecated 1.15.0" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This keyword is deprecated and will be removed from SciPy 1.18.0." } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "maxcor", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The maximum number of variable metric corrections used to define the limited memory matrix. (The limited memory BFGS method does not store the full hessian but uses this many terms in an approximation to it.)" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "ftol", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The iteration stops when " }, { "__type": "InlineCode", "__tag": 4051, "value": "(f^k - f^{k+1})/max{|f^k|,|f^{k+1}|,1} <= ftol" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "gtol", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The iteration will stop when " }, { "__type": "InlineCode", "__tag": 4051, "value": "max{|proj g_i | i = 1, ..., n} <= gtol" }, { "__type": "Text", "__tag": 4046, "value": " where " }, { "__type": "InlineCode", "__tag": 4051, "value": "proj g_i" }, { "__type": "Text", "__tag": 4046, "value": " is the i-th component of the projected gradient." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "eps", "annotation": "float or ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineRole", "__tag": 4003, "value": "jac is None", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " the absolute step size used for numerical approximation of the jacobian via forward differences." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "maxfun", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum number of function evaluations before minimization terminates. Note that this function may violate the limit if the gradients are evaluated by numerical differentiation." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "maxiter", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum number of algorithm iterations." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "iprint", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Deprecated option that previously controlled the text printed on the screen during the problem solution. Now the code does not emit any output and this keyword has no function." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "deprecated", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "deprecated 1.15.0" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This keyword is deprecated and will be removed from SciPy 1.18.0." } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "maxls", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum number of line search steps (per iteration). Default is 20." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "finite_diff_rel_step", "annotation": "None or array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "jac in ['2-point', '3-point', 'cs']" }, { "__type": "Text", "__tag": 4046, "value": " the relative step size to use for numerical approximation of the jacobian. The absolute step size is computed as " }, { "__type": "InlineCode", "__tag": 4051, "value": "h = rel_step * sign(x) * max(1, abs(x))" }, { "__type": "Text", "__tag": 4046, "value": ", possibly adjusted to fit into the bounds. For " }, { "__type": "InlineCode", "__tag": 4051, "value": "method='3-point'" }, { "__type": "Text", "__tag": 4046, "value": " the sign of " }, { "__type": "InlineRole", "__tag": 4003, "value": "h", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is ignored. If None (default) then step is selected automatically." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "workers", "annotation": "int, map-like callable, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A map-like callable, such as " }, { "__type": "InlineRole", "__tag": 4003, "value": "multiprocessing.Pool.map", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for evaluating any numerical differentiation in parallel. This evaluation is carried out as " }, { "__type": "InlineCode", "__tag": 4051, "value": "workers(fun, iterable)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.16.0" } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "/scipy/optimize/_lbfgsb_py.py", "item_line": 294, "item_type": "function", "aliases": [ "scipy.optimize._lbfgsb_py._minimize_lbfgsb" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "fun", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "x0", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "args", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "()" }, { "__type": "SigParam", "__tag": 4030, "name": "jac", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "bounds", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "disp", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "" }, { "__type": "SigParam", "__tag": 4030, "name": "maxcor", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "10" }, { "__type": "SigParam", "__tag": 4030, "name": "ftol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "2.220446049250313e-09" }, { "__type": "SigParam", "__tag": 4030, "name": "gtol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1e-05" }, { "__type": "SigParam", "__tag": 4030, "name": "eps", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1e-08" }, { "__type": "SigParam", "__tag": 4030, "name": "maxfun", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "15000" }, { "__type": "SigParam", "__tag": 4030, "name": "maxiter", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "15000" }, { "__type": "SigParam", "__tag": 4030, "name": "iprint", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "" }, { "__type": "SigParam", "__tag": 4030, "name": "callback", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "maxls", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "20" }, { "__type": "SigParam", "__tag": 4030, "name": "finite_diff_rel_step", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "workers", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "unknown_options", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "VAR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "_minimize_lbfgsb" }, "references": null, "qa": "scipy.optimize._lbfgsb_py:_minimize_lbfgsb", "arbitrary": [], "local_refs": [ "disp", "eps", "finite_diff_rel_step", "ftol", "gtol", "iprint", "maxcor", "maxfun", "maxiter", "maxls", "workers" ] }