How to use Katib UI

How to access and use Katib UI

This page describes how to access and use Katib UI. Follow the installation page to install Katib control plane before accessing Katib UI.

You can use the Katib user interface (UI) to submit Katib Experiments and to monitor your Experiments results.

Accessing Katib UI from Kubeflow Central Dashboard

If you install Katib as part of Kubeflow platform, you can access Katib UI via Kubeflow Central Dashboard. Click Experiments (AutoML) in the left-hand menu:

The Katib UI within the Kubeflow Central Dashboard

Accessing Katib UI Standalone

You can access Katib UI standalone without Kubeflow Central Dashboard. For that, port-forward the Katib UI service:

kubectl port-forward svc/katib-ui -n kubeflow 8080:80

Use this URL to access Katib UI:

http://localhost:8080/katib/

You need to select namespace to view Katib Experiments:

The Katib UI Standalone

Running Hyperparameter Tuning Experiment from Katib UI

You can submit an hyperparameter tuning Experiment from the Katib UI.

Create Katib Experiment

  1. Click New Experiment on the Katib home page.

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

    • Metadata: Type name of your Experiment.

    • Trial Thresholds: Choose how many Trials you want to run.

    • Objective: Add metrics that you want to optimize and type of optimization.

    • Search Algorithm: Select hyperparameter tuning algorithm and configure algorithm settings.

    • Early Stopping: Add early stopping algorithm if that is required.

    • Hyper Parameters: Add hyperparameters and search space that you want to optimize.

    • Metrics Collector: Modify metrics collector type if that is required.

    • Trial Template: Configure parameters for your Trial template. Every hyperparameter must have reference to the trialParameters values.

    Deploy Katib Experiment using parameters

  3. (Optional) If you want to modify Experiment YAML, you can click edit and submit YAML at the bottom.

    Deploy Katib Experiment using YAML

  4. Create Katib Experiment.

Get Katib Experiment Results

Follow these steps to get Katib Experiment results:

  1. You should be able to view the list of Experiments on Katib UI home page:

    List of Katib Experiments

  2. Click the name of your Experiment. For example, click random-example.

  3. There should be a graph showing the level of validation and train accuracy for various combinations of the hyperparameter values (learning rate, number of layers, and optimizer):

    Graph produced by the random example

  4. If you click to the Trials tab, you will see list of Trials that ran withing the Experiment.

    Trials that ran during the Experiment

  5. You can click on Trial name to get metrics for the particular Trial:

    Trial metrics graph

Create Katib Experiment with Early Stopping

Follow this guide to learn how early stopping works in Katib.

  1. Select early stopping algorithm while creating Katib Experiment:

    Katib Experiment with Early Stopping

  2. After your Experiment is complete, you can check your results in the Katib UI. The Trial statuses on the Experiment monitor page should look as follows:

    Trials view with early stopping

  3. You can click on the early stopped Trial name to get reported metrics before this Trial was early stopped:

    Early stopped Trial metrics

Next Steps

Feedback

Was this page helpful?