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

Update Katib images for new UI #2943

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 11 additions & 25 deletions content/en/docs/components/katib/experiment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title = "Running an Experiment"
description = "How to configure and run a hyperparameter tuning or neural architecture search experiment in Katib"
weight = 30

+++

This guide describes how to configure and run a Katib experiment.
Expand Down Expand Up @@ -321,12 +321,12 @@ Katib supports the following algorithm settings:
<tbody>
<tr>
<td>base_estimator</td>
<td>[“GP”, “RF”, “ET”, “GBRT” or sklearn regressor, default=“GP”]:
<td>[“GP”, “RF”, “ET”, “GBRT” or sklearn regressor, default=“GP”]:
Should inherit from <code>sklearn.base.RegressorMixin</code>.
The <code>predict</code> method should have an optional
<code>return_std</code> argument, which returns
<code>std(Y | x)</code> along with <code>E[Y | x]</code>. If
<code>base_estimator</code> is one of
The <code>predict</code> method should have an optional
<code>return_std</code> argument, which returns
<code>std(Y | x)</code> along with <code>E[Y | x]</code>. If
<code>base_estimator</code> is one of
[“GP”, “RF”, “ET”, “GBRT”], the system uses a default surrogate model
of the corresponding type. Learn more information in the
<a href="https://scikit-optimize.github.io/stable/modules/generated/skopt.Optimizer.html#skopt.Optimizer">skopt
Expand All @@ -335,10 +335,10 @@ Katib supports the following algorithm settings:
</tr>
<tr>
<td>n_initial_points</td>
<td>[int, default=10]: Number of evaluations of <code>func</code> with
initialization points before approximating it with
<td>[int, default=10]: Number of evaluations of <code>func</code> with
initialization points before approximating it with
<code>base_estimator</code>. Points provided as <code>x0</code> count
as initialization points.
as initialization points.
If <code>len(x0) &lt; n_initial_points</code>, the
system samples additional points at random. Learn more information in the
<a href="https://scikit-optimize.github.io/stable/modules/generated/skopt.Optimizer.html#skopt.Optimizer">skopt
Expand All @@ -355,7 +355,7 @@ Katib supports the following algorithm settings:
</tr>
<tr>
<td>acq_optimizer</td>
<td>[string, “sampling” or “lbfgs”, default=“auto”]: The method to
<td>[string, “sampling” or “lbfgs”, default=“auto”]: The method to
minimize the acquisition function. The system updates the fit model
with the optimal value obtained by optimizing <code>acq_func</code>
with <code>acq_optimizer</code>. Learn more information in the
Expand Down Expand Up @@ -908,14 +908,7 @@ To run a hyperparameter tuning experiment from the Katib UI:
1. Follow the getting-started guide to
[access the Katib UI](/docs/components/katib/hyperparameter/#katib-ui).

1. Click **Hyperparameter Tuning** on the Katib home page.

1. Open the Katib menu panel on the left, then open the **HP** section and
click **Submit**:

<img src="/docs/components/katib/images/menu.png"
alt="The Katib menu panel"
class="mt-3 mb-3 border border-info rounded">
1. Click **NEW EXPERIMENT** on the Katib home page.

1. You should be able to view tabs offering you the following options:

Expand All @@ -935,13 +928,6 @@ To run a hyperparameter tuning experiment from the Katib UI:

View the results of the experiment in the Katib UI:

1. Open the Katib menu panel on the left, then open the **HP** section and
click **Monitor**:

<img src="/docs/components/katib/images/menu.png"
alt="The Katib menu panel"
class="mt-3 mb-3 border border-info rounded">

1. You should be able to view the list of experiments:

<img src="/docs/components/katib/images/experiment-list.png"
Expand Down
35 changes: 1 addition & 34 deletions content/en/docs/components/katib/hyperparameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title = "Getting Started with Katib"
description = "How to set up Katib and perform hyperparameter tuning"
weight = 20

+++

This guide shows how to get started with Katib and run a few examples using the
Expand Down Expand Up @@ -131,30 +131,6 @@ http://localhost:8080/katib/
Check [this guide](https://github.com/kubeflow/katib/tree/master/pkg/ui/v1beta1)
if you want to contribute to Katib UI.

### The new Katib UI

During Kubeflow 1.3 we have worked on a new iteration of the UI, which is
rewritten in Angular and is utilizing the common code of the other Kubeflow
[dashboards](https://github.com/kubeflow/kubeflow/tree/master/components/crud-web-apps).
While this UI is not yet on par with the current default one, we are actively
working to get it up to speed and provide all the existing functionalities.

The users are currently able to list, delete and create Katib Experiments in
their cluster via this new UI as well as inspect the owned Trials.
One important missing functionalities are the ability to edit the Trial Template
ConfigMaps and view neural architecture search Experiments.

While this UI is not ready to replace the current one we would like to
encourage users to also give it a try and provide us with feedback.

To try it out you should update the Katib UI image `newName` with the new
registry `docker.io/kubeflowkatib/katib-new-ui` in the
[Kustomize manifests](https://github.com/kubeflow/katib/blob/master/manifests/v1beta1/installs/katib-standalone/kustomization.yaml#L29).

<img src="/docs/components/katib/images/new-ui.png"
alt="The Katib new UI"
class="mt-3 mb-3 border border-info rounded">

## Examples

This section introduces some examples that you can run to try Katib.
Expand Down Expand Up @@ -389,15 +365,6 @@ View the results of the experiment in the Katib UI:

1. Open the Katib UI as described [above](#katib-ui).

1. Click **Hyperparameter Tuning** on the Katib home page.

1. Open the Katib menu panel on the left, then open the **HP** section and
click **Monitor**:

<img src="/docs/components/katib/images/menu.png"
alt="The Katib menu panel"
class="mt-3 mb-3 border border-info rounded">

1. You should be able to view the list of experiments:

<img src="/docs/components/katib/images/experiment-list.png"
Expand Down
Binary file modified content/en/docs/components/katib/images/deploy-parameters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/en/docs/components/katib/images/deploy-yaml.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/en/docs/components/katib/images/experiment-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/en/docs/components/katib/images/home-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/en/docs/components/katib/images/nas-parameters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed content/en/docs/components/katib/images/new-ui.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.