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

Improve the Katib (hyperparameter tuning) docs #1425

Closed
sarahmaddox opened this issue Nov 28, 2019 · 2 comments · Fixed by #1480
Closed

Improve the Katib (hyperparameter tuning) docs #1425

sarahmaddox opened this issue Nov 28, 2019 · 2 comments · Fixed by #1480
Assignees
Labels
area/katib AREA: Kubeflow Katib kind/feature KIND: Features priority/p1

Comments

@sarahmaddox
Copy link
Contributor

sarahmaddox commented Nov 28, 2019

The Katib docs on the Kubeflow website don't do justice to the capabilities and UX provided by Katib:
https://www.kubeflow.org/docs/components/hyperparameter-tuning/hyperparameter/

The docs should be more visual, at least providing screenshots to get users oriented. Here's the current Katib starter page:
image

There are some docs on GitHub which we should merge into the website docs:
https://github.com/kubeflow/katib/

There was also some good content at the Kubeflow contributor summit in October 2019. I can't find any slides/recordings, but we should get hold of them and use them as input.

The Kubeflow v0.7 blog post also has useful info:

The Katib v1alpha3 API includes a new Suggestion CR which tracks the suggestions generated for each trial of an experiment by the corresponding algorithm service. The system architecture has been redesigned to make it more Kubernetes-native with better support for events. The v1alpha3 API also comes with a new metric collector implementation. Users can specify the metric collector type in the experiment config. Currently supported types are StdOutCollector(default), FileCollector and TFEventCollector. The internal database implementation is also refactored to support multiple database backends. This release also supports Prometheus metrics that includes controller runtime metrics and creation/deletion/success/failure counters for experiments and trials.

@issue-label-bot
Copy link

Issue-Label Bot is automatically applying the label kind/feature to this issue, with a confidence of 0.94. Please mark this comment with 👍 or 👎 to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

@issue-label-bot issue-label-bot bot added the kind/feature KIND: Features label Nov 28, 2019
@sarahmaddox
Copy link
Contributor Author

/assign

Starting work on this now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/katib AREA: Kubeflow Katib kind/feature KIND: Features priority/p1
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants