# 文字识别

## 1 简介

PAI-EasyVision支持的文字识别算法包含CRNN-Attention、CRNN-CRCC、CNN-SpatialAttention、TransformerOCR等，主要算法框架如下图所示。![text_recognition](../../images/model/text_recognition.png)



## 2 使用示例

以小票文本识别为例，训练CRNN-Attention模型为例，介绍如何训练一个文字识别模型



### 2.1 数据准备

VOC我们已经提供了转换好的tfrecord， 下载VOC到 `data` 文件夹下

```bash
ossutil cp -r  oss://pai-vision-data-hz/data/recipt_text/recognition_tfrecords/ data/recipt_text/recognition_tfrecords
```

下载我们提供的中英文数据预训练的文字识别模型到`pretrained_models`文件夹下

```bash
ossutil cp -r oss://pai-vision-data-hz/pretrained_models/general_crnn_attn_resnet15 pretrained_models/general_crnn_attn_resnet15
```



### 2.2 模型训练

#### 2.2.1 文件配置形式

运行如下python代码即可启动文件配置形式的训练评估流程，样例配置文件参见[sample_config](../sample_config.html#id6)，配置文件参数说明参见[proto文档](../proto.html)。如果你使用了自定义的配置文件，把`easy_vision.TEXT_RECOG_CRNN_ATTN_CONFIG_RECIPT` 替换为你的配置文件路径即可。

```python
import easy_vision
easy_vision.train_and_evaluate(easy_vision.TEXT_RECOG_CRNN_ATTN_CONFIG_RECIPT)
```



#### 2.2.2 参数配置训练

运行如下python代码即可启动参数配置形式的训练评估流程

```python
import easy_vision
param_config = """
  --model_type TextRecognition
  --backbone text_resnet15
  --use_pretrained_model true
  --train_batch_size 32
  --test_batch_size 32
  --initial_learning_rate 0.0001
  --optimizer adam
  --lr_type exponential_decay
  --decay_epochs 10
  --decay_factor 0.7
  --staircase true
  --train_data data/recipt_text/recognition_tfrecords/train_*.tfrecord
  --test_data data/recipt_text/recognition_tfrecords/test.tfrecord
  --model_dir experiments/recipt_text/crnn_attn_resnet15_fixed_height"""
easy_vision.train_and_evaluate_with_param_config(param_config)
```

param_config 包含若干模型配置参数，格式遵循python argparser格式，各参数具体说明如下，所有字符串均不需要加引号

| 参数名称              | 参数描述                                                     | 参数值格式                                                   | 默认值          |
| --------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | --------------- |
| model_type            | 训练模型类型                                                 | 字符串，可选范围<br />TextRecognition                        | 无，必选字段    |
| backbone              | 文字识别模型使用的backbone                                   | 字符串格式，可取值范围：<br />text_resnet15<br />vgg_bai     | 无，必选参数    |
| weight_decay          | l2 regularization的大小                                      | 浮点                                                         | 1e-4            |
| image_resize_height   | 图片高度缩放大小                                             | 整型                                                         | 32              |
| image_resize_width    | 图片宽度缩放大小，如果默认为-1，则为固定宽高比缩放           | 整型                                                         | -1              |
| min_input_ratio       | 图片最小的宽高比约束，当固定宽高比缩放时生效                 | 浮点数                                                       | 0.125           |
| max_input_ratio       | 图片最大的宽高比约束，当固定宽高比缩放时生效                 | 浮点数                                                       | 38.0            |
| num_buckets           | 图片分桶数目，相似宽高比的会被分进同一个桶中，当固定宽高比缩放时生效 | 整型                                                         | 10              |
| random_distort_color  | 是否在训练时随机扰动图片的亮度、对比度、饱和度               | 布尔                                                         | true            |
| rgb_to_gray           | 是否将图片转换为灰度图                                       | 布尔                                                         | true            |
| encoder_type          | 编码器类型<br />crnn: CNN+RNN编码器<br />cnn_line: CNN编码器<br />cnn_spatial: CNN编码器，用于spatial attention | 字符串，可选范围<br />crnn<br />cnn_line<br />cnn_spatial    | crnn            |
| encoder_num_layers    | 编码器层数（一般指RNN层数或RNN层数，CNN不计算在内）          | 整型                                                         | 2               |
| encoder_rnn_type      | 编码器中RNN的类型，<br />bi：双向rnn encoder<br />uni：单向rnn encoder | 字符串，可选范围<br />bi<br />uni                            | uni             |
| encoder_hidden_size   | 编码器中的隐藏层神经元数目                                   | 整型                                                         | 512             |
| encoder_cell_type     | 编码器中的rnn cell类型                                       | 字符串，可选范围<br />basic_lstm<br />gru<br />layer_norm_basic_lstm<br />nas | basic_lstm      |
| decoder_type          | 解码器类型                                                   | 字符串，可选范围<br />attention<br />ctc                     | attention       |
| decoder_num_layers    | 解码器层数                                                   | 整型                                                         | 2               |
| decoder_hidden_size   | 解码器中的隐藏层神经元数目                                   | 整型                                                         | 512             |
| decoder_cell_type     | 解码器中的rnn cell类型                                       | 字符串，可选范围<br />basic_lstm<br />gru<br />layer_norm_basic_lstm<br />nas | basic_lstm      |
| embedding_size        | 字典的embedding大小                                          | 整型                                                         | 64              |
| beam_width            | beam search中的beam width                                    | 整形                                                         | 0               |
| length_penalty_weight | beam search中的length penalty，用于避免短序列倾向            | 浮点数                                                       | 0.0             |
| attention_mechanism   | 解码器中的attention类型                                      | 字符串，可选范围<br />luong<br />scaled_luong<br />bahdanau<br />normed_bahdanau | normed_bahdanau |
| optimizer             | 优化方法，其中momentum就是sgd                                | 字符串，可选方法如下：<br />momentum<br />adam               | momentum        |
| lr_type | 学习率调整策略<br />exponential_decay, 指数衰减，详细参考[tf.train.exponential_decay ](https://www.tensorflow.org/api_docs/python/tf/train/exponential_decay)<br />polynomial_decay, 多项式衰减，详细参考[tf.train.polynomial_decay](https://www.tensorflow.org/api_docs/python/tf/train/polynomial_decay)， 其中num_steps自动设置为总的训练迭代次数，end_learning_rate为initial_learning_rate的千分之一<br />manual_step， 人工指定各阶段的学习率，<br />通过decay_epochs 指定需要调整学习率的迭代轮数，<br />通过learning_rates指定对应迭代轮数使用的学习率<br />cosine_decay，通过余弦曲线调制学习率变化，最终会降到0。详细参考[论文](https://arxiv.org/abs/1608.03983)，<br />通过decay_epochs 指定需要调整学习率的迭代轮数 | 字符串，可选方法如下：<br />exponential_decay<br />polynomial_decay<br />manual_step<br />cosine_decay | exponential_decay |
| initial_learning_rate | 初始学习率 | 浮点数 | 0.01 |
| decay_epochs<br /> | 如果使用exponential_decay, 参数对应 [tf.train.exponential_decay]()中的decay_steps，后端会自动根据训练数据总数把decay_epochs转换为decay_steps。例如数值可填：10，一般是总epoch数的1/2。<br /><br />如果使用manual_step， 参数表示需要调整学习率的迭代轮数， "16 18"表示在16epoch 18 epoch对学习率进行调整。一般这两个值取总设置的总epoch的8/10、9/10 | 整数列表<br />20 <br />20 40 60 | 20 |
| decay_factor | [tf.train.exponential_decay ](https://www.tensorflow.org/api_docs/python/tf/train/exponential_decay)中的decay_factor | 浮点数 | 0.95 |
| staircase | [tf.train.exponential_decay ](https://www.tensorflow.org/api_docs/python/tf/train/exponential_decay)中的staircase | 布尔 | true |
| power | [tf.train.polynomial_decay](https://www.tensorflow.org/api_docs/python/tf/train/polynomial_decay) 中的power | float | 0.9 |
| learning_rates | manual_step学习率调整策略中使用的参数，表示在指定epoch 学习率调整为多少. 如果您指定的调整epoch有两个，则需要在此也填写两个对应的学习率。例：decay_epoches为20 40，此处填写0.001 0.0001，则代表在20epoch学习率调整为0.001，40epoch学习率调整为0.0001。建议这几次调整的学习率是初始学习率的1/10、1/100、1/1000...... | manual_step学习率调整策略中使用的参数，表示在指定epoch 学习率调整为多少 | 浮点列表 |
| lr_warmup | 是否对学习率做warmup | 布尔 | false |
| lr_warm_up_epochs | 学习率warmup的轮数 | 浮点型 | 1 |
| train_data | 训练数据文件oss路径 | oss://path/to/train_*.tfrecord | 无，必选参数 |
| test_data | 训练过程中评估数据oss路径 | oss://path/to/test_*.tfrecord | 无，必选参数 |
| train_batch_size | 训练batch_size | 整型， 例如32 | 无，必选参数 |
| test_batch_size | 评估batch_size | 整型， 例如32 | 无，必选参数 |
| train_num_readers | 训练数据并发读取线程数 | 整型 | 4 |
| model_dir | 训练所用oss目录 | oss://path/to/model | 无，必选参数 |
| pretrained_model | 预训练模型oss路径，如果提供，会在此模型基础上finetune | oss://pai-vision-data-hz/pretrained_models/inception_v4.ckpt | "" |
| use_pretrained_model | 是否使用预训练模型 | 布尔型 | true |
| num_epochs | 训练迭代轮数，1表示所有训练数据过了一遍 | 整型  40 | 无，必选参数 |
| num_test_example | 训练过程中评估数据条目数， -1表示使用所有测试数据集数据 | 整型，例如2000 | 可选，默认-1 |
| num_visualizations | 评估过程可视化显示的样本数目 | 整型 | 10 |
| save_checkpoint_epochs | 保存checkpoint的频率，以epoch为单位， 1表示每过一遍训练数据保存一次checkpoint | 整型 | 1 |
| save_summary_epochs | 保存summary的频率，以epoch为单位， 0.01 表示每过1%训练数据保存一次summary | 浮点 | 0.01 |
| num_train_images | 总的训练样本数，如果使用自己生成的tfrecord需要提供该信息 | 整型 | 可选，默认0 |
| label_map_path | 类别映射文件，如果使用自己生成的tfrecord需要提供该信息 | 字符串 | 可选，默认"" |