diff --git a/doc/doc_ch/tree.md b/doc/doc_ch/tree.md index ba8503d119a27b2cac34b593243caa68404b95ec..603991d3f4d98b3e28b0f29550d0abea13c47f7e 100644 --- a/doc/doc_ch/tree.md +++ b/doc/doc_ch/tree.md @@ -4,38 +4,34 @@ PaddleOCR 的整体目录结构介绍如下: ``` PaddleOCR -├── configs // 配置文件,可通过yml文件选择模型结构并修改超参 -│ ├── cls // 方向分类器相关配置文件 -│ │ ├── cls_mv3.yml // 训练配置相关,包括骨干网络、head、loss、优化器 -│ │ └── cls_reader.yml // 数据读取相关,数据读取方式、数据存储路径 -│ ├── det // 检测相关配置文件 -│ │ ├── det_db_icdar15_reader.yml // 数据读取 -│ │ ├── det_mv3_db.yml // 训练配置 +├── configs // 配置文件,可通过 yml 文件选择模型结构并修改超参 +│ ├── cls // 方向分类器相关配置文件 +│ │ ├── cls_mv3.yml // 训练配置相关,包括骨干网络、head、loss、优化器和数据 +│ ├── det // 检测相关配置文件 +│ │ ├── det_mv3_db.yml // 训练配置 │ │ ... -│ └── rec // 识别相关配置文件 -│ ├── rec_benchmark_reader.yml // LMDB 格式数据读取相关 -│ ├── rec_chinese_common_train.yml // 通用中文训练配置 -│ ├── rec_icdar15_reader.yml // simple 数据读取相关,包括数据读取函数、数据路径、标签文件 +│ └── rec // 识别相关配置文件 +│ ├── rec_mv3_none_bilstm_ctc.yml // crnn 训练配置 │ ... -├── deploy // 部署相关 -│ ├── android_demo // android_demo +├── deploy // 部署相关 +│ ├── android_demo // android_demo │ │ ... -│ ├── cpp_infer // C++ infer -│ │ ├── CMakeLists.txt // Cmake 文件 -│ │ ├── docs // 说明文档 +│ ├── cpp_infer // C++ infer +│ │ ├── CMakeLists.txt // Cmake 文件 +│ │ ├── docs // 说明文档 │ │ │ └── windows_vs2019_build.md -│ │ ├── include // 头文件 -│ │ │ ├── clipper.h // clipper 库 -│ │ │ ├── config.h // 预测配置 -│ │ │ ├── ocr_cls.h // 方向分类器 -│ │ │ ├── ocr_det.h // 文字检测 -│ │ │ ├── ocr_rec.h // 文字识别 -│ │ │ ├── postprocess_op.h // 检测后处理 -│ │ │ ├── preprocess_op.h // 检测预处理 -│ │ │ └── utility.h // 工具 -│ │ ├── readme.md // 说明文档 +│ │ ├── include // 头文件 +│ │ │ ├── clipper.h // clipper 库 +│ │ │ ├── config.h // 预测配置 +│ │ │ ├── ocr_cls.h // 方向分类器 +│ │ │ ├── ocr_det.h // 文字检测 +│ │ │ ├── ocr_rec.h // 文字识别 +│ │ │ ├── postprocess_op.h // 检测后处理 +│ │ │ ├── preprocess_op.h // 检测预处理 +│ │ │ └── utility.h // 工具 +│ │ ├── readme.md // 说明文档 │ │ ├── ... -│ │ ├── src // 源文件 +│ │ ├── src // 源文件 │ │ │ ├── clipper.cpp │ │ │ ├── config.cpp │ │ │ ├── main.cpp @@ -45,10 +41,10 @@ PaddleOCR │ │ │ ├── postprocess_op.cpp │ │ │ ├── preprocess_op.cpp │ │ │ └── utility.cpp -│ │ └── tools // 编译、执行脚本 -│ │ ├── build.sh // 编译脚本 -│ │ ├── config.txt // 配置文件 -│ │ └── run.sh // 测试启动脚本 +│ │ └── tools // 编译、执行脚本 +│ │ ├── build.sh // 编译脚本 +│ │ ├── config.txt // 配置文件 +│ │ └── run.sh // 测试启动脚本 │ ├── docker │ │ └── hubserving │ │ ├── cpu @@ -58,151 +54,151 @@ PaddleOCR │ │ ├── README_cn.md │ │ ├── README.md │ │ └── sample_request.txt -│ ├── hubserving // hubserving -│ │ ├── ocr_det // 文字检测 -│ │ │ ├── config.json // serving 配置 +│ ├── hubserving // hubserving +│ │ ├── ocr_cls // 方向分类器 +│ │ │ ├── config.json // serving 配置 │ │ │ ├── __init__.py -│ │ │ ├── module.py // 预测模型 -│ │ │ └── params.py // 预测参数 -│ │ ├── ocr_rec // 文字识别 +│ │ │ ├── module.py // 预测模型 +│ │ │ └── params.py // 预测参数 +│ │ ├── ocr_det // 文字检测 +│ │ │ ├── config.json // serving 配置 +│ │ │ ├── __init__.py +│ │ │ ├── module.py // 预测模型 +│ │ │ └── params.py // 预测参数 +│ │ ├── ocr_rec // 文字识别 │ │ │ ├── config.json │ │ │ ├── __init__.py │ │ │ ├── module.py │ │ │ └── params.py -│ │ └── ocr_system // 系统预测 +│ │ └── ocr_system // 系统预测 │ │ ├── config.json │ │ ├── __init__.py │ │ ├── module.py │ │ └── params.py -│ ├── imgs // 预测图片 +│ ├── imgs // 预测图片 │ │ ├── cpp_infer_pred_12.png │ │ └── demo.png -│ ├── ios_demo // ios demo +│ ├── ios_demo // ios demo │ │ ... -│ ├── lite // lite 部署 -│ │ ├── cls_process.cc // 方向分类器数据处理 +│ ├── lite // lite 部署 +│ │ ├── cls_process.cc // 方向分类器数据处理 │ │ ├── cls_process.h -│ │ ├── config.txt // 检测配置参数 -│ │ ├── crnn_process.cc // crnn数据处理 +│ │ ├── config.txt // 检测配置参数 +│ │ ├── crnn_process.cc // crnn 数据处理 │ │ ├── crnn_process.h -│ │ ├── db_post_process.cc // db数据处理 +│ │ ├── db_post_process.cc // db 数据处理 │ │ ├── db_post_process.h -│ │ ├── Makefile // 编译文件 -│ │ ├── ocr_db_crnn.cc // 串联预测 -│ │ ├── prepare.sh // 数据准备 -│ │ ├── readme.md // 说明文档 +│ │ ├── Makefile // 编译文件 +│ │ ├── ocr_db_crnn.cc // 串联预测 +│ │ ├── prepare.sh // 数据准备 +│ │ ├── readme.md // 说明文档 │ │ ... -│ ├── pdserving // pdserving 部署 -│ │ ├── det_local_server.py // 检测 快速版,部署方便预测速度快 -│ │ ├── det_web_server.py // 检测 完整版,稳定性高分布式部署 -│ │ ├── ocr_local_server.py // 检测+识别 快速版 -│ │ ├── ocr_web_client.py // 客户端 -│ │ ├── ocr_web_server.py // 检测+识别 完整版 -│ │ ├── readme.md // 说明文档 -│ │ ├── rec_local_server.py // 识别 快速版 -│ │ └── rec_web_server.py // 识别 完整版 +│ ├── pdserving // pdserving 部署 +│ │ ├── det_local_server.py // 检测 快速版,部署方便预测速度快 +│ │ ├── det_web_server.py // 检测 完整版,稳定性高分布式部署 +│ │ ├── ocr_local_server.py // 检测+识别 快速版 +│ │ ├── ocr_web_client.py // 客户端 +│ │ ├── ocr_web_server.py // 检测+识别 完整版 +│ │ ├── readme.md // 说明文档 +│ │ ├── rec_local_server.py // 识别 快速版 +│ │ └── rec_web_server.py // 识别 完整版 │ └── slim -│ └── quantization // 量化相关 -│ ├── export_model.py // 导出模型 -│ ├── quant.py // 量化 -│ └── README.md // 说明文档 -├── doc // 文档教程 +│ └── quantization // 量化相关 +│ ├── export_model.py // 导出模型 +│ ├── quant.py // 量化 +│ └── README.md // 说明文档 +├── doc // 文档教程 │ ... -├── paddleocr.py -├── ppocr // 网络核心代码 -│ ├── data // 数据处理 -│ │ ├── cls // 方向分类器 -│ │ │ ├── dataset_traversal.py // 数据传输,定义数据读取器,读取数据并组成batch -│ │ │ └── randaugment.py // 随机数据增广操作 -│ │ ├── det // 检测 -│ │ │ ├── data_augment.py // 数据增广操作 -│ │ │ ├── dataset_traversal.py // 数据传输,定义数据读取器,读取数据并组成batch -│ │ │ ├── db_process.py // db 数据处理 -│ │ │ ├── east_process.py // east 数据处理 -│ │ │ ├── make_border_map.py // 生成边界图 -│ │ │ ├── make_shrink_map.py // 生成收缩图 -│ │ │ ├── random_crop_data.py // 随机切割 -│ │ │ └── sast_process.py // sast 数据处理 -│ │ ├── reader_main.py // 数据读取器主函数 -│ │ └── rec // 识别 -│ │ ├── dataset_traversal.py // 数据传输,定义数据读取器,包含 LMDB_Reader 和 Simple_Reader -│ │ └── img_tools.py // 数据处理相关,包括数据归一化、扰动 -│ ├── __init__.py -│ ├── modeling // 组网相关 -│ │ ├── architectures // 模型架构,定义模型所需的各个模块 -│ │ │ ├── cls_model.py // 方向分类器 -│ │ │ ├── det_model.py // 检测 -│ │ │ └── rec_model.py // 识别 -│ │ ├── backbones // 骨干网络 -│ │ │ ├── det_mobilenet_v3.py // 检测 mobilenet_v3 -│ │ │ ├── det_resnet_vd.py -│ │ │ ├── det_resnet_vd_sast.py -│ │ │ ├── rec_mobilenet_v3.py // 识别 mobilenet_v3 -│ │ │ ├── rec_resnet_fpn.py -│ │ │ └── rec_resnet_vd.py -│ │ ├── common_functions.py // 公共函数 -│ │ ├── heads // 头函数 -│ │ │ ├── cls_head.py // 分类头 -│ │ │ ├── det_db_head.py // db 检测头 -│ │ │ ├── det_east_head.py // east 检测头 -│ │ │ ├── det_sast_head.py // sast 检测头 -│ │ │ ├── rec_attention_head.py // 识别 attention -│ │ │ ├── rec_ctc_head.py // 识别 ctc -│ │ │ ├── rec_seq_encoder.py // 识别 序列编码 -│ │ │ ├── rec_srn_all_head.py // 识别 srn 相关 -│ │ │ └── self_attention // srn attention -│ │ │ └── model.py -│ │ ├── losses // 损失函数 -│ │ │ ├── cls_loss.py // 方向分类器损失函数 -│ │ │ ├── det_basic_loss.py // 检测基础loss -│ │ │ ├── det_db_loss.py // DB loss -│ │ │ ├── det_east_loss.py // EAST loss -│ │ │ ├── det_sast_loss.py // SAST loss -│ │ │ ├── rec_attention_loss.py // attention loss -│ │ │ ├── rec_ctc_loss.py // ctc loss -│ │ │ └── rec_srn_loss.py // srn loss -│ │ └── stns // 空间变换网络 -│ │ └── tps.py // TPS 变换 -│ ├── optimizer.py // 优化器 -│ ├── postprocess // 后处理 -│ │ ├── db_postprocess.py // DB 后处理 -│ │ ├── east_postprocess.py // East 后处理 -│ │ ├── lanms // lanms 相关 -│ │ │ ... -│ │ ├── locality_aware_nms.py // nms -│ │ └── sast_postprocess.py // sast 后处理 -│ └── utils // 工具 -│ ├── character.py // 字符处理,包括对文本的编码和解码,计算预测准确率 -│ ├── check.py // 参数加载检查 -│ ├── ic15_dict.txt // 英文数字字典,区分大小写 -│ ├── ppocr_keys_v1.txt // 中文字典,用于训练中文模型 -│ ├── save_load.py // 模型保存和加载函数 -│ ├── stats.py // 统计 -│ └── utility.py // 工具函数,包含输入参数是否合法等相关检查工具 -├── README_en.md // 说明文档 -├── README.md -├── requirments.txt // 安装依赖 -├── setup.py // whl包打包脚本 -└── tools // 启动工具 - ├── eval.py // 评估函数 - ├── eval_utils // 评估工具 - │ ├── eval_cls_utils.py // 分类相关 - │ ├── eval_det_iou.py // 检测 iou 相关 - │ ├── eval_det_utils.py // 检测相关 - │ ├── eval_rec_utils.py // 识别相关 - │ └── __init__.py - ├── export_model.py // 导出 infer 模型 - ├── infer // 基于预测引擎预测 - │ ├── predict_cls.py - │ ├── predict_det.py - │ ├── predict_rec.py - │ ├── predict_system.py - │ └── utility.py - ├── infer_cls.py // 基于训练引擎 预测分类 - ├── infer_det.py // 基于训练引擎 预测检测 - ├── infer_rec.py // 基于训练引擎 预测识别 - ├── program.py // 整体流程 - ├── test_hubserving.py - └── train.py // 启动训练 - -``` +├── ppocr // 网络核心代码 +│ ├── data // 数据处理 +│ │ ├── imaug // 图片和 label 处理代码 +│ │ │ ├── text_image_aug // 文本识别的 tia 数据扩充 +│ │ │ │ ├── __init__.py +│ │ │ │ ├── augment.py // tia_distort,tia_stretch 和 tia_perspective 的代码 +│ │ │ │ ├── warp_mls.py +│ │ │ ├── __init__.py +│ │ │ ├── iaa_augment.py // 数据增广操作 +│ │ │ ├── label_ops.py // label 编码操作 +│ │ │ ├── make_border_map.py // 生成边界图 +│ │ │ ├── make_shrink_map.py // 生成收缩图 +│ │ │ ├── operators.py // 图像基本操作,如读取和归一化 +│ │ │ ├── randaugment.py // 随机数据增广操作 +│ │ │ ├── random_crop_data.py // 随机裁剪 +│ │ │ └── rec_img_aug.py // 文本识别的数据扩充 +│ │ ├── __init__.py // 构造 dataloader 相关代码 +│ │ ├── lmdb_dataset.py // 读取lmdb数据集的 dataset +│ │ ├── simple_dataset.py // 读取文本格式存储数据集的 dataset +│ ├── losses // 损失函数 +│ │ ├── __init__.py // 构造 loss 相关代码 +│ │ ├── cls_loss.py // 方向分类器 loss +│ │ ├── det_basic_loss.py // 检测基础 loss +│ │ ├── det_db_loss.py // DB loss +│ │ ├── rec_ctc_loss.py // ctc loss +│ ├── metrics // 评估指标 +│ │ ├── __init__.py // 构造 metric 相关代码 +│ │ ├── cls_metric.py // 方向分类器 metric +│ │ ├── det_metric.py // 检测 metric + │ ├── eval_det_iou.py // 检测 iou 相关 +│ │ ├── rec_metric.py // 识别 metric +│ ├── modeling // 组网相关 +│ │ ├── architectures // 网络 +│ │ │ ├── __init__.py // 构造 model 相关代码 +│ │ │ ├── base_model.py // 组网代码 +│ │ ├── backbones // 骨干网络 +│ │ │ ├── __init__.py // 构造 backbone 相关代码 +│ │ │ ├── det_mobilenet_v3.py // 检测 mobilenet_v3 +│ │ │ ├── det_resnet_vd.py // 检测 resnet +│ │ │ ├── rec_mobilenet_v3.py // 识别 mobilenet_v3 +│ │ │ └── rec_resnet_vd.py // 识别 resnet +│ │ ├── necks // 颈函数 +│ │ │ ├── __init__.py // 构造 neck 相关代码 +│ │ │ ├── db_fpn.py // fpn 网络 +│ │ │ ├── rnn.py // 识别 序列编码 +│ │ ├── heads // 头函数 +│ │ │ ├── __init__.py // 构造 head 相关代码 +│ │ │ ├── cls_head.py // 方向分类器 分类头 +│ │ │ ├── det_db_head.py // db 检测头 +│ │ │ ├── rec_ctc_head.py // 识别 ctc +│ │ ├── transforms // 图像变换 +│ │ │ ├── __init__.py // 构造 transform 相关代码 +│ │ │ └── tps.py // TPS 变换 +│ ├── optimizer // 优化器 +│ │ ├── __init__.py // 构造 optimizer 相关代码 +│ │ └── learning_rate.py // 学习率衰减 +│ │ └── optimizer.py // 优化器 +│ │ └── regularizer.py // 网络正则化 +│ ├── postprocess // 后处理 +│ │ ├── cls_postprocess.py // 方向分类器 后处理 +│ │ ├── db_postprocess.py // DB 后处理 +│ │ └── rec_postprocess.py // 识别网络 后处理 +│ └── utils // 工具 +│ ├── dict // 小语种字典 +│ .... +│ ├── ic15_dict.txt // 英文数字字典,区分大小写 +│ ├── ppocr_keys_v1.txt // 中文字典,用于训练中文模型 +│ ├── logging.py // logger +│ ├── save_load.py // 模型保存和加载函数 +│ ├── stats.py // 统计 +│ └── utility.py // 工具函数 +├── tools +│ ├── eval.py // 评估函数 +│ ├── export_model.py // 导出 inference 模型 +│ ├── infer // 基于预测引擎预测 +│ │ ├── predict_cls.py +│ │ ├── predict_det.py +│ │ ├── predict_rec.py +│ │ ├── predict_system.py +│ │ └── utility.py +│ ├── infer_cls.py // 基于训练引擎 预测分类 +│ ├── infer_det.py // 基于训练引擎 预测检测 +│ ├── infer_rec.py // 基于训练引擎 预测识别 +│ ├── program.py // 整体流程 +│ ├── test_hubserving.py +│ └── train.py // 启动训练 +├── paddleocr.py +├── README_ch.md // 中文说明文档 +├── README_en.md // 英文说明文档 +├── README.md // 主页说明文档 +├── requirments.txt // 安装依赖 +├── setup.py // whl包打包脚本 +├── train.sh // 启动训练脚本 \ No newline at end of file diff --git a/doc/doc_en/tree_en.md b/doc/doc_en/tree_en.md index 8f05de7e76b243bdcc6358bfea4e153e769dd3d5..1c32c92c0b01ea2fbf724cbcc89806c8c664e034 100644 --- a/doc/doc_en/tree_en.md +++ b/doc/doc_en/tree_en.md @@ -2,40 +2,37 @@ The overall directory structure of PaddleOCR is introduced as follows: + ``` PaddleOCR -├── configs // configuration file, you can select model structure and modify hyperparameters through yml file -│ ├── cls // Related configuration files of direction classifier -│ │ ├── cls_mv3.yml // training configuration related, including backbone network, head, loss, optimizer -│ │ └── cls_reader.yml // Data reading related, data reading method, data storage path -│ ├── det // Detection related configuration files -│ │ ├── det_db_icdar15_reader.yml // data read -│ │ ├── det_mv3_db.yml // training configuration +├── configs // Configuration file, you can config the model structure and modify the hyperparameters through the yml file +│ ├── cls // Angle classifier config files +│ │ ├── cls_mv3.yml // Training config, including backbone network, head, loss, optimizer and data +│ ├── det // Text detection config files +│ │ ├── det_mv3_db.yml // Training config │ │ ... -│ └── rec // Identify related configuration files -│ ├── rec_benchmark_reader.yml // LMDB format data reading related -│ ├── rec_chinese_common_train.yml // General Chinese training configuration -│ ├── rec_icdar15_reader.yml // simple data reading related, including data reading function, data path, label file +│ └── rec // Text recognition config files +│ ├── rec_mv3_none_bilstm_ctc.yml // CRNN config │ ... -├── deploy // deployment related -│ ├── android_demo // android_demo +├── deploy // Depoly +│ ├── android_demo // Android demo │ │ ... -│ ├── cpp_infer // C++ infer -│ │ ├── CMakeLists.txt // Cmake file -│ │ ├── docs // documentation +│ ├── cpp_infer // C++ infer +│ │ ├── CMakeLists.txt // Cmake file +│ │ ├── docs // Docs │ │ │ └── windows_vs2019_build.md -│ │ ├── include -│ │ │ ├── clipper.h // clipper library -│ │ │ ├── config.h // infer configuration -│ │ │ ├── ocr_cls.h // direction classifier -│ │ │ ├── ocr_det.h // text detection -│ │ │ ├── ocr_rec.h // text recognition -│ │ │ ├── postprocess_op.h // postprocess after detection -│ │ │ ├── preprocess_op.h // preprocess detection -│ │ │ └── utility.h // tools -│ │ ├── readme.md // documentation +│ │ ├── include // Head Files +│ │ │ ├── clipper.h // clipper +│ │ │ ├── config.h // Inference config +│ │ │ ├── ocr_cls.h // Angle class +│ │ │ ├── ocr_det.h // Text detection +│ │ │ ├── ocr_rec.h // Text recognition +│ │ │ ├── postprocess_op.h // Post-processing +│ │ │ ├── preprocess_op.h // Pre-processing +│ │ │ └── utility.h // tools +│ │ ├── readme.md // Documentation │ │ ├── ... -│ │ ├── src // source file +│ │ ├── src // Source code files │ │ │ ├── clipper.cpp │ │ │ ├── config.cpp │ │ │ ├── main.cpp @@ -45,10 +42,10 @@ PaddleOCR │ │ │ ├── postprocess_op.cpp │ │ │ ├── preprocess_op.cpp │ │ │ └── utility.cpp -│ │ └── tools // compile and execute script -│ │ ├── build.sh // compile script -│ │ ├── config.txt // configuration file -│ │ └── run.sh // Test startup script +│ │ └── tools // Compile and execute script +│ │ ├── build.sh // Compile script +│ │ ├── config.txt // Config file +│ │ └── run.sh // Execute script │ ├── docker │ │ └── hubserving │ │ ├── cpu @@ -58,151 +55,151 @@ PaddleOCR │ │ ├── README_cn.md │ │ ├── README.md │ │ └── sample_request.txt -│ ├── hubserving // hubserving -│ │ ├── ocr_det // text detection -│ │ │ ├── config.json // serving configuration +│ ├── hubserving // hubserving +│ │ ├── ocr_cls // Angle class +│ │ │ ├── config.json // Serving config +│ │ │ ├── __init__.py +│ │ │ ├── module.py // Model +│ │ │ └── params.py // Parameters +│ │ ├── ocr_det // Text detection +│ │ │ ├── config.json // serving config │ │ │ ├── __init__.py -│ │ │ ├── module.py // prediction model -│ │ │ └── params.py // prediction parameters -│ │ ├── ocr_rec // text recognition +│ │ │ ├── module.py // Model +│ │ │ └── params.py // Parameters +│ │ ├── ocr_rec // Text recognition │ │ │ ├── config.json │ │ │ ├── __init__.py │ │ │ ├── module.py │ │ │ └── params.py -│ │ └── ocr_system // system forecast +│ │ └── ocr_system // Inference System │ │ ├── config.json │ │ ├── __init__.py │ │ ├── module.py │ │ └── params.py -│ ├── imgs // prediction picture +│ ├── imgs // Inference images │ │ ├── cpp_infer_pred_12.png │ │ └── demo.png -│ ├── ios_demo // ios demo +│ ├── ios_demo // IOS demo │ │ ... -│ ├── lite // lite deployment -│ │ ├── cls_process.cc // direction classifier data processing +│ ├── lite // Lite depoly +│ │ ├── cls_process.cc // Pre-process for angle class │ │ ├── cls_process.h -│ │ ├── config.txt // check configuration parameters -│ │ ├── crnn_process.cc // crnn data processing +│ │ ├── config.txt // Config file +│ │ ├── crnn_process.cc // Pre-process for CRNN │ │ ├── crnn_process.h -│ │ ├── db_post_process.cc // db data processing +│ │ ├── db_post_process.cc // Pre-process for DB │ │ ├── db_post_process.h -│ │ ├── Makefile // compile file -│ │ ├── ocr_db_crnn.cc // series prediction -│ │ ├── prepare.sh // data preparation -│ │ ├── readme.md // documentation +│ │ ├── Makefile // Compile file +│ │ ├── ocr_db_crnn.cc // Inference system +│ │ ├── prepare.sh // Prepare bash script +│ │ ├── readme.md // Documentation │ │ ... -│ ├── pdserving // pdserving deployment -│ │ ├── det_local_server.py // fast detection version, easy deployment and fast prediction -│ │ ├── det_web_server.py // Full version of detection, high stability and distributed deployment -│ │ ├── ocr_local_server.py // detection + identification quick version -│ │ ├── ocr_web_client.py // client -│ │ ├── ocr_web_server.py // detection + identification full version -│ │ ├── readme.md // documentation -│ │ ├── rec_local_server.py // recognize quick version -│ │ └── rec_web_server.py // Identify the full version +│ ├── pdserving // Pdserving depoly +│ │ ├── det_local_server.py // Text detection fast version, easy to deploy and fast to predict +│ │ ├── det_web_server.py // Text detection full version, high stability distributed deployment +│ │ ├── ocr_local_server.py // Text detection + recognition fast version +│ │ ├── ocr_web_client.py // client +│ │ ├── ocr_web_server.py // Text detection + recognition full version +│ │ ├── readme.md // Documentation +│ │ ├── rec_local_server.py // Text recognition fast version +│ │ └── rec_web_server.py // Text recognition full version │ └── slim -│ └── quantization // quantization related -│ ├── export_model.py // export model -│ ├── quant.py // quantization -│ └── README.md // Documentation -├── doc // Documentation tutorial +│ └── quantization // Quantization +│ ├── export_model.py // Export model +│ ├── quant.py // Quantization script +│ └── README.md // Documentation +├── doc // Documentation and Tutorials │ ... -├── paddleocr.py -├── ppocr // network core code -│ ├── data // data processing -│ │ ├── cls // direction classifier -│ │ │ ├── dataset_traversal.py // Data transmission, define data reader, read data and form batch -│ │ │ └── randaugment.py // Random data augmentation operation -│ │ ├── det // detection -│ │ │ ├── data_augment.py // data augmentation operation -│ │ │ ├── dataset_traversal.py // Data transmission, define data reader, read data and form batch -│ │ │ ├── db_process.py // db data processing -│ │ │ ├── east_process.py // east data processing -│ │ │ ├── make_border_map.py // Generate boundary map -│ │ │ ├── make_shrink_map.py // Generate shrink map -│ │ │ ├── random_crop_data.py // random crop -│ │ │ └── sast_process.py // sast data processing -│ │ ├── reader_main.py // main function of data reader -│ │ └── rec // recognation -│ │ ├── dataset_traversal.py // Data transmission, define data reader, including LMDB_Reader and Simple_Reader -│ │ └── img_tools.py // Data processing related, including data normalization and disturbance -│ ├── __init__.py -│ ├── modeling // networking related -│ │ ├── architectures // Model architecture, which defines the various modules required by the model -│ │ │ ├── cls_model.py // direction classifier -│ │ │ ├── det_model.py // detection -│ │ │ └── rec_model.py // recognition -│ │ ├── backbones // backbone network -│ │ │ ├── det_mobilenet_v3.py // detect mobilenet_v3 -│ │ │ ├── det_resnet_vd.py -│ │ │ ├── det_resnet_vd_sast.py -│ │ │ ├── rec_mobilenet_v3.py // recognize mobilenet_v3 -│ │ │ ├── rec_resnet_fpn.py -│ │ │ └── rec_resnet_vd.py -│ │ ├── common_functions.py // common functions -│ │ ├── heads -│ │ │ ├── cls_head.py // class header -│ │ │ ├── det_db_head.py // db detection head -│ │ │ ├── det_east_head.py // east detection head -│ │ │ ├── det_sast_head.py // sast detection head -│ │ │ ├── rec_attention_head.py // recognition attention -│ │ │ ├── rec_ctc_head.py // recognition ctc -│ │ │ ├── rec_seq_encoder.py // recognition sequence code -│ │ │ ├── rec_srn_all_head.py // srn related -│ │ │ └── self_attention // srn attention -│ │ │ └── model.py -│ │ ├── losses // loss function -│ │ │ ├── cls_loss.py // Directional classifier loss function -│ │ │ ├── det_basic_loss.py // detect basic loss -│ │ │ ├── det_db_loss.py // DB loss -│ │ │ ├── det_east_loss.py // EAST loss -│ │ │ ├── det_sast_loss.py // SAST loss -│ │ │ ├── rec_attention_loss.py // attention loss -│ │ │ ├── rec_ctc_loss.py // ctc loss -│ │ │ └── rec_srn_loss.py // srn loss -│ │ └── stns // Spatial transformation network -│ │ └── tps.py // TPS conversion -│ ├── optimizer.py // optimizer -│ ├── postprocess // post-processing -│ │ ├── db_postprocess.py // DB postprocess -│ │ ├── east_postprocess.py // East postprocess -│ │ ├── lanms // lanms related -│ │ │ ... -│ │ ├── locality_aware_nms.py // nms -│ │ └── sast_postprocess.py // sast post-processing -│ └── utils // tools -│ ├── character.py // Character processing, including text encoding and decoding, and calculation of prediction accuracy -│ ├── check.py // parameter loading check -│ ├── ic15_dict.txt // English number dictionary, case sensitive -│ ├── ppocr_keys_v1.txt // Chinese dictionary, used to train Chinese models -│ ├── save_load.py // model save and load function -│ ├── stats.py // Statistics -│ └── utility.py // Tool functions, including related check tools such as whether the input parameters are legal -├── README_en.md // documentation -├── README.md -├── requirments.txt // installation dependencies -├── setup.py // whl package packaging script -└── tools // start tool - ├── eval.py // evaluation function - ├── eval_utils // evaluation tools - │ ├── eval_cls_utils.py // category related - │ ├── eval_det_iou.py // detect iou related - │ ├── eval_det_utils.py // detection related - │ ├── eval_rec_utils.py // recognition related - │ └── __init__.py - ├── export_model.py // export infer model - ├── infer // Forecast based on prediction engine - │ ├── predict_cls.py - │ ├── predict_det.py - │ ├── predict_rec.py - │ ├── predict_system.py - │ └── utility.py - ├── infer_cls.py // Predict classification based on training engine - ├── infer_det.py // Predictive detection based on training engine - ├── infer_rec.py // Predictive recognition based on training engine - ├── program.py // overall process - ├── test_hubserving.py - └── train.py // start training - -``` +├── ppocr // Core code +│ ├── data // Data processing +│ │ ├── imaug // Image and label processing code +│ │ │ ├── text_image_aug // Tia data augment for text recognition +│ │ │ │ ├── __init__.py +│ │ │ │ ├── augment.py // Tia_distort,tia_stretch and tia_perspective +│ │ │ │ ├── warp_mls.py +│ │ │ ├── __init__.py +│ │ │ ├── iaa_augment.py // Data augmentation operations +│ │ │ ├── label_ops.py // label encode operations +│ │ │ ├── make_border_map.py // Generate boundary map +│ │ │ ├── make_shrink_map.py // Generate shrink graph +│ │ │ ├── operators.py // Basic image operations, such as reading and normalization +│ │ │ ├── randaugment.py // Random data augmentation operation +│ │ │ ├── random_crop_data.py // Random crop +│ │ │ └── rec_img_aug.py // Data augmentation for text recognition +│ │ ├── __init__.py // Construct dataloader code +│ │ ├── lmdb_dataset.py // Read lmdb dataset +│ │ ├── simple_dataset.py // Read the dataset stored in text format +│ ├── losses // Loss function +│ │ ├── __init__.py // Construct loss code +│ │ ├── cls_loss.py // Angle class loss +│ │ ├── det_basic_loss.py // Text detection basic loss +│ │ ├── det_db_loss.py // DB loss +│ │ ├── rec_ctc_loss.py // ctc loss +│ ├── metrics // Metrics +│ │ ├── __init__.py // Construct metric code +│ │ ├── cls_metric.py // Angle class metric +│ │ ├── det_metric.py // Text detection metric + │ ├── eval_det_iou.py // Text detection iou code +│ │ ├── rec_metric.py // Text recognition metric +│ ├── modeling // Network +│ │ ├── architectures // Architecture +│ │ │ ├── __init__.py // Construct model code +│ │ │ ├── base_model.py // Base model +│ │ ├── backbones // backbones +│ │ │ ├── __init__.py // Construct backbone code +│ │ │ ├── det_mobilenet_v3.py // Text detection mobilenet_v3 +│ │ │ ├── det_resnet_vd.py // Text detection resnet +│ │ │ ├── rec_mobilenet_v3.py // Text recognition mobilenet_v3 +│ │ │ └── rec_resnet_vd.py // Text recognition resnet +│ │ ├── necks // Necks +│ │ │ ├── __init__.py // Construct neck code +│ │ │ ├── db_fpn.py // FPN +│ │ │ ├── rnn.py // Character recognition sequence encoding +│ │ ├── heads // Heads +│ │ │ ├── __init__.py // Construct head code +│ │ │ ├── cls_head.py // Angle class head +│ │ │ ├── det_db_head.py // DB head +│ │ │ ├── rec_ctc_head.py // Ctc head +│ │ ├── transforms // Transforms +│ │ │ ├── __init__.py // Construct transform code +│ │ │ └── tps.py // TPS transform +│ ├── optimizer // Optimizer +│ │ ├── __init__.py // Construct optimizer code +│ │ └── learning_rate.py // Learning rate decay +│ │ └── optimizer.py // Optimizer +│ │ └── regularizer.py // Network regularization +│ ├── postprocess // Post-processing +│ │ ├── cls_postprocess.py // Angle class post-processing +│ │ ├── db_postprocess.py // DB post-processing +│ │ └── rec_postprocess.py // Text recognition post-processing +│ └── utils // utils +│ ├── dict // Minor language dictionary +│ .... +│ ├── ic15_dict.txt // English number dictionary, case sensitive +│ ├── ppocr_keys_v1.txt // Chinese dictionary for training Chinese models +│ ├── logging.py // logger +│ ├── save_load.py // Model saving and loading functions +│ ├── stats.py // Training status statistics +│ └── utility.py // Utility function +├── tools +│ ├── eval.py // Evaluation function +│ ├── export_model.py // Export inference model +│ ├── infer // Inference based on Inference engine +│ │ ├── predict_cls.py +│ │ ├── predict_det.py +│ │ ├── predict_rec.py +│ │ ├── predict_system.py +│ │ └── utility.py +│ ├── infer_cls.py // Angle classification inference based on training engine +│ ├── infer_det.py // Text detection inference based on training engine +│ ├── infer_rec.py // Text recognition inference based on training engine +│ ├── program.py // Inference system +│ ├── test_hubserving.py +│ └── train.py // Start training script +├── paddleocr.py +├── README_ch.md // Chinese documentation +├── README_en.md // English documentation +├── README.md // Home page documentation +├── requirments.txt // Requirments +├── setup.py // Whl package packaging script +├── train.sh // Start training bash script \ No newline at end of file