Skip to content

Refactoring README information #1570

@andreyvelich

Description

@andreyvelich

/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:

  1. Getting Started
  2. Name
  3. Concepts in Katib, since it is similar to: https://www.kubeflow.org/docs/components/katib/overview/#katib-concepts.
    For the Search Algorithms we can create a table with supported AutoML techniques, algorithms. @gaocegege @johnugeorge What do you think ?
  4. Components in Katib - We can add this section to kubeflow.org docs.
  5. Web UI - similar to https://www.kubeflow.org/docs/components/katib/overview/#hyperparameters-and-hyperparameter-tuning.
  6. GRPC API Documentation - Move it to kubeflow.org docs.
  7. Katib SDK - Described in https://www.kubeflow.org/docs/components/katib/overview/#katib-interfaces.
  8. 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 ?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions