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

Change the default image for the new Katib UI #1608

Merged
merged 9 commits into from
Aug 11, 2021
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
64 changes: 7 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,42 +20,6 @@ It can tune hyperparameters of applications written in any language of the
users’ choice and natively supports many ML frameworks, such as TensorFlow,
MXNet, PyTorch, XGBoost, and others.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

# Table of Contents

- [Getting Started](#getting-started)
- [Name](#name)
- [Concepts in Katib](#concepts-in-katib)
- [Experiment](#experiment)
- [Suggestion](#suggestion)
- [Trial](#trial)
- [Worker Job](#worker-job)
- [Search Algorithms](#search-algorithms)
- [Hyperparameter Tuning](#hyperparameter-tuning)
- [Neural Architecture Search](#neural-architecture-search)
- [Components in Katib](#components-in-katib)
- [Web UI](#web-ui)
- [New UI](#new-ui)
- [GRPC API documentation](#grpc-api-documentation)
- [Installation](#installation)
- [TF operator](#tf-operator)
- [PyTorch operator](#pytorch-operator)
- [Katib](#katib)
- [Running examples](#running-examples)
- [Katib SDK](#katib-sdk)
- [Cleanups](#cleanups)
- [Quick Start](#quick-start)
- [Community](#community)
- [Blog posts](#blog-posts)
- [Contributing](#contributing)
- [Citation](#citation)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Created by [doctoc](https://github.com/thlorenz/doctoc).

## Getting Started

Follow the
Expand Down Expand Up @@ -169,34 +133,20 @@ and the API is defined at `pkg/apis/manager/v1beta1/api.proto`.
## Web UI

Katib provides a Web UI.
You can visualize general trend of Hyper parameter space and
each training history. You can use
[random-example](https://github.com/kubeflow/katib/blob/master/examples/v1beta1/random-example.yaml)
or
[other examples](https://github.com/kubeflow/katib/blob/master/examples/v1beta1)
to generate a similar UI. Follow the
[Kubeflow documentation](https://www.kubeflow.org/docs/components/katib/hyperparameter/#katib-ui)
to access the Katib UI.
![katibui](./docs/images/katib-ui.png)

### New UI

During 1.3 we've 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 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 TrialTemplate ConfigMaps.
missing functionalities are the ability to edit the Trial templates ConfigMaps
and view Neural Architecture Search models. Check [this Project](https://github.com/kubeflow/katib/projects/1)
to monitor the current progress.

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 the user has to update the Katib UI image `newName` with the new registry
`docker.io/kubeflowkatib/katib-new-ui` in the [Kustomize](https://github.com/kubeflow/katib/blob/54854c1bb/manifests/v1beta1/installs/katib-standalone/kustomization.yaml#L29)
manifests.
![katibui](./docs/images/katib-ui.png)

![newkatibui](./docs/images/katib-new-ui.png)
To use the old Katib UI you can update the Katib image `newName` with the previous
image tag `docker.io/kubeflowkatib/katib-ui:v0.11.1` in the [Kustomize](./manifests/v1beta1/installs/katib-standalone/kustomization.yaml#L29)
manifests.

## GRPC API documentation

Expand Down
Binary file removed docs/images/katib-new-ui.png
Binary file not shown.
Binary file modified docs/images/katib-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 2 additions & 4 deletions scripts/v1beta1/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,9 @@ docker build -t ${REGISTRY}/katib-controller:${TAG} -f ${CMD_PREFIX}/katib-contr
echo -e "\nBuilding Katib DB manager image...\n"
docker build -t ${REGISTRY}/katib-db-manager:${TAG} -f ${CMD_PREFIX}/db-manager/${VERSION}/Dockerfile .

# TODO (andreyvelich): Switch to ${CMD_PREFIX}/ui/${VERSION}/Dockerfile once old UI is deprecated.
echo -e "\nBuilding Katib UI image...\n"
docker build -t ${REGISTRY}/katib-ui:${TAG} -f ${CMD_PREFIX}/ui/${VERSION}/Dockerfile .

echo -e "\nBuilding Katib new UI image...\n"
docker build -t ${REGISTRY}/katib-new-ui:${TAG} -f ${CMD_PREFIX}/new-ui/${VERSION}/Dockerfile .
docker build -t ${REGISTRY}/katib-ui:${TAG} -f ${CMD_PREFIX}/new-ui/${VERSION}/Dockerfile .

echo -e "\nBuilding Katib cert generator image...\n"
docker build -t ${REGISTRY}/cert-generator:${TAG} -f ${CMD_PREFIX}/cert-generator/${VERSION}/Dockerfile .
Expand Down
3 changes: 0 additions & 3 deletions scripts/v1beta1/push.sh
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,6 @@ docker push ${REGISTRY}/katib-db-manager:${TAG}
echo -e "\nPushing Katib UI image...\n"
docker push ${REGISTRY}/katib-ui:${TAG}

echo -e "\nPushing Katib new UI image...\n"
docker push ${REGISTRY}/katib-new-ui:${TAG}

echo -e "\nPushing Katib cert generator image...\n"
docker push ${REGISTRY}/cert-generator:${TAG}

Expand Down
14 changes: 2 additions & 12 deletions test/workflows/components/workflows-v1beta1.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -233,10 +233,6 @@
name: "build-ui",
template: "build-ui",
},
{
name: "build-new-ui",
template: "build-new-ui",
},
{
name: "build-cert-generator",
template: "build-cert-generator",
Expand Down Expand Up @@ -425,17 +421,11 @@
]), // build katib-db-manager
$.parts(namespace, name, overrides).e2e(prow_env, bucket).buildTemplate("build-ui", kanikoExecutorImage, [
"/kaniko/executor",
"--dockerfile=" + katibDir + "/cmd/ui/v1beta1/Dockerfile",
// TODO (andreyvelich): Switch to katibDir + "/cmd/ui/v1beta1/Dockerfile" once old UI is deprecated.
"--dockerfile=" + katibDir + "/cmd/new-ui/v1beta1/Dockerfile",
"--context=dir://" + katibDir,
"--destination=" + registry + "/katib/v1beta1/katib-ui:$(PULL_BASE_SHA)",
]), // build katib-ui
$.parts(namespace, name, overrides).e2e(prow_env, bucket).buildTemplate("build-new-ui", kanikoExecutorImage, [
"/kaniko/executor",
"--dockerfile=" + katibDir + "/cmd/new-ui/v1beta1/Dockerfile",
"--context=dir://" + katibDir,
"--no-push",
"--destination=" + "temp-registry/new-ui",
]), // build new katib-ui
$.parts(namespace, name, overrides).e2e(prow_env, bucket).buildTemplate("build-cert-generator", kanikoExecutorImage, [
"/kaniko/executor",
"--dockerfile=" + katibDir + "/cmd/cert-generator/v1beta1/Dockerfile",
Expand Down