Skip to content

Commit 39fef8d

Browse files
committed
update v1.3.0
1 parent d6e3d6f commit 39fef8d

File tree

1 file changed

+40
-35
lines changed

1 file changed

+40
-35
lines changed

README.md

Lines changed: 40 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
## 准备工作
2828

29-
下载 [PaddleOCR-json v1.3.0](https://github.com/hiroi-sora/PaddleOCR-json/releases/tag/v1.3.0_alpha.1) 并解压,即可。
29+
下载 [PaddleOCR-json v1.3.0](https://github.com/hiroi-sora/PaddleOCR-json/releases/tag/v1.3.0) 并解压,即可。
3030

3131
### 简单试用
3232

@@ -106,6 +106,42 @@ ocr.flush({ image_path: 'path/to/test/img' })
106106

107107
欢迎补充!请参考 [详细使用指南](docs/详细使用指南.md)
108108

109+
110+
## 常用配置参数说明
111+
112+
| 键名称 | 默认值 | 值说明 |
113+
| ------------- | ------ | ---------------------------------------------------------- |
114+
| config_path | "" | 可以指定不同语言的配置文件路径,识别多国语言。详情见下节。 |
115+
| cls | false | 启用cls方向分类,识别方向不是正朝上的图片。 |
116+
| use_angle_cls | false | 启用方向分类,必须与cls值相同。 |
117+
| enable_mkldnn | true | 启用CPU推理加速,关掉可以减少内存占用,但会降低速度。 |
118+
119+
更多参数详见 [args.cpp](project_files/cpp_infer/src/args.cpp) 。(不支持其中GPU相关、表格识别相关的参数。-)
120+
121+
### 切换识别语言:
122+
123+
`v1.3`版本的Release压缩包中,默认附带了 `简中,繁中,英,日,韩,俄,德,法` 的语言库与配置文件,在 `models` 目录下。
124+
125+
`models` 目录中,每一个 `config_xxx.txt` 是一组语言配置文件(如英文是`congfig_en.txt`)。只需将这个文件的路径传入 `config_path` 参数,即可切换为对应的语言。以 Python API 为例:
126+
127+
```python
128+
enginePath = "D:/Test/PaddleOCR_json.exe" # 引擎路径
129+
argument = {"config_path": "models/congfig_en.txt"} # 指定使用英文库
130+
ocr = GetOcrApi(enginePath, argument)
131+
```
132+
133+
如果 config_path 留空,则 PaddleOCR-json 默认加载并使用简体中文识别库。
134+
135+
#### 删除语言库:
136+
137+
若你希望删除吃灰的语言库文件以便减少软件体积,可以删除 `models` 目录中含有对应语言前缀和 **rec_infer** 后缀的文件夹。比如你希望删除日语`japan`相关的库,只需删除该文件夹:
138+
`japan_PP-OCRv3_rec_infer`
139+
140+
一组语言的rec库大约占用10MB空间(未压缩)。若删除到仅剩1组语言,可以节省约60MB空间。
141+
142+
请不要删除cls_infer及det_infer后缀的文件夹,这是所有语言公用的检测/方向分类库。
143+
144+
109145
## 返回值说明
110146

111147
通过API调用一次OCR,无论成功与否,都会返回一个字典。
@@ -223,40 +259,6 @@ ocr.flush({ image_path: 'path/to/test/img' })
223259
- 本次传入的指令中不含有效任务。
224260

225261

226-
227-
## 常用配置参数说明
228-
229-
| 键名称 | 默认值 | 值说明 |
230-
| ------------- | ------ | ----------------------------------------------------- |
231-
| config_path | "" | 可以指定不同语言的配置文件路径,识别多国语言。 |
232-
| cls | false | 启用cls方向分类,识别方向不是正朝上的图片。 |
233-
| use_angle_cls | false | 启用方向分类,必须与cls值相同。 |
234-
| enable_mkldnn | true | 启用CPU推理加速,关掉可以减少内存占用,但会降低速度。 |
235-
236-
更多参数详见 [args.cpp](project_files/cpp_infer/src/args.cpp) 。(不支持其中GPU相关、表格识别相关的参数。-)
237-
238-
### 切换识别语言:
239-
240-
`v1.3`版本的Release压缩包中,默认附带了 `简中,繁中,英,日,韩,俄,德,法` 的语言库与配置文件,在 `models` 目录下。
241-
242-
`models` 目录中,每一个 `config_xxx.txt` 是一组语言配置文件(如英文是`congfig_en.txt`)。只需将这个文件的路径传入 `config_path` 参数,即可切换为对应的语言。以 Python API 为例:
243-
244-
```python
245-
argument = {'config_path': "models/congfig_en.txt"}
246-
ocr = GetOcrApi(r"D:/Test/PaddleOCR_json.exe", argument)
247-
```
248-
249-
如果 config_path 留空,则 PaddleOCR-json 默认加载并使用简体中文识别库。
250-
251-
#### 删除语言库:
252-
253-
若你希望删除吃灰的语言库文件以便减少软件体积,可以删除 `models` 目录中含有对应语言前缀和 **rec_infer** 后缀的文件夹。比如你希望删除日语`japan`相关的库,只需删除该文件夹:
254-
`japan_PP-OCRv3_rec_infer`
255-
256-
一组语言的rec库大约占用10MB空间(未压缩)。若删除到仅剩1组语言,可以节省约60MB空间。
257-
258-
请不要删除cls_infer及det_infer后缀的文件夹,这是所有语言公用的检测/方向分类库。
259-
260262
### [详细使用指南](docs/详细使用指南.md)
261263

262264
👆当你需要修改或开发新API时欢迎参考。
@@ -283,6 +285,9 @@ ocr = GetOcrApi(r"D:/Test/PaddleOCR_json.exe", argument)
283285

284286
版本号链接可前往对应备份分支。
285287

288+
#### [v1.3.0](https://github.com/hiroi-sora/PaddleOCR-json/tree/backups/1.3.0) `2023.6.19`
289+
- 修复了一些BUG。
290+
286291
#### v1.3.0 Alpha `2023.5.26`
287292
- 重构代码,条理更清晰,易于移植。
288293
- 新功能:Base64传图片。

0 commit comments

Comments
 (0)