From 04378dc1e3a58f59f4fab06d0cfebaf698425970 Mon Sep 17 00:00:00 2001 From: tink2123 Date: Mon, 13 Jul 2020 13:35:20 +0800 Subject: [PATCH] update readme --- README.md | 2 +- README_en.md | 2 +- doc/doc_ch/quickstart.md | 12 +++++++++--- doc/doc_ch/recognition.md | 11 +++++++++-- 4 files changed, 20 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 11c83ea1..12545649 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ PaddleOCR旨在打造一套丰富、领先、且实用的OCR工具库，助力使用者训练出更好的模型，并应用落地。 **近期更新** -- 2020.7.9 添加支持空格的识别模型，[识别效果](#支持空格的中文OCR效果展示)，[训练](./doc/doc_ch/recognition.md)及[预测](./doc/doc_ch/quickstart.md) +- 2020.7.9 添加支持空格的识别模型，[识别效果](#支持空格的中文OCR效果展示)，预测及训练方式请参考[快速开始](./doc/doc_ch/quickstart.md) [文本识别](./doc/doc_ch/recognition.md) - 2020.7.9 添加数据增强、学习率衰减策略,具体参考[配置文件](./doc/doc_ch/config.md) - 2020.6.8 添加[数据集](./doc/doc_ch/datasets.md)，并保持持续更新 - 2020.6.5 支持 `attetnion` 模型导出 `inference_model` diff --git a/README_en.md b/README_en.md index 671d3bc7..38bda392 100644 --- a/README_en.md +++ b/README_en.md @@ -4,7 +4,7 @@ English | [简体中文](README.md) PaddleOCR aims to create a rich, leading, and practical OCR tools that help users train better models and apply them into practice. **Recent updates**、 -- 2020.7.9 Add recognition model to support space, [recognition result](#space Chinese OCR results),[Training](./doc/doc_ch/recognition.md)及[Inference](./doc/doc_ch/quickstart.md) +- 2020.7.9 Add recognition model to support space, [recognition result](#space Chinese OCR results). For more information: [Recognition](./doc/doc_ch/recognition.md) and [quickstart](./doc/doc_ch/quickstart.md) - 2020.7.9 Add data auguments and learning rate decay strategies,please read [config](./doc/doc_en/config_en.md) - 2020.6.8 Add [dataset](./doc/doc_en/datasets_en.md) and keep updating - 2020.6.5 Support exporting `attention` model to `inference_model` diff --git a/doc/doc_ch/quickstart.md b/doc/doc_ch/quickstart.md index efb04daa..c5385f07 100644 --- a/doc/doc_ch/quickstart.md +++ b/doc/doc_ch/quickstart.md @@ -65,17 +65,23 @@ python3 tools/infer/predict_system.py --image_dir="./doc/imgs/" --det_model_dir= python3 tools/infer/predict_system.py --image_dir="./doc/imgs/11.jpg" --det_model_dir="./inference/ch_det_mv3_db/" --rec_model_dir="./inference/ch_rec_mv3_crnn/" --use_gpu=False ``` -通用中文OCR模型的体验可以按照上述步骤下载相应的模型，并且更新相关的参数，示例如下： +- 通用中文OCR模型 + +请按照上述步骤下载相应的模型，并且更新相关的参数，示例如下： ``` # 预测image_dir指定的单张图像 python3 tools/infer/predict_system.py --image_dir="./doc/imgs/11.jpg" --det_model_dir="./inference/ch_det_r50_vd_db/" --rec_model_dir="./inference/ch_rec_r34_vd_crnn/" ``` -带空格的通用中文OCR模型的体验可以按照上述步骤下载相应的模型，并且更新相关的参数，示例如下： +- 支持空格的通用中文OCR模型 + +请按照上述步骤下载相应的模型，并且更新相关的参数，示例如下： + +*注意：请将代码更新到最新版本，并添加参数 `--use_space_char=True` * ``` # 预测image_dir指定的单张图像 -python3 tools/infer/predict_system.py --image_dir="./doc/imgs_en/img_12.jpg" --det_model_dir="./inference/ch_det_r50_vd_db/" --rec_model_dir="./inference/ch_rec_r34_vd_crnn_enhance/" +python3 tools/infer/predict_system.py --image_dir="./doc/imgs_en/img_12.jpg" --det_model_dir="./inference/ch_det_r50_vd_db/" --rec_model_dir="./inference/ch_rec_r34_vd_crnn_enhance/" --use_space_char=True ``` 更多的文本检测、识别串联推理使用方式请参考文档教程中[基于Python预测引擎推理](./inference.md)。 diff --git a/doc/doc_ch/recognition.md b/doc/doc_ch/recognition.md index 8fe28fed..b23837be 100644 --- a/doc/doc_ch/recognition.md +++ b/doc/doc_ch/recognition.md @@ -94,9 +94,16 @@ word_dict.txt 每行有一个单字，将字符与数字索引映射在一起， `ppocr/utils/ic15_dict.txt` 是一个包含36个字符的英文字典， 您可以按需使用。 -如需自定义dic文件，请在 `configs/rec/rec_icdar15_train.yml` 中添加 `character_dict_path` 字段, 并将 `character_type` 设置为 `ch`。 +- 自定义字典 -*如果希望支持识别"空格"类别, 请将yml文件中的 `use_space_char` 字段设置为 `true`。`use_space_char` 仅在 `character_type=ch` 时生效* +如需自定义dic文件，请在 `configs/rec/rec_icdar15_train.yml` 中添加 `character_dict_path` 字段, 指向您的字典路径。 +并将 `character_type` 设置为 `ch`。 + +- 添加空格类别 + +如果希望支持识别"空格"类别, 请将yml文件中的 `use_space_char` 字段设置为 `true`。 + +**注意：`use_space_char` 仅在 `character_type=ch` 时生效** ### 启动训练 -- GitLab