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

Documentation for optimisation methods (MAP, MLE) #2164

Closed
ElOceanografo opened this issue Jan 31, 2024 · 4 comments
Closed

Documentation for optimisation methods (MAP, MLE) #2164

ElOceanografo opened this issue Jan 31, 2024 · 4 comments
Assignees

Comments

@ElOceanografo
Copy link
Contributor

Moving this question here from Discourse. The optim_problem interface to Optimization.jl is currently not documented anywhere. Is this intentional (e.g. because the interface is a moving target), or would a documentation PR be welcome?

@yebai
Copy link
Member

yebai commented May 25, 2024

Cc @mhauru

@mhauru
Copy link
Member

mhauru commented May 28, 2024

The optimization interface is undergoing an overhaul at #2221. Some of the old exported functions, such as optim_problem, that were undocumented, will no longer be exported/exist. Instead there will be new exported functions called maximum_likelihood and maximum_a_posteriori for doing MLE/MAP estimation.

I'll make sure that once the new interface is in it's at the very least covered in the API docs. Maybe add a tutorial as well?

@mhauru mhauru self-assigned this May 28, 2024
@yebai
Copy link
Member

yebai commented May 28, 2024

Yes, a new tutorial on optimisation would be great.

@yebai yebai changed the title Documentation for optim_problem? Documentation for optimisation methods (MAP, MLE) May 30, 2024
@yebai
Copy link
Member

yebai commented Jun 6, 2024

Fixed by TuringLang/docs#470

@yebai yebai closed this as completed Jun 6, 2024
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