Skip to content

Commit 9a86d1c

Browse files
Update client_tool design doc. (#2091)
* Update client_tool instruction. * Do some rephrase * Update the sample dockerfile content * Update the elasticdl zoo build command usage. * Update according to the comments.
1 parent ef09550 commit 9a86d1c

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

docs/designs/client_tool.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,38 @@ this command-line client tool.
3232
3333
```bash
3434
cd ${model_root_path}
35-
elasticdl zoo init [base_image_name]
35+
elasticdl zoo init
36+
[--base_image=customized_base_image_name]
37+
[--cluster_spec=prem_cluster_spec]
38+
[--extra_pypi_index=your_pypi_index]
3639
```
3740
38-
`base_image_name` is optional and the default value is `python`.
41+
The options inside `[]` are optional. The default value of `base_image`
42+
is `python:3.6`.
3943
The generated Dockerfile example is:
4044
4145
```Dockerfile
42-
FROM python
46+
FROM python:3.6
47+
48+
RUN pip install elasticdl_preprocessing
49+
RUN pip install elasticdl
50+
4351
COPY . /model_zoo
4452
RUN pip install -r /model_zoo/requirements.txt
45-
RUN pip install elasticdl
53+
...
4654
```
4755
4856
Users can make additional updates on the Dockerfile if necessary.
4957
5058
1. Build the Docker image for an ElasticDL job.
5159
5260
```bash
53-
elasticdl zoo build --image=a_docker_registry/bright/elasticdl-wnd:1.0 .
61+
elasticdl zoo build
62+
--image=a_docker_registry/bright/elasticdl-wnd:1.0
63+
[--docker_base_url=docke_base_url]
64+
[--docker_tlscert=docker_tlscert]
65+
[--docker_tlskey=docker_tlskey]
66+
.
5467
```
5568
5669
1. Push the Docker image to a remote registry.
@@ -59,11 +72,15 @@ this command-line client tool.
5972
elasticdl zoo push a_docker_registry/bright/elasticdl-wnd:1.0
6073
```
6174
75+
If you want to execute the job locally in Minikube, the `push` step
76+
is not necessary.
77+
6278
1. Submit a model training/prediction/evaluation job.
6379
6480
```bash
6581
elasticdl train \
6682
--image=a_docker_registry/bright/elasticdl-wnd:1.0 \
83+
--model_zoo=model_zoo
6784
--model_def=a_directory.wide_and_deep.custom_model \
6885
--training_data=/data/mnist/train \
6986
--validation_data=/data/mnist/test \

0 commit comments

Comments
 (0)