Skip to content

Commit

Permalink
update v1.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
hiroi-sora committed Jun 19, 2023
1 parent d6e3d6f commit 39fef8d
Showing 1 changed file with 40 additions and 35 deletions.
75 changes: 40 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

## 准备工作

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

### 简单试用

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

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


## 常用配置参数说明

| 键名称 | 默认值 | 值说明 |
| ------------- | ------ | ---------------------------------------------------------- |
| config_path | "" | 可以指定不同语言的配置文件路径,识别多国语言。详情见下节。 |
| cls | false | 启用cls方向分类,识别方向不是正朝上的图片。 |
| use_angle_cls | false | 启用方向分类,必须与cls值相同。 |
| enable_mkldnn | true | 启用CPU推理加速,关掉可以减少内存占用,但会降低速度。 |

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

### 切换识别语言:

`v1.3`版本的Release压缩包中,默认附带了 `简中,繁中,英,日,韩,俄,德,法` 的语言库与配置文件,在 `models` 目录下。

`models` 目录中,每一个 `config_xxx.txt` 是一组语言配置文件(如英文是`congfig_en.txt`)。只需将这个文件的路径传入 `config_path` 参数,即可切换为对应的语言。以 Python API 为例:

```python
enginePath = "D:/Test/PaddleOCR_json.exe" # 引擎路径
argument = {"config_path": "models/congfig_en.txt"} # 指定使用英文库
ocr = GetOcrApi(enginePath, argument)
```

如果 config_path 留空,则 PaddleOCR-json 默认加载并使用简体中文识别库。

#### 删除语言库:

若你希望删除吃灰的语言库文件以便减少软件体积,可以删除 `models` 目录中含有对应语言前缀和 **rec_infer** 后缀的文件夹。比如你希望删除日语`japan`相关的库,只需删除该文件夹:
`japan_PP-OCRv3_rec_infer`

一组语言的rec库大约占用10MB空间(未压缩)。若删除到仅剩1组语言,可以节省约60MB空间。

请不要删除cls_infer及det_infer后缀的文件夹,这是所有语言公用的检测/方向分类库。


## 返回值说明

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



## 常用配置参数说明

| 键名称 | 默认值 | 值说明 |
| ------------- | ------ | ----------------------------------------------------- |
| config_path | "" | 可以指定不同语言的配置文件路径,识别多国语言。 |
| cls | false | 启用cls方向分类,识别方向不是正朝上的图片。 |
| use_angle_cls | false | 启用方向分类,必须与cls值相同。 |
| enable_mkldnn | true | 启用CPU推理加速,关掉可以减少内存占用,但会降低速度。 |

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

### 切换识别语言:

`v1.3`版本的Release压缩包中,默认附带了 `简中,繁中,英,日,韩,俄,德,法` 的语言库与配置文件,在 `models` 目录下。

`models` 目录中,每一个 `config_xxx.txt` 是一组语言配置文件(如英文是`congfig_en.txt`)。只需将这个文件的路径传入 `config_path` 参数,即可切换为对应的语言。以 Python API 为例:

```python
argument = {'config_path': "models/congfig_en.txt"}
ocr = GetOcrApi(r"D:/Test/PaddleOCR_json.exe", argument)
```

如果 config_path 留空,则 PaddleOCR-json 默认加载并使用简体中文识别库。

#### 删除语言库:

若你希望删除吃灰的语言库文件以便减少软件体积,可以删除 `models` 目录中含有对应语言前缀和 **rec_infer** 后缀的文件夹。比如你希望删除日语`japan`相关的库,只需删除该文件夹:
`japan_PP-OCRv3_rec_infer`

一组语言的rec库大约占用10MB空间(未压缩)。若删除到仅剩1组语言,可以节省约60MB空间。

请不要删除cls_infer及det_infer后缀的文件夹,这是所有语言公用的检测/方向分类库。

### [详细使用指南](docs/详细使用指南.md)

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

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

#### [v1.3.0](https://github.com/hiroi-sora/PaddleOCR-json/tree/backups/1.3.0) `2023.6.19`
- 修复了一些BUG。

#### v1.3.0 Alpha `2023.5.26`
- 重构代码,条理更清晰,易于移植。
- 新功能:Base64传图片。
Expand Down

0 comments on commit 39fef8d

Please sign in to comment.