Optimization.jl icon indicating copy to clipboard operation
Optimization.jl copied to clipboard

The help to solve does not explain the result.

Open knuds opened this issue 1 year ago • 3 comments

When you type ?Optimization.solve you get a good overview of the arguments to solve.

But the result of solve: res=Optimization.solve(...) Is not explained !! I have seen res.u and res.minimizer used! But what is the difference ? Is there any other useful properties of res the users should know about ?

knuds avatar Sep 08 '23 13:09 knuds

You'd have to do ?Optimization.OptimizationSolution which is probably not ideal, but there's no other way to do that, maybe the solve docstring can include it. Meanwhile you can look at the documentation https://docs.sciml.ai/Optimization/stable/API/optimization_solution/

Vaibhavdixit02 avatar Sep 08 '23 13:09 Vaibhavdixit02

I think the doc should say where to find info about the return type. The signature in the document are CommonSolve.solve(prob::ProblemType,alg::SolverType; kwargs...)::SolutionType But if I lookup ?SolutionType, ?CommonSolve.SolutionType or ?Optimization.SolutionType I get errors.

knuds avatar Sep 08 '23 14:09 knuds

That is a good point. Indeed we should in the documentation of solve say what the expected return type is.

ChrisRackauckas avatar Sep 14 '23 12:09 ChrisRackauckas