Skip to content

Commit c24d303

Browse files
authored
Change the default image for the new Katib UI (#1608)
* Change default image for Katib UI * Change title for UI * Fix image name * Use katib-ui image for the new UI * Remove build from CI workflow * Add cache to Kaniko * Add cache repo * Add other cache repo * Remove cache
1 parent a83828c commit c24d303

File tree

6 files changed

+11
-76
lines changed

6 files changed

+11
-76
lines changed

README.md

Lines changed: 7 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -20,42 +20,6 @@ It can tune hyperparameters of applications written in any language of the
2020
users’ choice and natively supports many ML frameworks, such as TensorFlow,
2121
MXNet, PyTorch, XGBoost, and others.
2222

23-
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
24-
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
25-
26-
# Table of Contents
27-
28-
- [Getting Started](#getting-started)
29-
- [Name](#name)
30-
- [Concepts in Katib](#concepts-in-katib)
31-
- [Experiment](#experiment)
32-
- [Suggestion](#suggestion)
33-
- [Trial](#trial)
34-
- [Worker Job](#worker-job)
35-
- [Search Algorithms](#search-algorithms)
36-
- [Hyperparameter Tuning](#hyperparameter-tuning)
37-
- [Neural Architecture Search](#neural-architecture-search)
38-
- [Components in Katib](#components-in-katib)
39-
- [Web UI](#web-ui)
40-
- [New UI](#new-ui)
41-
- [GRPC API documentation](#grpc-api-documentation)
42-
- [Installation](#installation)
43-
- [TF operator](#tf-operator)
44-
- [PyTorch operator](#pytorch-operator)
45-
- [Katib](#katib)
46-
- [Running examples](#running-examples)
47-
- [Katib SDK](#katib-sdk)
48-
- [Cleanups](#cleanups)
49-
- [Quick Start](#quick-start)
50-
- [Community](#community)
51-
- [Blog posts](#blog-posts)
52-
- [Contributing](#contributing)
53-
- [Citation](#citation)
54-
55-
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
56-
57-
Created by [doctoc](https://github.com/thlorenz/doctoc).
58-
5923
## Getting Started
6024

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

171135
Katib provides a Web UI.
172-
You can visualize general trend of Hyper parameter space and
173-
each training history. You can use
174-
[random-example](https://github.com/kubeflow/katib/blob/master/examples/v1beta1/random-example.yaml)
175-
or
176-
[other examples](https://github.com/kubeflow/katib/blob/master/examples/v1beta1)
177-
to generate a similar UI. Follow the
178-
[Kubeflow documentation](https://www.kubeflow.org/docs/components/katib/hyperparameter/#katib-ui)
179-
to access the Katib UI.
180-
![katibui](./docs/images/katib-ui.png)
181-
182-
### New UI
183-
184136
During 1.3 we've worked on a new iteration of the UI, which is rewritten in
185137
Angular and is utilizing the common code of the other Kubeflow [dashboards](https://github.com/kubeflow/kubeflow/tree/master/components/crud-web-apps).
186-
While this UI is not yet on par with the current default one, we are actively
187-
working to get it up to speed and provide all the existing functionalities.
188138

189139
The users are currently able to list, delete and create Experiments in their
190140
cluster via this new UI as well as inspect the owned Trials. One important
191-
missing functionalities are the ability to edit the TrialTemplate ConfigMaps.
141+
missing functionalities are the ability to edit the Trial templates ConfigMaps
142+
and view Neural Architecture Search models. Check [this Project](https://github.com/kubeflow/katib/projects/1)
143+
to monitor the current progress.
192144

193-
While this UI is not ready to replace the current one we would like to
194-
encourage users to also give it a try and provide us with feedback. To try it
195-
out the user has to update the Katib UI image `newName` with the new registry
196-
`docker.io/kubeflowkatib/katib-new-ui` in the [Kustomize](https://github.com/kubeflow/katib/blob/54854c1bb/manifests/v1beta1/installs/katib-standalone/kustomization.yaml#L29)
197-
manifests.
145+
![katibui](./docs/images/katib-ui.png)
198146

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

201151
## GRPC API documentation
202152

docs/images/katib-new-ui.png

-338 KB
Binary file not shown.

docs/images/katib-ui.png

-847 KB
Loading

scripts/v1beta1/build.sh

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,9 @@ docker build -t ${REGISTRY}/katib-controller:${TAG} -f ${CMD_PREFIX}/katib-contr
4646
echo -e "\nBuilding Katib DB manager image...\n"
4747
docker build -t ${REGISTRY}/katib-db-manager:${TAG} -f ${CMD_PREFIX}/db-manager/${VERSION}/Dockerfile .
4848

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

5553
echo -e "\nBuilding Katib cert generator image...\n"
5654
docker build -t ${REGISTRY}/cert-generator:${TAG} -f ${CMD_PREFIX}/cert-generator/${VERSION}/Dockerfile .

scripts/v1beta1/push.sh

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,6 @@ docker push ${REGISTRY}/katib-db-manager:${TAG}
4444
echo -e "\nPushing Katib UI image...\n"
4545
docker push ${REGISTRY}/katib-ui:${TAG}
4646

47-
echo -e "\nPushing Katib new UI image...\n"
48-
docker push ${REGISTRY}/katib-new-ui:${TAG}
49-
5047
echo -e "\nPushing Katib cert generator image...\n"
5148
docker push ${REGISTRY}/cert-generator:${TAG}
5249

test/workflows/components/workflows-v1beta1.libsonnet

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -233,10 +233,6 @@
233233
name: "build-ui",
234234
template: "build-ui",
235235
},
236-
{
237-
name: "build-new-ui",
238-
template: "build-new-ui",
239-
},
240236
{
241237
name: "build-cert-generator",
242238
template: "build-cert-generator",
@@ -425,17 +421,11 @@
425421
]), // build katib-db-manager
426422
$.parts(namespace, name, overrides).e2e(prow_env, bucket).buildTemplate("build-ui", kanikoExecutorImage, [
427423
"/kaniko/executor",
428-
"--dockerfile=" + katibDir + "/cmd/ui/v1beta1/Dockerfile",
424+
// TODO (andreyvelich): Switch to katibDir + "/cmd/ui/v1beta1/Dockerfile" once old UI is deprecated.
425+
"--dockerfile=" + katibDir + "/cmd/new-ui/v1beta1/Dockerfile",
429426
"--context=dir://" + katibDir,
430427
"--destination=" + registry + "/katib/v1beta1/katib-ui:$(PULL_BASE_SHA)",
431428
]), // build katib-ui
432-
$.parts(namespace, name, overrides).e2e(prow_env, bucket).buildTemplate("build-new-ui", kanikoExecutorImage, [
433-
"/kaniko/executor",
434-
"--dockerfile=" + katibDir + "/cmd/new-ui/v1beta1/Dockerfile",
435-
"--context=dir://" + katibDir,
436-
"--no-push",
437-
"--destination=" + "temp-registry/new-ui",
438-
]), // build new katib-ui
439429
$.parts(namespace, name, overrides).e2e(prow_env, bucket).buildTemplate("build-cert-generator", kanikoExecutorImage, [
440430
"/kaniko/executor",
441431
"--dockerfile=" + katibDir + "/cmd/cert-generator/v1beta1/Dockerfile",

0 commit comments

Comments
 (0)