Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hiroi-sora committed Jul 9, 2024
1 parent 8a9db2a commit 737fa0f
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,7 @@

下载可执行文件包:

- Windows: [Release](https://github.com/hiroi-sora/PaddleOCR-json/releases/latest)
- Linux: [Gavin1937/Release](https://github.com/Gavin1937/PaddleOCR-json/releases/tag/v1.4.0-alpha.3)
- https://github.com/hiroi-sora/PaddleOCR-json/releases

### 简单试用

Expand Down Expand Up @@ -146,16 +145,17 @@ ocr.flush({ image_path: 'path/to/test/img' })

## 常用配置参数说明

| 键名称 | 默认值 | 值说明 |
| -------------- | ------ | ----------------------------------------------------------------------------------- |
| config_path | "" | 可以指定不同语言的配置文件路径,识别多国语言。[详情见下节](#语言库与切换识别语言)|
| models_path | "" | 可以指定语言库 `models` 文件夹的路径。[详情见下节](#语言库与切换识别语言)|
| cls | false | 启用cls方向分类,识别方向不是正朝上的图片。 |
| use_angle_cls | false | 启用方向分类,必须与cls值相同。 |
| enable_mkldnn | true | 启用CPU推理加速,关掉可以减少内存占用,但会降低速度。 |
| limit_side_len | 960 | 对图像边长进行限制,降低分辨率,加快速度。 |
| | | 如果对大图/长图的识别率低,可增大 limit_side_len 的值。 |
| | | 建议为 32 & 48 的公倍数,如 960, 2880, 4320 |
| 键名称 | 默认值 | 值说明 |
| -------------- | ------ | ---------------------------------------------------------------------------------------- |
| config_path | "" | 可以指定不同语言的配置文件路径,识别多国语言。[详情见下节](#语言库与切换识别语言)|
| models_path | "" | 可以指定语言库 `models` 文件夹的路径。[详情见下节](#语言库与切换识别语言)|
| det | true | 启用det目标识别。如果你的图片中只含一行文本,且没有空白区域,那么可以关闭det以加快速度。 |
| cls | false | 启用cls方向分类,识别方向不是正朝上的图片。 |
| use_angle_cls | false | 启用方向分类,必须与cls同时设置。 |
| enable_mkldnn | true | 启用CPU推理加速,关掉可以减少内存占用,但会降低速度。 |
| limit_side_len | 960 | 对图像边长进行限制,降低分辨率,加快速度。 |
| | | 如果对大图/长图的识别率低,可增大 limit_side_len 的值。 |
| | | 建议为 32 & 48 的公倍数,如 960, 2880, 4320 |

更多参数详见 [args.cpp](/cpp/src/args.cpp) 。(不支持其中GPU相关、表格识别相关的参数。-)

Expand Down Expand Up @@ -221,10 +221,13 @@ ocr = GetOcrApi(enginePath, argument)

##### `100` 识别到文字

- data内容为数组。数组每一项为字典,含三个元素
- data内容为数组。数组每一项为字典,含三个固定元素
- `text` :文本内容,字符串。
- `box` :文本包围盒,长度为4的数组,分别为左上角、右上角、右下角、左下角的`[x,y]`。整数。
- `score` :识别置信度,浮点数。
- `score` :识别置信度,0~1的浮点数。越接近**1**表示文字内容越可信。
- (v1.4.0新增)如果启用了 `cls``use_angle_cls` ,那么会多出两个元素:
- `cls_label` :方向分类标签,整数。**0** 表示文字方向是顺时针 0°或90°,**1** 表示 180°或270° 。
- `cls_score` :方向分类置信度,0~1的浮点数。越接近**1**表示方向分类越可信。
- 例:
```
{'code':100,'data':[{'box':[[13,5],[161,5],[161,27],[13,27]],'score':0.9996442794799805,'text':'飞舞的因果交流'}]}
Expand Down

0 comments on commit 737fa0f

Please sign in to comment.