Skip to content

Commit 4596118

Browse files
SWHLSWHL
authored
docs: update model_list
1 parent d70d0be commit 4596118

File tree

1 file changed

+71
-13
lines changed

1 file changed

+71
-13
lines changed

‎docs/model_list.md‎

Lines changed: 71 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,69 @@ hide:
1212

1313
所有模型目前托管在[魔搭社区](https://www.modelscope.cn/models/RapidAI/RapidOCR/files)上。
1414

15-
`rapidocr` v3 版本已经集成了托管的所有模型，通过下面参数指定可以自动下载。对应的配置文件：[default_model.yaml](https://github.com/RapidAI/RapidOCR/blob/main/python/rapidocr/default_models.yaml)
15+
`rapidocr` v3 版本已经集成了托管的所有模型，通过下面参数指定可以自动下载。对应的配置文件：[default_model.yaml](https://github.com/RapidAI/RapidOCR/blob/main/python/rapidocr/default_models.yaml)。当然，小伙伴们也可以自己去上述链接下载。
1616

17-
当然，小伙伴们也可以自己去上述链接自己下载。
17+
## 默认配置
18+
19+
直接通过pip安装rapidocr，使用时，可以不用指定任何参数，直接使用。因为指定了默认配置参数，下面写法：
20+
21+
```python linenums="1"
22+
from rapidocr import RapidOCR
23+
24+
engine = RapidOCR()
25+
26+
img_url = "https://github.com/RapidAI/RapidOCR/blob/main/python/tests/test_files/ch_en_num.jpg?raw=true"
27+
result = engine(img_url)
28+
print(result)
29+
30+
result.vis("vis_result.jpg")
31+
```
32+
33+
等价于下面：
34+
35+
```python linenums="1"
36+
from rapidocr import EngineType, LangDet, LangRec, ModelType, OCRVersion, RapidOCR
37+
38+
engine = RapidOCR(
39+
params={
40+
"Det.engine_type": EngineType.ONNXRUNTIME,
41+
"Det.lang_type": LangDet.CH,
42+
"Det.model_type": ModelType.MOBILE,
43+
"Det.ocr_version": OCRVersion.PPOCRV4,
44+
"Rec.engine_type": EngineType.PADDLE,
45+
"Rec.lang_type": LangRec.CH,
46+
"Rec.model_type": ModelType.MOBILE,
47+
"Rec.ocr_version": OCRVersion.PPOCRV5,
48+
"Cls.engine_type": EngineType.ONNXRUNTIME,
49+
"Cls.lang_type": LangDet.CH,
50+
"Cls.model_type": ModelType.MOBILE,
51+
"Cls.ocr_version": OCRVersion.PPOCRV4,
52+
}
53+
)
54+
55+
img_url = "https://github.com/RapidAI/RapidOCR/blob/main/python/tests/test_files/ch_en_num.jpg?raw=true"
56+
result = engine(img_url)
57+
print(result)
58+
59+
result.vis("vis_result.jpg")
60+
```
1861

1962
## 配置文件字段对应
2063

2164
### 文本检测模型
2265

66+
#### PP-OCRv5
67+
68+
|语种类型|engine_type| lang_type|model_type|ocr_version|
69+
|:---|:---|:---|:---|:---|
70+
|多语种[^7]|`onnxruntime` <br/> `openvino` <br/> `paddle`<br>`torch`(`rapidocr>=3.3.0`)|`ch`|`mobile`<br/> `server`|`PP-OCRv5`|
71+
72+
#### PP-OCRv4
73+
2374
|语种类型|engine_type| lang_type|model_type|ocr_version|
2475
|:---|:---|:---|:---|:---|
25-
|简体中文、中文拼音、繁体中文、英文、日文|`onnxruntime` <br/> `openvino` <br/> `paddle`<br>`torch`(`rapidocr>=3.3.0`)|`ch`|`mobile`<br/> `server`|`PP-OCRv5`|
2676
|中英|`onnxruntime` <br/> `openvino` <br/> `paddle` <br/> `torch`|`ch`|`mobile`<br/> `server`|`PP-OCRv4`|
27-
|英语和拉丁语|`onnxruntime` <br/> `openvino` <br/> `paddle` <br/> `torch`|`en`|`mobile`<br/> `server`|`PP-OCRv4`<br/>|
77+
|英语、拉丁语|`onnxruntime` <br/> `openvino` <br/> `paddle` <br/> `torch`|`en`|`mobile`<br/> `server`|`PP-OCRv4`<br/>|
2878
|多语种|`onnxruntime` <br/> `openvino` <br/> `paddle` <br/> `torch`|`multi`|`mobile`<br>❎`server` |`PP-OCRv4`<br/>|
2979

3080
对应使用方法：
@@ -52,23 +102,29 @@ engine = RapidOCR(
52102

53103
`lang_type`字段对应Det模块下的`LangRec`
54104

105+
#### PP-OCRv5
106+
55107
| 语种类型 | engine_type | lang_type | model_type | ocr_version |
56108
|----------------|---------------------------|-------------------|-----------------|-------------------|
57-
| 🆕 俄罗斯文[^3] | `rapidocr>=3.5.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `cyrillic` | `mobile`<br>❎`server` | `PP-OCRv5` |
58-
| 🆕 阿拉伯文[^4] | `rapidocr>=3.5.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `arabic` | `mobile`<br>❎`server` | `PP-OCRv5` |
59-
| 🆕 梵文等[^5] | `rapidocr>=3.5.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `devanagari` | `mobile`<br>❎`server` | `PP-OCRv5` |
60-
| 🆕 泰米尔文、英文 | `rapidocr>=3.5.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `ta` | `mobile`<br>❎`server` | `PP-OCRv5` |
61-
| 🆕 泰卢固文、英文 | `rapidocr>=3.5.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `te` | `mobile`<br>❎`server` | `PP-OCRv5` |
109+
| 🚀 俄罗斯文[^3] | `rapidocr>=3.5.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `cyrillic` | `mobile`<br>❎`server` | `PP-OCRv5` |
110+
| 🚀 阿拉伯文[^4] | `rapidocr>=3.5.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `arabic` | `mobile`<br>❎`server` | `PP-OCRv5` |
111+
| 🚀 梵文等[^5] | `rapidocr>=3.5.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `devanagari` | `mobile`<br>❎`server` | `PP-OCRv5` |
112+
| 🚀 泰米尔文、英文 | `rapidocr>=3.5.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `ta` | `mobile`<br>❎`server` | `PP-OCRv5` |
113+
| 🚀 泰卢固文、英文 | `rapidocr>=3.5.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `te` | `mobile`<br>❎`server` | `PP-OCRv5` |
62114
||||||
63115
| 英文 | `rapidocr>=3.4.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `en` | `mobile`<br>❎`server` | `PP-OCRv5` |
64116
| 泰文、英文 | `rapidocr>=3.4.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `th` | `mobile`<br>❎`server` | `PP-OCRv5` |
65117
| 希腊文、英文 | `rapidocr>=3.4.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `el` | `mobile`<br>❎`server` | `PP-OCRv5` |
66118
| 拉丁语种混合[^1] | `rapidocr>=3.3.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `latin` | `mobile`<br>❎`server` | `PP-OCRv5` |
67-
| 俄罗斯文、白俄罗斯文、乌克兰文 | `rapidocr>=3.3.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch`| `eslav` | `mobile`<br>`server` | `PP-OCRv5` |
119+
| 俄罗斯文[^6] | `rapidocr>=3.3.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch`| `eslav` | `mobile`<br>`server` | `PP-OCRv5` |
68120
| 中英日混合[^2] | `onnxruntime`<br>`openvino`<br>`paddle`<br>`torch`(`rapidocr>=3.3.0`) | `ch` | `mobile`<br>`server` | `PP-OCRv5` |
69-
| 韩文v5 | `rapidocr>=3.3.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `korean` | `mobile`<br>❎`server` | `PP-OCRv5` |
70-
||||||
71-
| 韩文v4 | `onnxruntime`<br>`openvino`<br>`paddle`<br>`torch` | `korean` | `mobile`<br>❎`server` | `PP-OCRv4` |
121+
| 韩文 | `rapidocr>=3.3.0支持`<br/><br/>`onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `korean` | `mobile`<br>❎`server` | `PP-OCRv5` |
122+
123+
#### PP-OCRv4
124+
125+
| 语种类型 | engine_type | lang_type | model_type | ocr_version |
126+
|----------------|---------------------------|-------------------|-----------------|-------------------|
127+
| 韩文 | `onnxruntime`<br>`openvino`<br>`paddle`<br>`torch` | `korean` | `mobile`<br>❎`server` | `PP-OCRv4` |
72128
| 中文文档 | `onnxruntime`<br>`openvino`<br>`paddle`<br>❎`torch` | `ch_doc` | ❎`mobile`<br>`server` | `PP-OCRv4` |
73129
| 中文 | `onnxruntime`<br>`openvino`<br>`paddle`<br>`torch` | `ch` | `mobile`<br>`server` | `PP-OCRv4` |
74130
| 中文繁体 | `onnxruntime`<br>`openvino`<br>`paddle`<br>`torch` | `chinese_cht` | `mobile`<br>`server` | `PP-OCRv4` |
@@ -109,3 +165,5 @@ result.vis("vis_result.jpg")
109165
[^3]: 俄罗斯文、白俄罗斯文、乌克兰文、塞尔维亚文（cyrillic）、保加利亚文、蒙古文、阿布哈兹文、阿迪赫文、卡巴尔达文、阿瓦尔文、达尔格瓦文、印古什文、车臣文、拉克文、列兹金文、塔巴萨兰文、哈萨克文、吉尔吉斯文、塔吉克文、马其顿文、鞑靼文、楚瓦什文、巴什基尔文、马里文、莫尔多瓦文、乌德穆尔特文、科米文、奥塞梯文、布里亚特文、卡尔梅克文、图瓦文、萨哈文、卡拉卡尔帕克文、英文
110166
[^4]: 阿拉伯文、波斯文、维吾尔文、乌尔都文、普什图文、库尔德文、信德文、俾路支文、英文
111167
[^5]: 印地文，马拉地文，尼泊尔文，比哈尔文，迈蒂利文，古英文，博杰普尔文，马加希文，萨达里文，尼瓦尔文，孔卡尼文，梵文，哈里亚纳文、英文
168+
[^6]: 俄罗斯文、白俄罗斯文、乌克兰文
169+
[^7]: 简体中文、中文拼音、繁体中文、英文、日文

0 commit comments

Comments
 (0)