search

JuliaNLSolvers / Optim.jl

Optimization functions for Julia
Other
1.11k stars 213 forks source link

Docstring for `optimize` #1032

Open KronosTheLate opened 1 year ago

KronosTheLate commented 1 year ago

As a key function of the package (the most important one?), optimize should have a docstring, with examples and common signatures. Perhaps also pointing to the documentation, and saying that it is a complicated function that is worth understanding well before using the package.

pkofod commented 1 year ago

Yes, I agree that that would be nice.

jariji commented 4 months ago

A complete list of functions is at https://julianlsolvers.github.io/Optim.jl/dev/user/minimization/#Complete-list-of-functions. I'm not sure any of them have docstrings.

Defined for all methods:

summary(res) minimizer(res) minimum(res) iterations(res) iteration_limit_reached(res) trace(res) x_trace(res) f_trace(res) f_calls(res) converged(res)

Defined for univariate optimization:

lower_bound(res) upper_bound(res) x_lower_trace(res) x_upper_trace(res) rel_tol(res) abs_tol(res)

Defined for multivariate optimization:

g_norm_trace(res) g_calls(res) x_converged(res) f_converged(res) g_converged(res) initial_state(res)