diff --git a/doc/doc_ch/tree.md b/doc/doc_ch/tree.md new file mode 100644 index 0000000000000000000000000000000000000000..f730d8f01fae467f49a03d68d931eb4fda526626 --- /dev/null +++ b/doc/doc_ch/tree.md @@ -0,0 +1,208 @@ +# 整体目录结构 + +PaddleOCR 的整体目录结构介ç»å¦‚下: + +``` +PaddleOCR +├── configs // é…置文件,å¯é€šè¿‡ymlæ–‡ä»¶é€‰æ‹©æ¨¡åž‹ç»“æž„å¹¶ä¿®æ”¹è¶…å‚ +│ ├── cls // æ–¹å‘分类器相关é…置文件 +│ │ ├── cls_mv3.yml // è®ç»ƒé…置相关,包括骨干网络ã€headã€lossã€ä¼˜åŒ–器 +│ │ └── cls_reader.yml // æ•°æ®è¯»å–相关,数æ®è¯»å–æ–¹å¼ã€æ•°æ®å˜å‚¨è·¯å¾„ +│ ├── det // 检测相关é…置文件 +│ │ ├── det_db_icdar15_reader.yml // æ•°æ®è¯»å– +│ │ ├── det_mv3_db.yml // è®ç»ƒé…ç½® +│ │ ... +│ └── rec // 识别相关é…置文件 +│ ├── rec_benchmark_reader.yml // LMDB æ ¼å¼æ•°æ®è¯»å–相关 +│ ├── rec_chinese_common_train.yml // 通用ä¸æ–‡è®ç»ƒé…ç½® +│ ├── rec_icdar15_reader.yml // simple æ•°æ®è¯»å–相关,包括数æ®è¯»å–函数ã€æ•°æ®è·¯å¾„ã€æ ‡ç¾æ–‡ä»¶ +│ ... +├── deploy // 部署相关 +│ ├── android_demo // android_demo +│ │ ... +│ ├── 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 // 说明文档 +│ │ ├── ... +│ │ ├── src // æºæ–‡ä»¶ +│ │ │ ├── clipper.cpp +│ │ │ ├── config.cpp +│ │ │ ├── main.cpp +│ │ │ ├── ocr_cls.cpp +│ │ │ ├── ocr_det.cpp +│ │ │ ├── ocr_rec.cpp +│ │ │ ├── postprocess_op.cpp +│ │ │ ├── preprocess_op.cpp +│ │ │ └── utility.cpp +│ │ └── tools // 编译ã€æ‰§è¡Œè„šæœ¬ +│ │ ├── build.sh // 编译脚本 +│ │ ├── config.txt // é…置文件 +│ │ └── run.sh // 测试å¯åŠ¨è„šæœ¬ +│ ├── docker +│ │ └── hubserving +│ │ ├── cpu +│ │ │ └── Dockerfile +│ │ ├── gpu +│ │ │ └── Dockerfile +│ │ ├── README_cn.md +│ │ ├── README.md +│ │ └── sample_request.txt +│ ├── hubserving // hubserving +│ │ ├── ocr_det // æ–‡å—检测 +│ │ │ ├── config.json // serving é…ç½® +│ │ │ ├── __init__.py +│ │ │ ├── module.py // 预测模型 +│ │ │ └── params.py // 预测å‚æ•° +│ │ ├── ocr_rec // æ–‡å—识别 +│ │ │ ├── config.json +│ │ │ ├── __init__.py +│ │ │ ├── module.py +│ │ │ └── params.py +│ │ └── ocr_system // 系统预测 +│ │ ├── config.json +│ │ ├── __init__.py +│ │ ├── module.py +│ │ └── params.py +│ ├── imgs // 预测图片 +│ │ ├── cpp_infer_pred_12.png +│ │ └── demo.png +│ ├── ios_demo // ios demo +│ │ ... +│ ├── lite // lite 部署 +│ │ ├── cls_process.cc // æ–¹å‘分类器数æ®å¤„ç† +│ │ ├── cls_process.h +│ │ ├── config.txt // 检测é…ç½®å‚æ•° +│ │ ├── crnn_process.cc // crnnæ•°æ®å¤„ç† +│ │ ├── crnn_process.h +│ │ ├── db_post_process.cc // dbæ•°æ®å¤„ç† +│ │ ├── db_post_process.h +│ │ ├── 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 // 识别 完整版 +│ └── slim +│ └── 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 // å¯åŠ¨è®ç»ƒ + +```