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.

Sign up for GitHub

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

Jump to bottom

Better documentation for evaluation_function #71

Closed
HanGuo97 opened this issue May 5, 2019 · 3 comments
Closed

Better documentation for evaluation_function #71

HanGuo97 opened this issue May 5, 2019 · 3 comments
Assignees
@kkashin @lena-kashtelyan
Labels
question Further information is requested

Comments

@HanGuo97
Copy link

HanGuo97 commented May 5, 2019

Thanks to the team for the great work! I would appreciate if documentation for arguments like evaluation_function could be provided more explicitly in the tutorials. It took me a while to figure out the function should return a (mean, stderr) tuple when the outcome is a dictionary (https://github.com/facebook/Ax/blob/master/ax/core/types.py#L25).
@kkashin
Copy link
Contributor

kkashin commented May 7, 2019

Thanks for the feedback! We can make this more explicit in https://ax.dev/tutorials/gpei_hartmann_loop.html and https://ax.dev/tutorials/gpei_hartmann_service.html within the evaluation function sections. Would this make it clearer?

@kkashin kkashin added the question Further information is requested label May 7, 2019
@HanGuo97
Copy link
Author

HanGuo97 commented May 7, 2019

Thanks! This would definitely help.

facebook-github-bot pushed a commit that referenced this issue May 9, 2019
@lena-kashtelyan @facebook-github-bot
Update tutorials to better document evaluation function
c46d107 
Summary: We got some feedback that figuring out the format for evaluation function was non-trivial (#71). This should hopefully make it more clear!

Reviewed By: ldworkin

Differential Revision: D15246951

fbshipit-source-id: 52ad3c7499e7fdcd2f015424ad72900744ce1be5
@lena-kashtelyan
Copy link
Contributor

Better documentation is in on master. Please check out section on evaluation function, @HanGuo97!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kkashin kkashin

@lena-kashtelyan lena-kashtelyan

Labels
question Further information is requested
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kkashin @lena-kashtelyan @HanGuo97