Refactor README

[andreyvelich]

Fixes: #1570.

I made some changes in the README to leave only necessary information for our users.

Few questions:

1. How do you feel about Algorithm table in this PR with HP, NAS and EarlyStopping headers ?
2. Do we want to add implementation in the Algorithm table with type of framework that we use (e.g. hyperopt, optuna, goptuna) ?
3. Any other information that we can add in the README (e.g. Why Katib ?) ?

Please take a look and give your feedback @gaocegege @johnugeorge @kimwnasptd @jbottum @RFMVasconcelos @anencore94 @tenzen-y @c-bata @g-votte

[google-oss-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andreyvelich

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [andreyvelich]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[anencore94]

Table looks nice :)

[anencore94]

What do you think about moving this sentence to right after #Installation, and add explanation following Installation is for stand-alone or for quick-start ?

[andreyvelich]

That is a good point, thanks @anencore94

[tenzen-y]

Thanks for adding the supported K8s version to this documentation.

It might be better to use the kustomize binary instead of the built-in kustomize, since the kustomize version used by each user may be very different, and the built-in kustomize does not immediately bug fixes.

What do you think @andreyvelich ?

[andreyvelich]

Thank you for the review @tenzen-y.

It might be better to use the kustomize binary instead of the built-in kustomize, since the kustomize version used by each user may be very different, and the built-in kustomize does not immediately bag fixes.

Before the installation we have the requirements that user should install kubectl >= 1.21 to deploy Katib.
Should we make sure that our Standalone kustomize manifest is compatible with that version of kubectl ?

That will remove additional step for the new users to install kustomize binary.

For most advance users they can always follow the Kubeflow Katib guide to manipulate kustomize manifests.

WDYT @tenzen-y @gaocegege @johnugeorge ?

[tenzen-y]

@andreyvelich

For most advance users they can always follow the Kubeflow Katib guide to manipulate kustomize manifests.

It sounds good. I was relieved to see that the detailed installation instructions are still available.

[johnugeorge]

Should we remove this till we add this section?

[andreyvelich]

Sure, does it look good to you: https://github.com/kubeflow/katib/blob/e2434e3c3c4001280d8ca1eb9d0af74fd17aed75/README.md#documentation ?
I made the similar sentences.

[johnugeorge]

One thing that we have to add is , Why Katib is a better choice ? We can take this up later

[andreyvelich]

One thing that we have to add is , Why Katib is a better choice ? We can take this up later

Sure, I created issue to track this.

[andreyvelich]

/retest

[gaocegege]

/lgtm

[gaocegege]

/hold

[johnugeorge]

/lgtm

[andreyvelich]

/hold cancel