Skip to content

Commit 9514b47

Browse files
committed
Update visualize tool's doc.
1 parent bece673 commit 9514b47

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

docs/en/02-how-to-run/useful_tools.md

+27
Original file line numberDiff line numberDiff line change
@@ -202,3 +202,30 @@ And the output look like this:
202202
| Max | 1.689 | 591.983 |
203203
+--------+------------+---------+
204204
```
205+
206+
## visualize
207+
208+
This tool can be used to visualize model inference results in different backend.
209+
210+
### Usage
211+
212+
```bash
213+
python tools/visualize.py \
214+
--deploy-cfg {DEPLOY_CFG} \
215+
--model-cfg {MODEL_CFG} \
216+
--deploy-path {DEPLOY_PATH} \
217+
--test-img {TEST_IMGS} \
218+
--checkpoint {CHECKPOINTS} \
219+
--save-dir {SAVE_DIR} \
220+
--device {DEVICE}
221+
```
222+
223+
### Description of all arguments
224+
225+
- `deploy-cfg` : The path of the deploy config file in MMDeploy codebase.
226+
- `model-cfg` : The path of model config file in OpenMMLab codebase.
227+
- `deploy-path` : The path of the model to be tested, if the backend contains multiple files, you can use it multiple times.
228+
- `test-img` : The path of the images to be tested, you can use it multiple times.
229+
- `checkpoint` : The path of the checkpoint to be tested, if it is used, the result will be cancated to right part.
230+
- `save-dir` : The path to save the visualization results, if it not specified, it will be set to '.'.
231+
- `device` : The device type. If not specified, it will be set to `cpu`.

docs/zh_cn/02-how-to-run/useful_tools.md

+27
Original file line numberDiff line numberDiff line change
@@ -202,3 +202,30 @@ python tools/profiler.py \
202202
| Max | 1.689 | 591.983 |
203203
+--------+------------+---------+
204204
```
205+
206+
## visualize
207+
208+
这个工具可以用来可视化不同推理引擎的推理结果。
209+
210+
### 用法
211+
212+
```bash
213+
python tools/visualize.py \
214+
--deploy-cfg {DEPLOY_CFG} \
215+
--model-cfg {MODEL_CFG} \
216+
--deploy-path {DEPLOY_PATH} \
217+
--test-img {TEST_IMGS} \
218+
--checkpoint {CHECKPOINTS} \
219+
--save-dir {SAVE_DIR} \
220+
--device {DEVICE}
221+
```
222+
223+
### 参数说明
224+
225+
- `deploy-cfg` : 输入的配置文件路径
226+
- `model-cfg` : 输入的模型配置文件路径
227+
- `deploy-path` : 测试的模型文件路径,如果部分模型含有多个文件,请多次使用该参数
228+
- `test-img` : 测试的图片路径,可以多次使用测试测试多张图片
229+
- `checkpoint` : PyTorch的权重文件,如果使用这个参数,推理的结果会被拼接到图像的右侧
230+
- `save-dir` : 保存可视化结果,如果没有指定则会被设为当前目录
231+
- `device` : 运行的设备类型,如果没有指定则会默认设置为`cpu`

0 commit comments

Comments
 (0)