Moved some content and added links to Kubeflow docs #990
Conversation
sarahmaddox
changed the title
|
/assign @gaocegege Please would you review this PR and its companion PR kubeflow/website#1480. My goal is to centralize the Katib user docs, so that people can find them more easily, and to make Katib easier to use by showing people how it works within Kubeflow. |
|
/lgtm |
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: richardsliu 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:
Approvers can indicate their approval by writing |
| @@ -34,12 +34,22 @@ The system is inspired by [Google vizier][3] and supports multiple ML/DL framewo | |||
|
|
|||
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | |||
|
|
|||
| ## Getting Started | |||
There was a problem hiding this comment.
Nit: Update titles to sentence case
| @@ -34,12 +34,22 @@ The system is inspired by [Google vizier][3] and supports multiple ML/DL framewo | |||
|
|
|||
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | |||
|
|
|||
There was a problem hiding this comment.
Not sure where the source of the TOC is, but on line 29: Pytorch --> PyTorch
| - **parallelTrialCount**: This fields specifies how many sets of hyperparameter to be tested in parallel at most. | ||
| - **maxFailedTrialCount**: Some sets of hyperparameter corresponding jobs maybe fail somehow. If the failed count of hyperparameter set exceeds `maxFailedTrialCount`, the hyperparameter tuning for the model will be stopped with `Failed` status. | ||
| When you want to tune hyperparameter for your machine learning model before | ||
| training it further, you just need create an `Experiment` CR like above. To |
| - **maxFailedTrialCount**: Some sets of hyperparameter corresponding jobs maybe fail somehow. If the failed count of hyperparameter set exceeds `maxFailedTrialCount`, the hyperparameter tuning for the model will be stopped with `Failed` status. | ||
| When you want to tune hyperparameter for your machine learning model before | ||
| training it further, you just need create an `Experiment` CR like above. To | ||
| lear what fields are included in the `Experiment.spec`, see |
| - **maxTrialCount**: It specifies how many sets of hyperparameter can be generated to test the model at most. | ||
| - **parallelTrialCount**: This fields specifies how many sets of hyperparameter to be tested in parallel at most. | ||
| - **maxFailedTrialCount**: Some sets of hyperparameter corresponding jobs maybe fail somehow. If the failed count of hyperparameter set exceeds `maxFailedTrialCount`, the hyperparameter tuning for the model will be stopped with `Failed` status. | ||
| When you want to tune hyperparameter for your machine learning model before |
|
Thanks @thedriftofwords for the tech writer review! Since the comments are about typos, and since all except one are pre-existing typos, I'll let this PR go thru as is and I'll submit a followup PR to fix the typos. Just waiting on a final LGTM on the related kubeflow/website#1480, then this one can go through too. |
|
/hold cancel |
What this PR does / why we need it: This PR moves some content from the Katib repo to the Kubeflow docs and adds links to the Kubeflow docs, which will soon
contain detailed information about Katib. See companion PR kubeflow/website#1480.
My goal is to centralize the Katib user docs, so that people can find them more easily, and to make Katib easier to use by showing people how it works within Kubeflow.
Which issue(s) this PR fixes :
Related to issue kubeflow/website#1425
Special notes for your reviewer:
Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.
No change to image versions.
Hold this PR until PR Expanded and clarified the Katib docs website#1480 is merged.
Companion PR Expanded and clarified the Katib docs website#1480 adds detailed information about Katib to the Kubeflow docs. You can see the preview of the new docs here:
Release note:
This PR is now ready for review. Applying a hold to allow for multiple reviewers.
/hold
This change is