Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The help to solve does not explain the result. #587

Open
knuds opened this issue Sep 8, 2023 · 3 comments
Open

The help to solve does not explain the result. #587

knuds opened this issue Sep 8, 2023 · 3 comments

Comments

@knuds
Copy link

knuds commented Sep 8, 2023

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 ?

@Vaibhavdixit02
Copy link
Member

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/

@knuds
Copy link
Author

knuds commented Sep 8, 2023

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.

@ChrisRackauckas
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants