Skip to content

Commit 8552d35

Browse files
authored
[Docs]: update docs and argument descriptions (#196)
* bump version to v0.4.0 * update docs and argument descriptions * revert version change
1 parent 3ca452f commit 8552d35

File tree

4 files changed

+7
-3
lines changed

4 files changed

+7
-3
lines changed

docs/en/supported_models.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ The table below lists the models that are guaranteed to be exportable to other b
4040
| DBNet | MMOCR | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmocr/tree/main/configs/textdet/dbnet) |
4141
| CRNN | MMOCR | Y | Y | Y | Y | N | [config](https://github.com/open-mmlab/mmocr/tree/main/configs/textrecog/crnn) |
4242
| SAR | MMOCR | Y | N | N | N | N | [config](https://github.com/open-mmlab/mmocr/tree/main/configs/textrecog/sar) |
43+
| HRNet | MMPose | Y | Y | Y | N | Y | [config](https://mmpose.readthedocs.io/en/latest/papers/backbones.html#hrnet-cvpr-2019) |
44+
| MSPN | MMPose | Y | Y | Y | N | Y | [config](https://mmpose.readthedocs.io/en/latest/papers/backbones.html#mspn-arxiv-2019) |
45+
| LiteHRNet | MMPose | Y | Y | N | N | Y | [config](https://mmpose.readthedocs.io/en/latest/papers/backbones.html#litehrnet-cvpr-2021) |
4346

4447
### Note
4548

docs/en/tutorials/how_to_convert_model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ python ./tools/deploy.py \
5454
- `img` : The path of image file that used to convert model.
5555
- `--test-img` : The path of image file that used to test model. If not specified, it will be set to `None`.
5656
- `--work-dir` : The path of work directory that used to save logs and models.
57-
- `--calib-dataset-cfg` : Config used for calibration. If not specified, it will be set to `None`.
57+
- `--calib-dataset-cfg` : Only valid in int8 mode. Config used for calibration. If not specified, it will be set to `None` and use "val" dataset in model config for calibration.
5858
- `--device` : The device used for conversion. If not specified, it will be set to `cpu`.
5959
- `--log-level` : To set log level which in `'CRITICAL', 'FATAL', 'ERROR', 'WARN', 'WARNING', 'INFO', 'DEBUG', 'NOTSET'`. If not specified, it will be set to `INFO`.
6060
- `--show` : Whether to show detection outputs.

docs/zh_cn/tutorials/how_to_convert_model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ python ./tools/deploy.py \
5555
- `img` : 用于模型转换时使用的图像文件路径。
5656
- `--test-img` : 用于测试模型的图像文件路径。默认设置成`None`
5757
- `--work-dir` : 工作目录,用来保存日志和模型文件。
58-
- `--calib-dataset-cfg` : 用于校准的配置文件。默认是`None`
58+
- `--calib-dataset-cfg` : 此参数只有int8模式下生效,用于校准数据集配置文件。若在int8模式下未传入参数,则会自动使用模型配置文件中的'val'数据集进行校准
5959
- `--device` : 用于模型转换的设备。 默认是`cpu`
6060
- `--log-level` : 设置日记的等级,选项包括`'CRITICAL', 'FATAL', 'ERROR', 'WARN', 'WARNING', 'INFO', 'DEBUG', 'NOTSET'`。 默认是`INFO`
6161
- `--show` : 是否显示检测的结果。

tools/deploy.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ def parse_args():
2929
parser.add_argument('--work-dir', help='the dir to save logs and models')
3030
parser.add_argument(
3131
'--calib-dataset-cfg',
32-
help='dataset config path used to calibrate.',
32+
help='dataset config path used to calibrate in int8 mode. If not \
33+
specified,it will use "val" dataset in model config instead.',
3334
default=None)
3435
parser.add_argument(
3536
'--device', help='device used for conversion', default='cpu')

0 commit comments

Comments
 (0)