Skip to content

Commit cfbeb96

Browse files
Add the Prerequisite part for elasticdl_client user story. (#2097)
* Add the Prerequisite part for elasticdl client user story. * Update client_tool.md * Update client_tool.md Co-authored-by: Yi Wang <yi.wang.2005@gmail.com>
1 parent 96227cc commit cfbeb96

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/designs/client_tool.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,29 @@ this command-line client tool.
1717

1818
## User Story
1919

20+
1. Prerequisite
21+
22+
- Install [Docker CE >= 18.x](https://docs.docker.com/docker-for-mac/install/)
23+
for building the Docker images of the distributed ElasticDL jobs.
24+
- Install Python >= 3.6.
25+
- Install ElasticDL command-line tool by `pip install elasticdl_client`.
26+
2027
1. Users develop model and the directory structure of model definition files
2128
is as follows:
2229

2330
```TEXT
24-
a_directory
25-
- wide_and_deep.py
26-
requirements.txt
31+
model_zoo_root
32+
a_directory
33+
- wide_and_deep.py
34+
requirements.txt
2735
```
2836
2937
1. Generate a Dockerfile.
3038
3139
Input the command:
3240
3341
```bash
34-
cd ${model_root_path}
42+
cd model_zoo_root
3543
elasticdl zoo init
3644
[--base_image=customized_base_image_name]
3745
[--cluster_spec=prem_cluster_spec]

0 commit comments

Comments
 (0)