recognition.md 22.2 KB
Newer Older
T
tink2123 已提交
1
# 文字识别
T
tink2123 已提交
2

T
tink2123 已提交
3
本文提供了PaddleOCR文本识别任务的全流程指南,包括数据准备、模型训练、调优、评估、预测,各个阶段的详细说明:
W
WenmuZhou 已提交
4

A
andyjpaddle 已提交
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
- [1. 数据准备](#1-数据准备)
  * [1.1 自定义数据集](#11-自定义数据集)
  * [1.2 数据下载](#12-数据下载)
  * [1.3 字典](#13-字典)
  * [1.4 添加空格类别](#14-添加空格类别)
  * [1.5 数据增强](#15-数据增强)
- [2. 开始训练](#2-开始训练)
  * [2.1 启动训练](#21-----)
  * [2.2 断点训练](#22-----)
  * [2.3 更换Backbone 训练](#23---backbone---)
  * [2.4 混合精度训练](#24---amp---)
  * [2.5 分布式训练](#25---fleet---)
  * [2.6 知识蒸馏训练](#26---distill---)
  * [2.7 多语言模型训练](#27-多语言模型训练)
  * [2.8 其他训练环境(Windows/macOS/Linux DCU)](#28---other---)
- [3. 模型评估与预测](#3--------)
  * [3.1 指标评估](#31-----)
  * [3.2 测试识别效果](#32-------)
- [4. 模型导出与预测](#4--------)
- [5. FAQ](#5-faq)


<a name="1-数据准备"></a>
# 1. 数据准备
T
tink2123 已提交
29

文幕地方's avatar
文幕地方 已提交
30
### 1.1 准备数据集
T
tink2123 已提交
31

W
WenmuZhou 已提交
32
PaddleOCR 支持两种数据格式:
T
tink2123 已提交
33 34
 - `lmdb` 用于训练以lmdb格式存储的数据集(LMDBDataSet);
 - `通用数据` 用于训练以文本文件存储的数据集(SimpleDataSet);
T
tink2123 已提交
35 36 37 38

训练数据的默认存储路径是 `PaddleOCR/train_data`,如果您的磁盘上已有数据集,只需创建软链接至数据集目录:

```
W
WenmuZhou 已提交
39
# linux and mac os
40
ln -sf <path/to/dataset> <path/to/paddle_ocr>/train_data/dataset
W
WenmuZhou 已提交
41 42
# windows
mklink /d <path/to/paddle_ocr>/train_data/dataset <path/to/dataset>
T
tink2123 已提交
43 44
```

A
andyjpaddle 已提交
45 46
<a name="11-自定义数据集"></a>
## 1.1 自定义数据集
W
WenmuZhou 已提交
47
下面以通用数据集为例, 介绍如何准备数据集:
T
tink2123 已提交
48

W
WenmuZhou 已提交
49
* 训练集
T
tink2123 已提交
50

W
WenmuZhou 已提交
51
建议将训练图片放入同一个文件夹,并用一个txt文件(rec_gt_train.txt)记录图片路径和标签,txt文件里的内容如下:
W
WenmuZhou 已提交
52

W
WenmuZhou 已提交
53
**注意:** txt文件中默认请将图片路径和图片标签用 \t 分割,如用其他方式分割将造成训练报错。
T
tink2123 已提交
54

W
WenmuZhou 已提交
55 56
```
" 图像文件名                 图像标注信息 "
T
tink2123 已提交
57

W
WenmuZhou 已提交
58 59
train_data/rec/train/word_001.jpg   简单可依赖
train_data/rec/train/word_002.jpg   用科技让复杂的世界更简单
W
WenmuZhou 已提交
60 61
...
```
T
tink2123 已提交
62

W
WenmuZhou 已提交
63 64 65
最终训练集应有如下文件结构:
```
|-train_data
W
WenmuZhou 已提交
66
  |-rec
W
WenmuZhou 已提交
67 68 69 70 71 72
    |- rec_gt_train.txt
    |- train
        |- word_001.png
        |- word_002.jpg
        |- word_003.jpg
        | ...
T
tink2123 已提交
73 74
```

75 76 77 78 79 80 81 82 83 84 85
除上述单张图像为一行格式之外,PaddleOCR也支持对离线增广后的数据进行训练,为了防止相同样本在同一个batch中被多次采样,我们可以将相同标签对应的图片路径写在一行中,以列表的形式给出,在训练中,PaddleOCR会随机选择列表中的一张图片进行训练。对应地,标注文件的格式如下。

```
["11.jpg", "12.jpg"]   简单可依赖
["21.jpg", "22.jpg", "23.jpg"]   用科技让复杂的世界更简单
3.jpg   ocr
```

上述示例标注文件中,"11.jpg"和"12.jpg"的标签相同,都是`简单可依赖`,在训练的时候,对于该行标注,会随机选择其中的一张图片进行训练。


I
iterhui 已提交
86
- 验证集
W
WenmuZhou 已提交
87

I
iterhui 已提交
88
同训练集类似,验证集也需要提供一个包含所有图片的文件夹(test)和一个rec_gt_test.txt,验证集的结构如下所示:
W
WenmuZhou 已提交
89 90 91

```
|-train_data
W
WenmuZhou 已提交
92
  |-rec
W
WenmuZhou 已提交
93 94 95 96 97 98
    |- rec_gt_test.txt
    |- test
        |- word_001.jpg
        |- word_002.jpg
        |- word_003.jpg
        | ...
T
tink2123 已提交
99
```
W
WenmuZhou 已提交
100

A
andyjpaddle 已提交
101 102
<a name="12-数据下载"></a>
## 1.2 数据下载
W
WenmuZhou 已提交
103

T
tink2123 已提交
104
- ICDAR2015
W
WenmuZhou 已提交
105

T
tink2123 已提交
106
若您本地没有数据集,可以在官网下载 [ICDAR2015](http://rrc.cvc.uab.es/?ch=4&com=downloads) 数据,用于快速验证。也可以参考[DTRB](https://github.com/clovaai/deep-text-recognition-benchmark#download-lmdb-dataset-for-traininig-and-evaluation-from-here) ,下载 benchmark 所需的lmdb格式数据集。
T
fix doc  
tink2123 已提交
107

T
tink2123 已提交
108
如果你使用的是icdar2015的公开数据集,PaddleOCR 提供了一份用于训练 ICDAR2015 数据集的标签文件,通过以下方式下载:
109

T
fix doc  
tink2123 已提交
110 111 112 113
```
# 训练集标签
wget -P ./train_data/ic15_data  https://paddleocr.bj.bcebos.com/dataset/rec_gt_train.txt
# 测试集标签
T
tink2123 已提交
114
wget -P ./train_data/ic15_data  https://paddleocr.bj.bcebos.com/dataset/rec_gt_test.txt
T
fix doc  
tink2123 已提交
115
```
T
tink2123 已提交
116

T
tink2123 已提交
117
PaddleOCR 也提供了数据格式转换脚本,可以将ICDAR官网 label 转换为PaddleOCR支持的数据格式。 数据转换工具在 `ppocr/utils/gen_label.py`, 这里以训练集为例:
W
WenmuZhou 已提交
118 119 120 121 122 123

```
# 将官网下载的标签文件转换为 rec_gt_label.txt
python gen_label.py --mode="rec" --input_path="{path/of/origin/label}" --output_label="rec_gt_label.txt"
```

T
tink2123 已提交
124 125 126 127 128 129 130 131 132 133
数据样式格式如下,(a)为原始图片,(b)为每张图片对应的 Ground Truth 文本文件:
![](../datasets/icdar_rec.png)

- 多语言数据集

多语言模型的训练数据集均为100w的合成数据,使用了开源合成工具 [text_renderer](https://github.com/Sanster/text_renderer) ,少量的字体可以通过下面两种方式下载。
* [百度网盘](https://pan.baidu.com/s/1bS_u207Rm7YbY33wOECKDA) 提取码:frgi
* [google drive](https://drive.google.com/file/d/18cSWX7wXSy4G0tbKJ0d9PuIaiwRLHpjA/view)


A
andyjpaddle 已提交
134 135
<a name="13-字典"></a>
## 1.3 字典
T
tink2123 已提交
136 137 138

最后需要提供一个字典({word_dict_name}.txt),使模型在训练时,可以将所有出现的字符映射为字典的索引。

T
tink2123 已提交
139
因此字典需要包含所有希望被正确识别的字符,{word_dict_name}.txt需要写成如下格式,并以 `utf-8` 编码格式保存:
T
tink2123 已提交
140

T
tink2123 已提交
141 142
```
l
T
tink2123 已提交
143 144
d
a
T
tink2123 已提交
145 146
d
r
T
tink2123 已提交
147
n
T
tink2123 已提交
148
```
T
tink2123 已提交
149 150 151

word_dict.txt 每行有一个单字,将字符与数字索引映射在一起,“and” 将被映射成 [2 5 1]

W
WenmuZhou 已提交
152 153 154 155
* 内置字典

PaddleOCR内置了一部分字典,可以按需使用。

T
tink2123 已提交
156
`ppocr/utils/ppocr_keys_v1.txt` 是一个包含6623个字符的中文字典
W
WenmuZhou 已提交
157

T
tink2123 已提交
158
`ppocr/utils/ic15_dict.txt` 是一个包含36个字符的英文字典
W
WenmuZhou 已提交
159 160 161

`ppocr/utils/dict/french_dict.txt` 是一个包含118个字符的法文字典

162
`ppocr/utils/dict/japan_dict.txt` 是一个包含4399个字符的日文字典
W
WenmuZhou 已提交
163

164
`ppocr/utils/dict/korean_dict.txt` 是一个包含3636个字符的韩文字典
W
WenmuZhou 已提交
165

166
`ppocr/utils/dict/german_dict.txt` 是一个包含131个字符的德文字典
W
WenmuZhou 已提交
167

T
tink2123 已提交
168
`ppocr/utils/en_dict.txt` 是一个包含96个字符的英文字典
T
tink2123 已提交
169

W
WenmuZhou 已提交
170 171

目前的多语言模型仍处在demo阶段,会持续优化模型并补充语种,**非常欢迎您为我们提供其他语言的字典和字体**
littletomatodonkey's avatar
fix doc  
littletomatodonkey 已提交
172
如您愿意可将字典文件提交至 [dict](../../ppocr/utils/dict),我们会在Repo中感谢您。
W
WenmuZhou 已提交
173

T
tink2123 已提交
174
- 自定义字典
T
tink2123 已提交
175

176
如需自定义dic文件,请在 `configs/rec/PP-OCRv3/en_PP-OCRv3_rec.yml` 中添加 `character_dict_path` 字段, 指向您的字典路径。
T
tink2123 已提交
177

W
WenmuZhou 已提交
178
<a name="支持空格"></a>
A
andyjpaddle 已提交
179
## 1.4 添加空格类别
T
tink2123 已提交
180

181
如果希望支持识别"空格"类别, 请将yml文件中的 `use_space_char` 字段设置为 `True`
T
tink2123 已提交
182

T
tink2123 已提交
183
<a name="数据增强"></a>
A
andyjpaddle 已提交
184
## 1.5 数据增强
T
tink2123 已提交
185 186 187 188 189 190 191 192 193

PaddleOCR提供了多种数据增强方式,默认配置文件中已经添加了数据增广。

默认的扰动方式有:颜色空间转换(cvtColor)、模糊(blur)、抖动(jitter)、噪声(Gasuss noise)、随机切割(random crop)、透视(perspective)、颜色反转(reverse)、TIA数据增广。

训练过程中每种扰动方式以40%的概率被选择,具体代码实现请参考:[rec_img_aug.py](../../ppocr/data/imaug/rec_img_aug.py)

*由于OpenCV的兼容性问题,扰动操作暂时只支持Linux*

A
andyjpaddle 已提交
194 195
<a name="开始训练"></a>
# 2. 开始训练
T
tink2123 已提交
196

197
PaddleOCR提供了训练脚本、评估脚本和预测脚本,本节将以 PP-OCRv3 英文识别模型为例:
T
tink2123 已提交
198

A
andyjpaddle 已提交
199 200 201
<a name="启动训练"></a>
## 2.1 启动训练

T
tink2123 已提交
202
首先下载pretrain model,您可以下载训练好的模型在 icdar2015 数据上进行finetune
T
tink2123 已提交
203 204

```
T
tink2123 已提交
205
cd PaddleOCR/
206 207
# 下载英文PP-OCRv3的预训练模型
wget -P ./pretrain_models/ https://paddleocr.bj.bcebos.com/PP-OCRv3/english/en_PP-OCRv3_rec_train.tar
T
tink2123 已提交
208 209
# 解压模型参数
cd pretrain_models
210
tar -xf en_PP-OCRv3_rec_train.tar && rm -rf en_PP-OCRv3_rec_train.tar
T
tink2123 已提交
211 212 213 214
```

开始训练:

T
tink2123 已提交
215 216
*如果您安装的是cpu版本,请将配置文件中的 `use_gpu` 字段修改为false*

T
tink2123 已提交
217
```
T
tink2123 已提交
218
# GPU训练 支持单卡,多卡训练
T
tink2123 已提交
219
# 训练icdar15英文数据 训练日志会自动保存为 "{save_model_dir}" 下的train.log
T
tink2123 已提交
220

T
tink2123 已提交
221
#单卡训练(训练周期长,不建议)
T
tink2123 已提交
222
python3 tools/train.py -c configs/rec/PP-OCRv3/en_PP-OCRv3_rec.yml -o Global.pretrained_model=./pretrain_models/en_PP-OCRv3_rec_train/best_accuracy
T
tink2123 已提交
223

T
tink2123 已提交
224
#多卡训练,通过--gpus参数指定卡号
T
tink2123 已提交
225
python3 -m paddle.distributed.launch --gpus '0,1,2,3'  tools/train.py -c configs/rec/PP-OCRv3/en_PP-OCRv3_rec.yml -o Global.pretrained_model=./pretrain_models/en_PP-OCRv3_rec_train/best_accuracy
T
tink2123 已提交
226
```
T
tink2123 已提交
227 228


229
PaddleOCR支持训练和评估交替进行, 可以在 `configs/rec/PP-OCRv3/en_PP-OCRv3_rec.yml` 中修改 `eval_batch_step` 设置评估频率,默认每500个iter评估一次。评估过程中默认将最佳acc模型,保存为 `output/en_PP-OCRv3_rec/best_accuracy`
T
tink2123 已提交
230 231 232

如果验证集很大,测试将会比较耗时,建议减少评估次数,或训练完再进行评估。

233
**提示:** 可通过 -c 参数选择 `configs/rec/` 路径下的多种模型配置进行训练,PaddleOCR支持的识别算法可以参考[前沿算法列表](https://github.com/PaddlePaddle/PaddleOCR/blob/dygraph/doc/doc_ch/algorithm_overview.md#12-%E6%96%87%E6%9C%AC%E8%AF%86%E5%88%AB%E7%AE%97%E6%B3%95)
T
tink2123 已提交
234 235


T
tink2123 已提交
236
训练中文数据,推荐使用[ch_PP-OCRv3_rec_distillation.yml](../../configs/rec/PP-OCRv3/ch_PP-OCRv3_rec_distillation.yml),如您希望尝试其他算法在中文数据集上的效果,请参考下列说明修改配置文件:
T
tink2123 已提交
237

T
tink2123 已提交
238
`ch_PP-OCRv3_rec_distillation.yml` 为例:
T
tink2123 已提交
239 240 241
```
Global:
  ...
242 243
  # 添加自定义字典,如修改字典请将路径指向新字典
  character_dict_path: ppocr/utils/ppocr_keys_v1.txt
T
tink2123 已提交
244
  ...
245
  # 识别空格
246
  use_space_char: True
T
tink2123 已提交
247

248 249 250 251

Optimizer:
  ...
  # 添加学习率衰减策略
252 253 254 255 256 257 258 259 260
  lr:
    name: Cosine
    learning_rate: 0.001
  ...

...

Train:
  dataset:
M
MissPenguin 已提交
261
    # 数据集格式,支持LMDBDataSet以及SimpleDataSet
262 263 264 265 266 267 268 269 270
    name: SimpleDataSet
    # 数据集路径
    data_dir: ./train_data/
    # 训练集标签文件
    label_file_list: ["./train_data/train_list.txt"]
    transforms:
      ...
      - RecResizeImg:
          # 修改 image_shape 以适应长文本
271
          image_shape: [3, 48, 320]
272 273 274 275 276 277 278 279 280
      ...
  loader:
    ...
    # 单卡训练的batch_size
    batch_size_per_card: 256
    ...

Eval:
  dataset:
M
MissPenguin 已提交
281
    # 数据集格式,支持LMDBDataSet以及SimpleDataSet
282 283 284 285 286 287 288 289 290
    name: SimpleDataSet
    # 数据集路径
    data_dir: ./train_data
    # 验证集标签文件
    label_file_list: ["./train_data/val_list.txt"]
    transforms:
      ...
      - RecResizeImg:
          # 修改 image_shape 以适应长文本
291
          image_shape: [3, 48, 320]
292 293 294 295 296
      ...
  loader:
    # 单卡验证的batch_size
    batch_size_per_card: 256
    ...
T
tink2123 已提交
297
```
T
tink2123 已提交
298
**注意,预测/评估时的配置文件请务必与训练一致。**
T
tink2123 已提交
299

A
andyjpaddle 已提交
300 301 302 303 304 305

<a name="断点训练"></a>
## 2.2 断点训练

如果训练程序中断,如果希望加载训练中断的模型从而恢复训练,可以通过指定Global.checkpoints指定要加载的模型路径:
```shell
T
tink2123 已提交
306
python3 tools/train.py -c configs/rec/PP-OCRv3/en_PP-OCRv3_rec.yml -o Global.checkpoints=./your/trained/model
A
andyjpaddle 已提交
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
```

**注意**`Global.checkpoints`的优先级高于`Global.pretrained_model`的优先级,即同时指定两个参数时,优先加载`Global.checkpoints`指定的模型,如果`Global.checkpoints`指定的模型路径有误,会加载`Global.pretrained_model`指定的模型。

<a name="23---backbone---"></a>
## 2.3 更换Backbone 训练

PaddleOCR将网络划分为四部分,分别在[ppocr/modeling](../../ppocr/modeling)下。 进入网络的数据将按照顺序(transforms->backbones->necks->heads)依次通过这四个部分。

```bash
├── architectures # 网络的组网代码
├── transforms    # 网络的图像变换模块
├── backbones     # 网络的特征提取模块
├── necks         # 网络的特征增强模块
└── heads         # 网络的输出模块
```
如果要更换的Backbone 在PaddleOCR中有对应实现,直接修改配置yml文件中`Backbone`部分的参数即可。

如果要使用新的Backbone,更换backbones的例子如下:

1.[ppocr/modeling/backbones](../../ppocr/modeling/backbones) 文件夹下新建文件,如my_backbone.py。
2. 在 my_backbone.py 文件内添加相关代码,示例代码如下:

```python
import paddle
import paddle.nn as nn
import paddle.nn.functional as F


class MyBackbone(nn.Layer):
    def __init__(self, *args, **kwargs):
        super(MyBackbone, self).__init__()
        # your init code
        self.conv = nn.xxxx

    def forward(self, inputs):
        # your network forward
        y = self.conv(inputs)
        return y
```

3.[ppocr/modeling/backbones/\__init\__.py](../../ppocr/modeling/backbones/__init__.py)文件内导入添加的`MyBackbone`模块,然后修改配置文件中Backbone进行配置即可使用,格式如下:

```yaml
Backbone:
name: MyBackbone
args1: args1
```

**注意**:如果要更换网络的其他模块,可以参考[文档](./add_new_algorithm.md)

<a name="24---amp---"></a>
## 2.4 混合精度训练

如果您想进一步加快训练速度,可以使用[自动混合精度训练](https://www.paddlepaddle.org.cn/documentation/docs/zh/guides/01_paddle2.0_introduction/basic_concept/amp_cn.html), 以单机单卡为例,命令如下:

```shell
T
tink2123 已提交
364 365
python3 tools/train.py -c configs/rec/PP-OCRv3/en_PP-OCRv3_rec.yml \
     -o Global.pretrained_model=./pretrain_models/en_PP-OCRv3_rec_train/best_accuracy \
A
andyjpaddle 已提交
366 367 368 369 370 371 372 373 374
     Global.use_amp=True Global.scale_loss=1024.0 Global.use_dynamic_loss_scaling=True
 ```

<a name="26---fleet---"></a>
## 2.5 分布式训练

多机多卡训练时,通过 `--ips` 参数设置使用的机器IP地址,通过 `--gpus` 参数设置使用的GPU ID:

```bash
T
tink2123 已提交
375 376
python3 -m paddle.distributed.launch --ips="xx.xx.xx.xx,xx.xx.xx.xx" --gpus '0,1,2,3' tools/train.py -c configs/rec/PP-OCRv3/en_PP-OCRv3_rec.yml \
     -o Global.pretrained_model=./pretrain_models/en_PP-OCRv3_rec_train/best_accuracy
A
andyjpaddle 已提交
377 378 379 380 381 382 383 384 385 386 387 388 389
```

**注意:** 采用多机多卡训练时,需要替换上面命令中的ips值为您机器的地址,机器之间需要能够相互ping通。另外,训练时需要在多个机器上分别启动命令。查看机器ip地址的命令为`ifconfig`。


<a name="26---distill---"></a>
## 2.6 知识蒸馏训练

PaddleOCR支持了基于知识蒸馏的文本识别模型训练过程,更多内容可以参考[知识蒸馏说明文档](./knowledge_distillation.md)。


<a name="27-多语言模型训练"></a>
## 2.7 多语言模型训练
W
WenmuZhou 已提交
390

T
tink2123 已提交
391
PaddleOCR目前已支持80种(除中文外)语种识别,`configs/rec/multi_languages` 路径下提供了一个多语言的配置文件模版: [rec_multi_language_lite_train.yml](../../configs/rec/multi_language/rec_multi_language_lite_train.yml)。
T
tink2123 已提交
392

T
tink2123 已提交
393
按语系划分,目前PaddleOCR支持的语种有:
T
tink2123 已提交
394

T
tink2123 已提交
395 396 397 398 399 400 401 402 403 404 405 406
| 配置文件 |  算法名称 |   backbone |   trans   |   seq      |     pred     |  language |
| :--------: |  :-------:   | :-------:  |   :-------:   |   :-----:   |  :-----:   | :-----:  |
| rec_chinese_cht_lite_train.yml |  CRNN |   Mobilenet_v3 small 0.5 |  None   |  BiLSTM |  ctc  | 中文繁体  |
| rec_en_lite_train.yml |  CRNN |   Mobilenet_v3 small 0.5 |  None   |  BiLSTM |  ctc  | 英语(区分大小写)   |
| rec_french_lite_train.yml |  CRNN |   Mobilenet_v3 small 0.5 |  None   |  BiLSTM |  ctc  | 法语 |  
| rec_ger_lite_train.yml |  CRNN |   Mobilenet_v3 small 0.5 |  None   |  BiLSTM |  ctc  | 德语   |
| rec_japan_lite_train.yml |  CRNN |   Mobilenet_v3 small 0.5 |  None   |  BiLSTM |  ctc  | 日语  |
| rec_korean_lite_train.yml |  CRNN |   Mobilenet_v3 small 0.5 |  None   |  BiLSTM |  ctc  | 韩语  |
| rec_latin_lite_train.yml |  CRNN |   Mobilenet_v3 small 0.5 |  None   |  BiLSTM |  ctc  | 拉丁字母  |
| rec_arabic_lite_train.yml |  CRNN |   Mobilenet_v3 small 0.5 |  None   |  BiLSTM |  ctc  | 阿拉伯字母 |
| rec_cyrillic_lite_train.yml |  CRNN |   Mobilenet_v3 small 0.5 |  None   |  BiLSTM |  ctc  | 斯拉夫字母  |
| rec_devanagari_lite_train.yml |  CRNN |   Mobilenet_v3 small 0.5 |  None   |  BiLSTM |  ctc  | 梵文字母  |
T
tink2123 已提交
407 408

更多支持语种请参考: [多语言模型](https://github.com/PaddlePaddle/PaddleOCR/blob/release/2.1/doc/doc_ch/multi_languages.md#%E8%AF%AD%E7%A7%8D%E7%BC%A9%E5%86%99)
W
WenmuZhou 已提交
409 410 411 412 413 414 415 416 417 418

如您希望在现有模型效果的基础上调优,请参考下列说明修改配置文件:

以 `rec_french_lite_train` 为例:
```
Global:
  ...
  # 添加自定义字典,如修改字典请将路径指向新字典
  character_dict_path: ./ppocr/utils/dict/french_dict.txt
  ...
419
  # 识别空格
420
  use_space_char: True
W
WenmuZhou 已提交
421 422

...
423 424 425

Train:
  dataset:
M
MissPenguin 已提交
426
    # 数据集格式,支持LMDBDataSet以及SimpleDataSet
427 428 429 430 431 432 433 434 435
    name: SimpleDataSet
    # 数据集路径
    data_dir: ./train_data/
    # 训练集标签文件
    label_file_list: ["./train_data/french_train.txt"]
    ...

Eval:
  dataset:
M
MissPenguin 已提交
436
    # 数据集格式,支持LMDBDataSet以及SimpleDataSet
437 438 439 440 441 442
    name: SimpleDataSet
    # 数据集路径
    data_dir: ./train_data
    # 验证集标签文件
    label_file_list: ["./train_data/french_val.txt"]
    ...
W
WenmuZhou 已提交
443
```
444

A
andyjpaddle 已提交
445 446
<a name="28---other---"></a>
## 2.8 其他训练环境
447

A
andyjpaddle 已提交
448 449 450 451
- Windows GPU/CPU
在Windows平台上与Linux平台略有不同:
Windows平台只支持`单卡`的训练与预测,指定GPU进行训练`set CUDA_VISIBLE_DEVICES=0`
在Windows平台,DataLoader只支持单进程模式,因此需要设置 `num_workers` 为0;
452

A
andyjpaddle 已提交
453 454 455 456 457
- macOS
不支持GPU模式,需要在配置文件中设置`use_gpu`为False,其余训练评估预测命令与Linux GPU完全相同。

- Linux DCU
DCU设备上运行需要设置环境变量 `export HIP_VISIBLE_DEVICES=0,1,2,3`,其余训练评估预测命令与Linux GPU完全相同。
458 459


A
andyjpaddle 已提交
460 461
<a name="3--------"></a>
# 3. 模型评估与预测
462

A
andyjpaddle 已提交
463 464 465
<a name="31-----"></a>
## 3.1 指标评估

466
训练中模型参数默认保存在`Global.save_model_dir`目录下。在评估指标时,需要设置`Global.checkpoints`指向保存的参数文件。评估数据集可以通过 `configs/rec/PP-OCRv3/en_PP-OCRv3_rec.yml`  修改Eval中的 `label_file_path` 设置。
T
tink2123 已提交
467 468 469


```
T
tink2123 已提交
470
# GPU 评估, Global.checkpoints 为待测权重
471
python3 -m paddle.distributed.launch --gpus '0' tools/eval.py -c configs/rec/PP-OCRv3/en_PP-OCRv3_rec.yml -o Global.checkpoints={path/to/weights}/best_accuracy
T
tink2123 已提交
472 473
```

A
andyjpaddle 已提交
474 475
<a name="32-------"></a>
## 3.2 测试识别效果
T
tink2123 已提交
476

T
tink2123 已提交
477
使用 PaddleOCR 训练好的模型,可以通过以下脚本进行快速预测。
T
tink2123 已提交
478

T
tink2123 已提交
479 480 481 482 483
默认预测图片存储在 `infer_img` 里,通过 `-o Global.checkpoints` 加载训练好的参数文件:

根据配置文件中设置的的 `save_model_dir` 和 `save_epoch_step` 字段,会有以下几种参数被保存下来:

```
T
tink2123 已提交
484
output/rec/
T
tink2123 已提交
485 486 487 488 489 490 491 492 493 494 495 496 497
├── best_accuracy.pdopt  
├── best_accuracy.pdparams  
├── best_accuracy.states  
├── config.yml  
├── iter_epoch_3.pdopt  
├── iter_epoch_3.pdparams  
├── iter_epoch_3.states  
├── latest.pdopt  
├── latest.pdparams  
├── latest.states  
└── train.log
```
其中 best_accuracy.* 是评估集上的最优模型;iter_epoch_x.* 是以 `save_epoch_step` 为间隔保存下来的模型;latest.* 是最后一个epoch的模型。
T
tink2123 已提交
498 499

```
T
tink2123 已提交
500
# 预测英文结果
501
python3 tools/infer_rec.py -c configs/rec/PP-OCRv3/en_PP-OCRv3_rec.yml -o Global.pretrained_model={path/to/weights}/best_accuracy  Global.infer_img=doc/imgs_words/en/word_1.png
T
tink2123 已提交
502
```
T
tink2123 已提交
503 504 505

预测图片:

506
![](../imgs_words/en/word_1.png)
T
tink2123 已提交
507 508 509 510

得到输入图像的预测结果:

```
T
tink2123 已提交
511
infer_img: doc/imgs_words/en/word_1.png
T
tink2123 已提交
512
        result: ('joint', 0.9998967)
T
tink2123 已提交
513 514
```

515
预测使用的配置文件必须与训练一致,如您通过 `python3 tools/train.py -c configs/rec/ch_ppocr_v2.0/rec_chinese_lite_train_v2.0.yml` 完成了中文模型的训练,
T
tink2123 已提交
516 517 518 519
您可以使用如下命令进行中文模型预测。

```
# 预测中文结果
520
python3 tools/infer_rec.py -c configs/rec/ch_ppocr_v2.0/rec_chinese_lite_train_v2.0.yml -o Global.pretrained_model={path/to/weights}/best_accuracy Global.infer_img=doc/imgs_words/ch/word_1.jpg
T
tink2123 已提交
521 522
```

T
tink2123 已提交
523
预测图片:
T
tink2123 已提交
524

525
![](../imgs_words/ch/word_1.jpg)
X
xiaoting 已提交
526

T
tink2123 已提交
527 528 529
得到输入图像的预测结果:

```
T
tink2123 已提交
530
infer_img: doc/imgs_words/ch/word_1.jpg
T
tink2123 已提交
531
        result: ('韩国小馆', 0.997218)
T
tink2123 已提交
532
```
533 534


A
andyjpaddle 已提交
535 536 537 538 539 540 541
<a name="4--------"></a>
# 4. 模型导出与预测

inference 模型(`paddle.jit.save`保存的模型)
一般是模型训练,把模型结构和模型参数保存在文件中的固化模型,多用于预测部署场景。
训练过程中保存的模型是checkpoints模型,保存的只有模型的参数,多用于恢复训练等。
与checkpoints模型相比,inference 模型会额外保存模型的结构信息,在预测部署、加速推理上性能优越,灵活方便,适合于实际系统集成。
542 543 544 545 546 547 548 549 550

识别模型转inference模型与检测的方式相同,如下:

```
# -c 后面设置训练算法的yml配置文件
# -o 配置可选参数
# Global.pretrained_model 参数设置待转换的训练模型地址,不用添加文件后缀 .pdmodel,.pdopt或.pdparams。
# Global.save_inference_dir参数设置转换的模型将保存的地址。

T
tink2123 已提交
551
python3 tools/export_model.py -c configs/rec/PP-OCRv3/en_PP-OCRv3_rec.yml -o Global.pretrained_model=./pretrain_models/en_PP-OCRv3_rec_train/best_accuracy  Global.save_inference_dir=./inference/en_PP-OCRv3_rec/
552 553
```

554
**注意:**如果您是在自己的数据集上训练的模型,并且调整了中文字符的字典文件,请注意修改配置文件中的`character_dict_path`为自定义字典文件。
555 556 557 558

转换成功后,在目录下有三个文件:

```
T
tink2123 已提交
559
inference/en_PP-OCRv3_rec/
560 561 562 563 564 565 566
    ├── inference.pdiparams         # 识别inference模型的参数文件
    ├── inference.pdiparams.info    # 识别inference模型的参数信息,可忽略
    └── inference.pdmodel           # 识别inference模型的program文件
```

- 自定义模型推理

文幕地方's avatar
文幕地方 已提交
567
  如果训练时修改了文本的字典,在使用inference模型预测时,需要通过`--rec_char_dict_path`指定使用的字典路径
568 569

  ```
570
  python3 tools/infer/predict_rec.py --image_dir="./doc/imgs_words_en/word_336.png" --rec_model_dir="./your inference model" --rec_image_shape="3, 48, 320" --rec_char_dict_path="your text dict path"
571
  ```
A
andyjpaddle 已提交
572 573 574 575 576 577 578 579


<a name="5-faq"></a>
# 5. FAQ

Q1: 训练模型转inference 模型之后预测效果不一致?

**A**:此类问题出现较多,问题多是trained model预测时候的预处理、后处理参数和inference model预测的时候的预处理、后处理参数不一致导致的。可以对比训练使用的配置文件中的预处理、后处理和预测时是否存在差异。