docs: Update katib (kubeflow#36)

Signed-off-by: Ce Gao <[email protected]>
arrikto · Apr 12, 2018 · 9bfd388 · 9bfd388
1 parent e382783
commit 9bfd388
Showing 1 changed file with 7 additions and 10 deletions.
diff --git a/docs/getting-start.md b/docs/getting-start.md
@@ -11,13 +11,10 @@
 First, Copy CLI tool.
 
 ```bash
-docker pull katib/katib-cli
-docker run --name katib-cli -itd katib/katib-cli sh
-docker cp katib-cli:/app/katib-cli bin/katib-cli
-docker rm -f katib-cli
+$ curl -Lo katib-cli https://github.com/kubeflow/hp-tuning/releases/download/v0.1.0-alpha/katib-cli-linux-amd64 && chmod +x katib-cli && sudo mv katib-cli /usr/local/bin/
 ```
 
-The cli tool will be put `bin` directory.
+The cli tool will be put `/usr/local/bin/` directory.
 
 Let's deploy Katib on your cluster.
 Kubernetes manifests are in `manifests` directory.
@@ -43,7 +40,7 @@ vizier-core-864dd6fdd4-r55qv                1/1       Running   0          11m
 vizier-db-7b6f8c59bc-mjhh4                  1/1       Running   0          11m       10.36.0.4   node1
 vizier-suggestion-random-5895dc79b4-pbqkc   1/1       Running   0          11m       10.47.0.5   gpu-node3
 
-$ ./katib-cli -s gpu-node2:30678 Getstudies
+$ katib-cli -s gpu-node2:30678 Getstudies
 2018/04/03 05:14:49 connecting gpu-node2:30678
 StudyID                 Name    Owner   RunningTrial    CompletedTrial
 ```
@@ -53,7 +50,7 @@ StudyID                 Name    Owner   RunningTrial    CompletedTrial
 Try Createstudy. Study will be created and start hyperparameter search.
 
 ```bash
-$ ./katib-cli -s gpu-node2:30678 -f ../conf/random.yml Createstudy
+$ katib-cli -s gpu-node2:30678 -f ../conf/random.yml Createstudy
 2018/04/03 05:16:37 connecting gpu-node2:30678
 2018/04/03 05:16:37 study conf{cifer10 root MAXIMIZE 0 configs:<name:"--lr" parameter_type:DOUBLE feasible:<max:"0.07" min:"0.03" > > configs:<name:"--lr-factor" parameter_type:DOUBLE feasible:<max:"0.2" min:"0.05" > > configs:<name:"--max-random-h" parameter_type:INT feasible:<max:"46" min:"26" > > configs:<name:"--max-random-l" parameter_type:INT feasible:<max:"75" min:"25" > > configs:<name:"--num-epochs" parameter_type:INT feasible:<max:"3" min:"3" > >  [] random median  [name:"SuggestionNum" value:"2"  name:"MaxParallel" value:"2" ] [] Validation-accuracy [accuracy] mxnet/python:gpu [python /mxnet/example/image-classification/train_cifar10.py --batch-size=512 --gpus=0,1] 2 default-scheduler <nil> }
 2018/04/03 05:16:37 req Createstudy
@@ -63,7 +60,7 @@ $ ./katib-cli -s gpu-node2:30678 -f ../conf/random.yml Createstudy
 You can check the job is running with `kubectl` command.
 
 ```bash
-$ ./katib-cli -s gpu-node2:30678 Getstudies
+$ katib-cli -s gpu-node2:30678 Getstudies
 2018/04/03 05:19:49 connecting gpu-node2:30678
 StudyID                 Name    Owner   RunningTrial    CompletedTrial
 fef3711aa343fae6        cifer10 root    2       0
@@ -77,7 +74,7 @@ wbe8aabd6ad4f50e-worker-0   1         0            1m
 Check the status of jobs with `katib-cli` command.
 
 ```bash
-$ ./katib-cli -s gpu-node2:30678 Getstudies
+$ katib-cli -s gpu-node2:30678 Getstudies
 2018/04/03 05:26:20 connecting gpu-node2:30678
 StudyID                 Name    Owner   RunningTrial    CompletedTrial
 fef3711aa343fae6        cifer10 root    1       1
@@ -218,7 +215,7 @@ parameterconfigs:
 ```
 
 ```bash
-$ ./katib-cli -s gpu-node2:30678 -f ../conf/random-pv.yml Createstudy
+$ katib-cli -s gpu-node2:30678 -f ../conf/random-pv.yml Createstudy
 2018/04/03 05:49:47 connecting gpu-node2:30678
 2018/04/03 05:49:47 study conf{cifer10-pv-test root MAXIMIZE 0 configs:<name:"--lr" parameter_type:DOUBLE feasible:<max:"0.07" min:"0.03" > > configs:<name:"--lr-factor" parameter_type:DOUBLE feasible:<max:"0.2" min:"0.05" > > configs:<name:"--max-random-h" parameter_type:INT feasible:<max:"46" min:"26" > > configs:<name:"--max-random-l" parameter_type:INT feasible:<max:"75" min:"25" > > configs:<name:"--num-epochs" parameter_type:INT feasible:<max:"3" min:"3" > >  [] random median  [name:"SuggestionNum" value:"2"  name:"MaxParallel" value:"2" ] [] Validation-accuracy [accuracy] mxnet/python:gpu [python /mxnet/example/image-classification/train_cifar10.py --batch-size=512 --gpus=0,1] 2 default-scheduler pvc:"nfs" path:"/nfs-mnt"  }
 2018/04/03 05:49:47 req Createstudy