Fix(docs): fix ormb save command in docs (#174)

kleveross · Jan 26, 2021 · f759e68 · f759e68
1 parent d35e13c
commit f759e68
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -38,8 +38,8 @@ examples/SavedModel-fashion
 Next, we can push the trained model from local to remote image registry.
 
 ```bash
-# Save the model in local cache first
-$ ormb save gaocegege/fashion_model:v1
+# Save the model from model directory in local cache first
+$ ormb save <model directory> gaocegege/fashion_model:v1
 ref:       gaocegege/fashion_model:v1
 digest:    6b08cd25d01f71a09c1eb852b3a696ee2806abc749628de28a71b507f9eab996
 size:      162.1 KiB

diff --git a/README_zh.md b/README_zh.md
@@ -38,8 +38,8 @@ examples/SavedModel-fashion
 接下来，我们可以将在本地训练好的模型推送到远端镜像仓库中：
 
 ```bash
-# 将模型保存在本地文件系统的缓存中
-$ ormb save gaocegege/fashion_model:v1
+# 将模型目录中的文件保存在本地文件系统的缓存中
+$ ormb save <model directory> gaocegege/fashion_model:v1
 ref:       gaocegege/fashion_model:v1
 digest:    6b08cd25d01f71a09c1eb852b3a696ee2806abc749628de28a71b507f9eab996
 size:      162.1 KiB

diff --git a/docs/README.md b/docs/README.md
@@ -27,7 +27,7 @@ Login succeeded
 
 ### ormb save
 
-`ormb save` will store the model files in the current directory into the local cache and simultaneously parses `ormbfile.yaml` to get the model metadata. The model will be converted to the following format:
+`ormb save` will store the model files in the model directory into the local cache and simultaneously parses `ormbfile.yaml` to get the model metadata. The model will be converted to the following format:
 
 ```go
 type Model struct {
@@ -62,7 +62,7 @@ type CacheRefSummary struct {
 Command format:
 
 ```bash
-ormb save projectName/modelName:modelVersion
+ormb save <model directory> projectName/modelName:modelVersion
 ```
 
 ### ormb tag

diff --git a/docs/docs_zh/README.md b/docs/docs_zh/README.md
@@ -62,7 +62,7 @@ type CacheRefSummary struct {
 命令格式：
 
 ```bash
-ormb save projectName/modelName:modelVersion
+ormb save <model directory> projectName/modelName:modelVersion
 ```
 
 ### ormb tag

diff --git a/docs/introduction.md b/docs/introduction.md
@@ -104,7 +104,7 @@ Next, we can push the trained model from local to remote image registry.
 
 ```bash
 # Save the model in local cache first
-$ ormb save gaocegege/fashion_model:v1
+$ ormb save ./model gaocegege/fashion_model:v1
 ref:       gaocegege/fashion_model:v1
 digest:    6b08cd25d01f71a09c1eb852b3a696ee2806abc749628de28a71b507f9eab996
 size:      162.1 KiB