From 2a477c85755957d182abfea96986343a56ac5c36 Mon Sep 17 00:00:00 2001 From: tink2123 Date: Wed, 13 May 2020 20:27:45 +0800 Subject: [PATCH] polish doc --- configs/rec/rec_icdar15_train.yml | 4 +-- doc/recognition.md | 49 ++++++++++++++++--------------- 2 files changed, 27 insertions(+), 26 deletions(-) diff --git a/configs/rec/rec_icdar15_train.yml b/configs/rec/rec_icdar15_train.yml index f57aa465..35aba668 100755 --- a/configs/rec/rec_icdar15_train.yml +++ b/configs/rec/rec_icdar15_train.yml @@ -4,7 +4,7 @@ Global: epoch_num: 3000 log_smooth_window: 20 print_batch_step: 10 - save_model_dir: ./output/rec + save_model_dir: ./output/rec_CRNN save_epoch_step: 300 eval_batch_step: 500 train_batch_size_per_card: 256 @@ -37,6 +37,6 @@ Loss: Optimizer: function: ppocr.optimizer,AdamDecay - base_lr: 0.0001 + base_lr: 0.0005 beta1: 0.9 beta2: 0.999 diff --git a/doc/recognition.md b/doc/recognition.md index 0cfbc997..e50a78ae 100644 --- a/doc/recognition.md +++ b/doc/recognition.md @@ -3,7 +3,9 @@ ### 数据准备 -PaddleOCR 支持 `lmdb` 和 `通用数据` 两种数据格式，请按如下步骤设置数据集： +PaddleOCR 支持两种数据格式: `lmdb` 用于训练公开数据，调试算法, `通用数据` 训练自己的数据: + +请按如下步骤设置数据集： 训练数据的默认存储路径是 `PaddleOCR/train_data`,如果您的磁盘上已有数据集，只需创建软链接至数据集目录： @@ -14,9 +16,9 @@ ln -sf /train_data/dataset * 数据下载 -若您本地没有数据集，可以参考[DTRB](https://github.com/clovaai/deep-text-recognition-benchmark#download-lmdb-dataset-for-traininig-and-evaluation-from-here)，下载 benchmark 所需的lmdb格式数据集。也可在官网下载 [icdar2015](http://rrc.cvc.uab.es/?ch=4&com=downloads) 数据，用于快速验证。 +若您本地没有数据集，可以在官网下载 [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格式数据集。 -* 使用自己数据集 +* 使用自己数据集： 若您希望使用自己的数据进行训练，请参考下文组织您的数据。 @@ -35,6 +37,7 @@ train_data/train_0002.jpg 用科技让复杂的世界更简单 最终训练集应有如下文件结构： +``` |-train_data |- rec_gt_train.txt |- train_imags @@ -42,11 +45,13 @@ train_data/train_0002.jpg 用科技让复杂的世界更简单 |- train_002.jpg |- train_003.jpg | ... +``` - 评估集 同训练集类似，评估集也需要提供一个包含所有图片的文件夹（eval_images）和一个rec_gt_eval.txt，评估集的结构如下所示： +``` |-train_data |- rec_gt_eval.txt |- eval_imags @@ -54,21 +59,22 @@ train_data/train_0002.jpg 用科技让复杂的世界更简单 |- eval_002.jpg |- eval_003.jpg | ... - +``` - 字典 最后需要提供一个字典（{word_dict_name}.txt），使模型在训练时，可以将所有出现的字符映射为字典的索引。 -因此字典需要包含所有希望被正确识别的字符，{word_dict_name}.txt需要写成如下格式： - +因此字典需要包含所有希望被正确识别的字符，{word_dict_name}.txt需要写成如下格式，并以 `utf-8` 编码格式保存： -L +``` +l d a -D -R +d +r n +``` word_dict.txt 每行有一个单字，将字符与数字索引映射在一起，“and” 将被映射成 [2 5 1] @@ -79,7 +85,7 @@ word_dict.txt 每行有一个单字，将字符与数字索引映射在一起， ### 启动训练 -PaddleOCR提供了训练脚本、评估脚本和预测脚本，本节将以RCNN中文识别模型为例： +PaddleOCR提供了训练脚本、评估脚本和预测脚本，本节将以 CRNN 识别模型为例： ``` # 设置PYTHONPATH路径 @@ -89,30 +95,32 @@ export CUDA_VISIBLE_DEVICES=0,1,2,3 python tools/train.py -c configs/rec/rec_icdar15_train.yml ``` -PaddleOCR支持训练和评估交替进行, 可以在 `configs/rec/rec_icdar15_train.yml` 中修改 `eval_batch_step` 设置评估频率，默认每2000个iter评估一次。评估过程中默认将最佳acc模型，保存为 `output/rec/best_accuracy` 。 +PaddleOCR支持训练和评估交替进行, 可以在 `configs/rec/rec_icdar15_train.yml` 中修改 `eval_batch_step` 设置评估频率，默认每2000个iter评估一次。评估过程中默认将最佳acc模型，保存为 `output/rec_CRNN/best_accuracy` 。 如果验证集很大，测试将会比较耗时，建议减少评估次数，或训练完再进行评估。 +* 提示： 可通过 -c 参数选择 `configs/rec/` 路径下的多种模型配置进行训练 + ### 评估 评估数据集可以通过 `configs/rec/rec_icdar15_reader.yml` 修改EvalReader中的 `label_file_path` 设置。 ``` export CUDA_VISIBLE_DEVICES=0 -# GPU 评估， Global.pretrain_weights 为待测权重 -python tools/eval.py -c configs/rec/rec_chinese_lite_train.yml -o Global.pretrain_weights={path/to/weights}/best_accuracy +# GPU 评估， Global.checkpoints 为待测权重 +python tools/eval.py -c configs/rec/rec_chinese_lite_train.yml -o Global.checkpoints={path/to/weights}/best_accuracy ``` -### 测试 +### 预测 * 训练引擎的预测 -PaddleOCR 提供了训练好的中文模型，可以使用 +PaddleOCR 提供了训练好的中文模型，可以[下载](todo: add)进行快速预测。 -默认预测图片存储在 `infer_img` 里，通过 Global.pretrain_weights 指定权重： +默认预测图片存储在 `infer_img` 里，通过 `-o Global.checkpoints` 指定权重： ``` -python tools/infer_rec.py -c configs/rec/rec_chinese_lite_train.yml -o Global.pretrain_weights={path/to/weights}/best_accuracy +python tools/infer_rec.py -c configs/rec/rec_chinese_lite_train.yml -o Global.checkpoints={path/to/weights}/best_accuracy ``` 得到输入图像的预测结果： @@ -125,10 +133,3 @@ infer_img: infer_img/328_4.jpg 冷库专用冷冻液/载冷剂 ``` -得到预测结果后，脚本会自动将权重转换为inference model 并保存在 rec_inference 下： - -|-rec_inference - |- model - |- params - - -- GitLab