-
Notifications
You must be signed in to change notification settings - Fork 481
Closed
Labels
Description
/kind discussion
As we discussed in the community meetings, we should keep Katib README simple with only necessary information.
My Suggestion that we remove the following sections:
- Getting Started
- Name
- Concepts in Katib, since it is similar to: https://www.kubeflow.org/docs/components/katib/overview/#katib-concepts.
For theSearch Algorithms
we can create a table with supported AutoML techniques, algorithms. @gaocegege @johnugeorge What do you think ? - Components in Katib - We can add this section to kubeflow.org docs.
- Web UI - similar to https://www.kubeflow.org/docs/components/katib/overview/#hyperparameters-and-hyperparameter-tuning.
- GRPC API Documentation - Move it to kubeflow.org docs.
- Katib SDK - Described in https://www.kubeflow.org/docs/components/katib/overview/#katib-interfaces.
- Quick Start
Installation section should be simplified. Remove it completely and add link to: https://www.kubeflow.org/docs/components/katib/hyperparameter/#installing-katib or explain how to install particular version of Katib.
Contributing and Citation section can be moved to Community.
What do you think @gaocegege @johnugeorge @jbottum @RFMVasconcelos ?