Merge branch 'main' of https://github.com/mindspore-lab/mindocr

Author: horcham

.github/workflows/python-publish.yml

@@ -30,7 +30,7 @@ jobs:
         python -m build
     - name: Publish package
       env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
       run: |
         twine upload dist/*

MANIFEST.in

@@ -1,4 +1,5 @@
 include LICENSE
 include README.md
+include requirements.txt
 
 recursive-include mindocr *.py

configs/det/dbnet/db++_r50_icdar15_8p.yaml renamed to configs/det/dbnet/dbpp_r50_icdar15_8p.yaml

@@ -160,7 +160,7 @@ python infer.py \
     --input_images_dir=/your_path_to/val \
     --layout_model_path=your_path_to/output.mindir \
     --layout_model_name_or_config=../../configs/layout/yolov8/yolov8n.yaml \
-    --layout_save_dir=results_dir
+    --res_save_dir=results_dir
 ```
 
 ## 6. Visualization

configs/layout/yolov8/README.md

@@ -173,7 +173,7 @@ python infer.py \
     --input_images_dir=/your_path_to/val \
     --layout_model_path=your_path_to/output.mindir \
     --layout_model_name_or_config=../../configs/layout/yolov8/yolov8n.yaml \
-    --layout_save_dir=results_dir
+    --res_save_dir=results_dir
 ```
 
 ## 6. 可视化

configs/layout/yolov8/README_CN.md

@@ -186,7 +186,7 @@ We use the dataset under `evaluation/` as the benchmark dataset. On **each indiv
 To reproduce the reported evaluation results, you can:
 - Option 1: Repeat the evaluation step for all individual datasets: CUTE80, IC03_860, IC03_867, IC13_857, IC131015, IC15_1811, IC15_2077, IIIT5k_3000, SVT, SVTP. Then take the average score.
 
-- Option 2: Put all the benchmark datasets folder under the same directory, e.g. `evaluation/`. And use the script `tools/benchmarking/multi_dataset_eval.py`.
+- Option 2: Put all the benchmark datasets folder under the same directory, e.g. `evaluation/`. Modify the `eval.dataset.data_dir` in the config yaml accordingly. Then execute the script `tools/benchmarking/multi_dataset_eval.py`.
 
 1. Evaluate on one specific dataset
 
@@ -295,7 +295,7 @@ eval:
 
 * Distributed Training
 
-It is easy to reproduce the reported results with the pre-defined training recipe. For distributed training on multiple Ascend 910 devices, please modify the configuration parameter `distribute` as True and run
+It is easy to reproduce the reported results with the pre-defined training recipe. For distributed training on multiple Ascend 910 devices, please modify the configuration parameter `system.distribute` as True and run
 
 ```shell
 # distributed training on multiple GPU/Ascend devices
@@ -305,23 +305,29 @@ mpirun --allow-run-as-root -n 8 python tools/train.py --config configs/rec/crnn/
 
 * Standalone Training
 
-If you want to train or finetune the model on a smaller dataset without distributed training, please modify the configuration parameter`distribute` as False and run:
+If you want to train or finetune the model on a smaller dataset without distributed training, please modify the configuration parameter`system.distribute` as False and run:
 
 ```shell
 # standalone training on a CPU/GPU/Ascend device
 python tools/train.py --config configs/rec/crnn/crnn_resnet34.yaml
 ```
 
-The training result (including checkpoints, per-epoch performance and curves) will be saved in the directory parsed by the arg `ckpt_save_dir`. The default directory is `./tmp_rec`.
+The training result (including checkpoints, per-epoch performance and curves) will be saved in the directory parsed by the arg `train.ckpt_save_dir`. The default directory is `./tmp_rec`.
 
 ### 3.3 Model Evaluation
 
-To evaluate the accuracy of the trained model, you can use `eval.py`. Please set the checkpoint path to the arg `ckpt_load_path` in the `eval` section of yaml config file, set `distribute` to be False, and then run:
+To evaluate the accuracy of the trained model, you can use `eval.py`. Please set the checkpoint path to the arg `eval.ckpt_load_path` in the yaml config file, set the evaluation dataset path to the arg `eval.dataset.data_dir`, set `system.distribute` to be False, and then run:
 
 ```
 python tools/eval.py --config configs/rec/crnn/crnn_resnet34.yaml
 ```
 
+Similarly, the accuracy of the trained model can be evaluated using multiple evaluation datasets by properly setting the args `eval.ckpt_load_path`, `eval.dataset.data_dir`, and `system.distribute` in the yaml config file. And then run:
+
+```
+python tools/benchmarking/multi_dataset_eval.py --config configs/rec/crnn/crnn_resnet34.yaml
+```
+
 ## 4. Character Dictionary
 
 ### Default Setting
@@ -341,11 +347,11 @@ There are some built-in dictionaries, which are placed in `mindocr/utils/dict/`,
 You can also customize a dictionary file (***.txt) and place it under `mindocr/utils/dict/`, the format of the dictionary file should be a .txt file with one character per line.
 
 
-To use a specific dictionary, set the parameter `character_dict_path` to the path of the dictionary, and change the parameter `num_classes` to the corresponding number, which is the number of characters in the dictionary + 1.
+To use a specific dictionary, set the parameter `common.character_dict_path` to the path of the dictionary, and change the parameter `common.num_classes` to the corresponding number, which is the number of characters in the dictionary + 1.
 
 
 **Notes:**
-- You can include the space character by setting the parameter `use_space_char` in configuration yaml to True.
+- You can include the space character by setting the parameter `common.use_space_char` in configuration yaml to True.
 - Remember to check the value of `dataset->transform_pipeline->RecCTCLabelEncode->lower` in the configuration yaml. Set it to False if you prefer case-sensitive encoding.
 
 

configs/rec/crnn/README.md

@@ -186,7 +186,7 @@ eval:
 如要重现报告的评估结果，您可以：
 - 方法 1：对所有单个数据集重复评估步骤：CUTE80、IC03_860、IC03_867、IC13_857、IC131015、IC15_1811、IC15_2077、IIIT5k_3000、SVT、SVTP。然后取平均分。
 
-- 方法 2：将所有基准数据集文件夹放在同一目录下，例如`evaluation/`。并使用脚本`tools/benchmarking/multi_dataset_eval.py`。
+- 方法 2：将所有基准数据集文件夹放在同一目录下，例如`evaluation/`，对应修改配置文件中`eval.dataset.data_dir`变量配置，并执行脚本`tools/benchmarking/multi_dataset_eval.py`。
 
 1.评估一个特定的数据集
 
@@ -295,7 +295,7 @@ eval:
 
 * 分布式训练
 
-使用预定义的训练配置可以轻松重现报告的结果。对于在多个昇腾910设备上的分布式训练，请将配置参数`distribute`修改为True，并运行：
+使用预定义的训练配置可以轻松重现报告的结果。对于在多个昇腾910设备上的分布式训练，请将配置参数`system.distribute`修改为True，并运行：
 
 ```shell
 # 在多个 GPU/Ascend 设备上进行分布式训练
@@ -305,23 +305,29 @@ mpirun --allow-run-as-root -n 8 python tools/train.py --config configs/rec/crnn/
 
 * 单卡训练
 
-如果要在没有分布式训练的情况下在较小的数据集上训练或微调模型，请将配置参数`distribute`修改为False 并运行：
+如果要在没有分布式训练的情况下在较小的数据集上训练或微调模型，请将配置参数`system.distribute`修改为False 并运行：
 
 ```shell
 # CPU/GPU/Ascend 设备上的单卡训练
 python tools/train.py --config configs/rec/crnn/crnn_resnet34.yaml
 ```
 
-训练结果（包括checkpoint、每个epoch的性能和曲线图）将被保存在yaml配置文件的`ckpt_save_dir`参数配置的目录下，默认为`./tmp_rec`。
+训练结果（包括checkpoint、每个epoch的性能和曲线图）将被保存在yaml配置文件的`train.ckpt_save_dir`参数配置的目录下，默认为`./tmp_rec`。
 
 ### 3.3 模型评估
 
-若要评估已训练模型的准确性，可以使用`eval.py`。请在yaml配置文件的`eval`部分将参数`ckpt_load_path`设置为模型checkpoint的文件路径，设置`distribute`为False，然后运行：
+若要评估已训练模型的准确性，可以使用`eval.py`。请将yaml配置文件的参数`eval.ckpt_load_path`设置为模型checkpoint的文件路径，参数`eval.dataset.data_dir`设置为评估数据集目录，参数`system.distribute`设置为False，然后运行：
 
 ```
 python tools/eval.py --config configs/rec/crnn/crnn_resnet34.yaml
 ```
 
+类似的，可以修改yaml配置文件的`eval.ckpt_load_path`、`eval.dataset.data_dir`、`system.distribute`等参数，然后使用`multi_dataset_eval.py`评估多个数据集的模型准确性：
+
+```
+python tools/benchmarking/multi_dataset_eval.py --config configs/rec/crnn/crnn_resnet34.yaml
+```
+
 ## 4. 字符词典
 
 ### 默认设置
@@ -342,11 +348,11 @@ Mindocr内置了一部分字典，均放在了 `mindocr/utils/dict/` 位置，
 您也可以自定义一个字典文件 (***.txt)， 放在 `mindocr/utils/dict/` 下，词典文件格式应为每行一个字符的.txt 文件。
 
 
-如需使用指定的词典，请将参数 `character_dict_path` 设置为字典的路径，并将参数 `num_classes` 改成对应的数量，即字典中字符的数量 + 1。
+如需使用指定的词典，请将参数 `common.character_dict_path` 设置为字典的路径，并将参数 `common.num_classes` 改成对应的数量，即字典中字符的数量 + 1。
 
 
 **注意：**
-- 您可以通过将配置文件中的参数 `use_space_char` 设置为 True 来包含空格字符。
+- 您可以通过将配置文件中的参数 `common.use_space_char` 设置为 True 来包含空格字符。
 - 请记住检查配置文件中的 `dataset->transform_pipeline->RecCTCLabelEncode->lower` 参数的值。如果词典中有大小写字母而且想区分大小写的话，请将其设置为 False。
 
 

configs/rec/crnn/README_CN.md

@@ -10,6 +10,7 @@
  - [DBNet训练速率不及预期](#q9-DBNet训练速率不及预期)
  - [`libgomp-d22c30c5.so.1.0.0`相关错误](#q10-libgomp-d22c30c5so100相关错误)
  - [当在lmdb dataset上训练abinet报数据管道错误](#q11-当在lmdb-dataset上训练abinet报数据管道错误)
+ - [当在synthtext数据集上训练dbnet报运行时错误](#q12-当在synthtext数据集上训练dbnet报运行时错误)
 
 ### Q1 未定义符号
 
@@ -742,3 +743,15 @@ mindspore/ccsrc/minddata/dataset/kernels/py_func_op.cc(143).
   102           EXECUTORS_LIST[key] = executor
   ```
   - 保存后再次尝试训练即可
+
+### Q12 当在synthtext数据集上训练dbnet报运行时错误
+当在synthtext数据集上训练dbnet报以下数据管道错误
+```bash
+Traceback (most recent call last):
+  ...
+  File "/root/archiconda3/envs/Python380/lib/python3.8/site-packages/mindspore/common/api.py", line 1608, in _exec_pip
+    return self.graph_executor(args, phase)
+RuntimeError: Run task for graph:kernel_graph_1 error! The details reger to 'Ascend Error Message'
+```
+
+请尝试将CANN更新到7.1。

docs/cn/tutorials/frequently_asked_questions.md

@@ -10,6 +10,7 @@
  - [Training speed of DBNet not as fast as expexted](#q9-training-speed-of-dbnet-not-as-fast-as-expexted)
  - [Error about `libgomp-d22c30c5.so.1.0.0`](#q10-error-about-libgomp-d22c30c5so100)
  - [Dataset Pipeline Error when training abinet on lmdb dataset](#q11-dataset-pipeline-error-when-training-abinet-on-lmdb-dataset)
+ - [Runtime Error when training dbnet on synthtext dataset](#q12-runtime-error-when-training-dbnet-on-synthtext-dataset)
 
 ### Q1 Undefined symbol
 
@@ -731,3 +732,15 @@ You can try the following steps to fix it:
   102           EXECUTORS_LIST[key] = executor
   ```
   - save the file, and try to train the model.
+
+
+### Q12 Runtime Error when training dbnet on synthtext dataset
+Runtime Error occur as following when training dbnet on synthtext dataset:
+```bash
+Traceback (most recent call last):
+  ...
+  File "/root/archiconda3/envs/Python380/lib/python3.8/site-packages/mindspore/common/api.py", line 1608, in _exec_pip
+    return self.graph_executor(args, phase)
+RuntimeError: Run task for graph:kernel_graph_1 error! The details reger to 'Ascend Error Message'
+```
+Please update CANN to 7.1 version.

docs/en/tutorials/frequently_asked_questions.md

@@ -266,8 +266,13 @@ def _parse_minddata_op(dataset_args):
             minddata_op_list.append(color_adjust_op)
             continue
         if "NormalizeImage" in transform_dict.keys():
+            from mindocr.data.transforms.general_transforms import get_value
+
+            normalize_transform = transform_dict["NormalizeImage"]
+            mean = get_value(normalize_transform.get("mean", "imagenet"), "mean")
+            std = get_value(normalize_transform.get("std", "imagenet"), "std")
             minddata_op_idx.append(i)
-            normalize_op = ms.dataset.vision.Normalize(mean=IMAGENET_DEFAULT_MEAN, std=IMAGENET_DEFAULT_STD)
+            normalize_op = ms.dataset.vision.Normalize(mean=mean, std=std)
             minddata_op_list.append(normalize_op)
             continue
         if "ToCHWImage" in transform_dict.keys():