Skip to content

Commit f759e68

Browse files
authored
Fix(docs): fix ormb save command in docs (#174)
1 parent d35e13c commit f759e68

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ examples/SavedModel-fashion
3838
Next, we can push the trained model from local to remote image registry.
3939

4040
```bash
41-
# Save the model in local cache first
42-
$ ormb save gaocegege/fashion_model:v1
41+
# Save the model from model directory in local cache first
42+
$ ormb save <model directory> gaocegege/fashion_model:v1
4343
ref: gaocegege/fashion_model:v1
4444
digest: 6b08cd25d01f71a09c1eb852b3a696ee2806abc749628de28a71b507f9eab996
4545
size: 162.1 KiB

README_zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ examples/SavedModel-fashion
3838
接下来,我们可以将在本地训练好的模型推送到远端镜像仓库中:
3939

4040
```bash
41-
# 将模型保存在本地文件系统的缓存中
42-
$ ormb save gaocegege/fashion_model:v1
41+
# 将模型目录中的文件保存在本地文件系统的缓存中
42+
$ ormb save <model directory> gaocegege/fashion_model:v1
4343
ref: gaocegege/fashion_model:v1
4444
digest: 6b08cd25d01f71a09c1eb852b3a696ee2806abc749628de28a71b507f9eab996
4545
size: 162.1 KiB

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Login succeeded
2727

2828
### ormb save
2929

30-
`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:
30+
`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:
3131

3232
```go
3333
type Model struct {
@@ -62,7 +62,7 @@ type CacheRefSummary struct {
6262
Command format:
6363

6464
```bash
65-
ormb save projectName/modelName:modelVersion
65+
ormb save <model directory> projectName/modelName:modelVersion
6666
```
6767

6868
### ormb tag

docs/docs_zh/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ type CacheRefSummary struct {
6262
命令格式:
6363

6464
```bash
65-
ormb save projectName/modelName:modelVersion
65+
ormb save <model directory> projectName/modelName:modelVersion
6666
```
6767

6868
### ormb tag

docs/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Next, we can push the trained model from local to remote image registry.
104104

105105
```bash
106106
# Save the model in local cache first
107-
$ ormb save gaocegege/fashion_model:v1
107+
$ ormb save ./model gaocegege/fashion_model:v1
108108
ref: gaocegege/fashion_model:v1
109109
digest: 6b08cd25d01f71a09c1eb852b3a696ee2806abc749628de28a71b507f9eab996
110110
size: 162.1 KiB

0 commit comments

Comments
 (0)