├── .github ├── ISSUE_TEMPLATE │ ├── bug.md │ └── config.yml └── workflows │ └── gen_whl_to_pypi.yml ├── .gitignore ├── .pre-commit-config.yaml ├── LICENSE ├── README.md ├── demo.py ├── docs └── docs_whl.md ├── paddleocr_convert ├── __init__.py ├── main.py └── utils.py ├── requirements.txt ├── setup.py └── tests └── test_convert.py /.github/ISSUE_TEMPLATE/bug.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: 🐞 Bug 3 | about: Bug 4 | title: 'Bug' 5 | labels: 'Bug' 6 | assignees: '' 7 | 8 | --- 9 | 10 | > [!NOTE] 11 | > 请提供下述完整信息以便快速定位问题 12 | > Please provide the following information to quickly locate the problem 13 | 14 | **系统环境 (System Environment)** : 15 | 16 | **使用的是哪门语言的程序 (Which programing language)** : 17 | 18 | **所使用语言相关版本信息 (Version)** : 19 | 20 | **使用当前库的版本 (Use current version)** : 21 | 22 | **可复现问题的demo和文件 (Demo of reproducible problems)** : 23 | 24 | **完整报错 (Complete Error Message)** : 25 | 26 | **可能的解决方案 (Possible solutions)** : 27 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: ❓ Questions 4 | url: https://github.com/RapidAI/PaddleOCRModelConvert/discussions/categories/q-a 5 | about: Please use the community forum for help and questions regarding PaddleOCRModelConvert. 6 | - name: 💡 Feature requests and ideas 7 | url: https://github.com/RapidAI/PaddleOCRModelConvert/discussions/categories/ideas 8 | about: Please vote for and post new feature ideas in the community forum. 9 | - name: 📖 Documentation 10 | url: https://github.com/RapidAI/PaddleOCRModelConvert#usage 11 | about: A great place to find instructions and answers about PaddleOCRModelConvert. 12 | -------------------------------------------------------------------------------- /.github/workflows/gen_whl_to_pypi.yml: -------------------------------------------------------------------------------- 1 | name: Push paddleocr_convert to pypi 2 | 3 | on: 4 | push: 5 | # branches: [ main ] 6 | # paths: 7 | # - 'paddleocr_convert/**' 8 | # - 'docs/doc_whl.md' 9 | # - 'setup.py' 10 | # - '.github/workflows/gen_whl_to_pypi.yml' 11 | tags: 12 | - v* 13 | 14 | jobs: 15 | UnitTesting: 16 | runs-on: ubuntu-latest 17 | steps: 18 | - name: Pull latest code 19 | uses: actions/checkout@v3 20 | 21 | - name: Set up Python 3.7 22 | uses: actions/setup-python@v4 23 | with: 24 | python-version: '3.7' 25 | architecture: 'x64' 26 | 27 | - name: Unit testings 28 | run: | 29 | pip install -r requirements.txt 30 | pip install pytest 31 | pip install six 32 | pytest tests/test_*.py 33 | 34 | GenerateWHL_PushPyPi: 35 | needs: UnitTesting 36 | runs-on: ubuntu-latest 37 | 38 | steps: 39 | - uses: actions/checkout@v3 40 | 41 | - name: Set up Python 3.7 42 | uses: actions/setup-python@v4 43 | with: 44 | python-version: '3.7' 45 | architecture: 'x64' 46 | 47 | - name: Run setup.py 48 | run: | 49 | pip install -r requirements.txt 50 | pip install wheel get_pypi_latest_version setuptools 51 | 52 | python -m pip install --upgrade pip 53 | python setup.py bdist_wheel ${{ github.ref_name }} 54 | 55 | - name: Publish distribution 📦 to PyPI 56 | uses: pypa/gh-action-pypi-publish@v1.5.0 57 | with: 58 | password: ${{ secrets.UPLOAD_PYPI }} 59 | packages_dir: dist/ 60 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by .ignore support plugin (hsz.mobi) 2 | ### Python template 3 | # Byte-compiled / optimized / DLL files 4 | __pycache__/ 5 | *.py[cod] 6 | *$py.class 7 | .pytest_cache 8 | 9 | # C extensions 10 | *.so 11 | 12 | # Distribution / packaging 13 | .Python 14 | build/ 15 | develop-eggs/ 16 | dist/ 17 | downloads/ 18 | eggs/ 19 | .eggs/ 20 | lib/ 21 | lib64/ 22 | parts/ 23 | sdist/ 24 | var/ 25 | wheels/ 26 | pip-wheel-metadata/ 27 | share/python-wheels/ 28 | *.egg-info/ 29 | .installed.cfg 30 | *.egg 31 | MANIFEST 32 | 33 | # PyInstaller 34 | # Usually these files are written by a python script from a template 35 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 36 | # *.manifest 37 | # *.spec 38 | *.res 39 | 40 | # Installer logs 41 | pip-log.txt 42 | pip-delete-this-directory.txt 43 | 44 | # Unit test / coverage reports 45 | htmlcov/ 46 | .tox/ 47 | .nox/ 48 | .coverage 49 | .coverage.* 50 | .cache 51 | nosetests.xml 52 | coverage.xml 53 | *.cover 54 | *.py,cover 55 | .hypothesis/ 56 | .pytest_cache/ 57 | 58 | # Translations 59 | *.mo 60 | *.pot 61 | 62 | # Django stuff: 63 | *.log 64 | local_settings.py 65 | db.sqlite3 66 | db.sqlite3-journal 67 | 68 | # Flask stuff: 69 | instance/ 70 | .webassets-cache 71 | 72 | # Scrapy stuff: 73 | .scrapy 74 | 75 | # Sphinx documentation 76 | docs/_build/ 77 | 78 | # PyBuilder 79 | target/ 80 | 81 | # Jupyter Notebook 82 | .ipynb_checkpoints 83 | 84 | # IPython 85 | profile_default/ 86 | ipython_config.py 87 | 88 | # pyenv 89 | .python-version 90 | 91 | # pipenv 92 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 93 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 94 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 95 | # install all needed dependencies. 96 | #Pipfile.lock 97 | 98 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 99 | __pypackages__/ 100 | 101 | # Celery stuff 102 | celerybeat-schedule 103 | celerybeat.pid 104 | 105 | # SageMath parsed files 106 | *.sage.py 107 | 108 | # Environments 109 | .env 110 | .venv 111 | env/ 112 | venv/ 113 | ENV/ 114 | env.bak/ 115 | venv.bak/ 116 | 117 | # Spyder project settings 118 | .spyderproject 119 | .spyproject 120 | 121 | # Rope project settings 122 | .ropeproject 123 | 124 | # mkdocs documentation 125 | /site 126 | 127 | # mypy 128 | .mypy_cache/ 129 | .dmypy.json 130 | dmypy.json 131 | 132 | # Pyre type checker 133 | .pyre/ 134 | 135 | #idea 136 | .vs 137 | .vscode 138 | .idea 139 | /images 140 | /models 141 | 142 | #models 143 | *.onnx 144 | 145 | *.ttf 146 | *.ttc 147 | 148 | long1.jpg 149 | 150 | *.bin 151 | *.mapping 152 | *.xml 153 | 154 | *.pdiparams 155 | *.pdiparams.info 156 | *.pdmodel 157 | 158 | .DS_Store 159 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://gitee.com/SWHL/autoflake 3 | rev: v2.1.1 4 | hooks: 5 | - id: autoflake 6 | args: 7 | [ 8 | "--recursive", 9 | "--in-place", 10 | "--remove-all-unused-imports", 11 | "--remove-unused-variable", 12 | "--ignore-init-module-imports", 13 | ] 14 | files: \.py$ 15 | - repo: https://gitee.com/SWHL/black 16 | rev: 23.1.0 17 | hooks: 18 | - id: black 19 | files: \.py$ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 |
3 |

🔄 PaddleOCR Model Convert

4 |
5 |
 
6 | 7 | 8 | 9 | 10 | PyPI 11 | 12 | SemVer2.0 13 | 14 |
15 | 16 | ### Introduction 17 | - This repository is mainly to convert [Inference Model in PaddleOCR](https://github.com/PaddlePaddle/PaddleOCR/blob/release/2.6/doc/doc_ch/models_list.md) into ONNX format. 18 | - **Input**: **url** or local **tar** path of inference model 19 | - **Output**: converted **ONNX** model 20 | - If it is a recognition model, you need to provide the original txt path of the corresponding dictionary (**Open the txt file in github, click the path after raw in the upper right corner, similar to [this](https://raw.githubusercontent.com/PaddlePaddle/PaddleOCR/release/2.6/ppocr/utils/ppocr_keys_v1.txt)**), used to write the dictionary into the ONNX model 21 | - ☆ It needs to be used with the relevant reasoning code in [RapidOCR](https://github.com/RapidAI/RapidOCR) 22 | - If you encounter a model that cannot be successfully converted, you can check which steps are wrong one by one according to the ideas in the figure below. 23 | 24 | 25 | ### Overall framework 26 | ```mermaid 27 | flowchart TD 28 | 29 | A([PaddleOCR inference model]) --paddle2onnx--> B([ONNX]) 30 | B --> C([Change Dynamic Input]) --> D([Rec: save the character dict to onnx]) 31 | D --> E([Save]) 32 | ``` 33 | 34 | ### Installation 35 | ```bash 36 | pip install paddleocr_convert 37 | ``` 38 | 39 | ### Usage 40 | > [!WARNING] 41 | > 42 | > Only support the **reasoning model** in the download address in [link](https://github.com/PaddlePaddle/PaddleOCR/blob/release/2.6/doc/doc_ch/models_list.md), if it is a training model, Manual conversion to inference format is required. 43 | > 44 | > The **slim quantized model** in PaddleOCR does not support conversion. 45 | 46 | #### Using the command line 47 | - Usage: 48 | ```bash 49 | $ paddleocr_convert -h 50 | usage: paddleocr_convert [-h] [-p MODEL_PATH] [-o SAVE_DIR] 51 | [-txt_path TXT_PATH] 52 | 53 | optional arguments: 54 | -h, --help show this help message and exit 55 | -p MODEL_PATH, --model_path MODEL_PATH 56 | The inference model url or local path of paddleocr. 57 | e.g. https://paddleocr.bj.bcebos.com/PP- 58 | OCRv3/chinese/ch_PP-OCRv3_det_infer.tar or 59 | models/ch_PP-OCRv3_det_infer.tar 60 | -o SAVE_DIR, --save_dir SAVE_DIR 61 | The directory of saving the model. 62 | -txt_path TXT_PATH, --txt_path TXT_PATH 63 | The raw txt url or local txt path, if the model is 64 | recognition model. 65 | ``` 66 | - Example: 67 | ```bash 68 | #online 69 | $ paddleocr_convert -p https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_det_infer.tar \ 70 | -o models 71 | 72 | $ paddleocr_convert -p https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_rec_infer.tar\ 73 | -o models\ 74 | -txt_path https://raw.githubusercontent.com/PaddlePaddle/PaddleOCR/release/2.6/ppocr/utils/ppocr_keys_v1.txt 75 | 76 | # offline 77 | $ paddleocr_convert -p models/ch_PP-OCRv3_det_infer.tar\ 78 | -o models 79 | 80 | $ paddleocr_convert -p models/ch_PP-OCRv3_rec_infer.tar\ 81 | -o models\ 82 | -txt_path models/ppocr_keys_v1.txt 83 | ``` 84 | 85 | #### Script use 86 | - online mode 87 | ```python 88 | from paddleocr_convert import PaddleOCRModelConvert 89 | 90 | converter = PaddleOCRModelConvert() 91 | save_dir = 'models' 92 | url = 'https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_rec_infer.tar' 93 | txt_url = 'https://raw.githubusercontent.com/PaddlePaddle/PaddleOCR/release/2.6/ppocr/utils/ppocr_keys_v1.txt' 94 | 95 | converter(url, save_dir, txt_path=txt_url) 96 | ``` 97 | - offline mode 98 | ```python 99 | from paddleocr_convert import PaddleOCRModelConvert 100 | 101 | converter = PaddleOCRModelConvert() 102 | save_dir = 'models' 103 | model_path = 'models/ch_PP-OCRv3_rec_infer.tar' 104 | txt_path = 'models/ppocr_keys_v1.txt' 105 | converter(model_path, save_dir, txt_path=txt_path) 106 | ``` 107 | 108 | ### Use the model 109 | Assuming that the model needs to be recognized in Japanese, and it has been converted, the path is `local/models/japan.onnx` 110 | 111 | 1. Install `rapidocr_onnxruntime` library 112 | ```bash 113 | pip install rapidocr_onnxruntime 114 | ``` 115 | 2. Script use 116 | ```python 117 | from rapidocr_onnxruntime import RapidOCR 118 | 119 | model_path = 'local/models/japan.onnx' 120 | engine = RapidOCR(rec_model_path=model_path) 121 | 122 | img = '1.jpg' 123 | result, elapse = engine(img) 124 | ``` 125 | 3. CLI use 126 | ```bash 127 | rapidocr_onnxruntime -img 1.jpg --rec_model_path local/models/japan.onnx 128 | ``` 129 | 130 | ### Changelog 131 | 132 |
133 | Click to expand 134 | 135 | - 2023-09-22 v0.0.17 update: 136 | - Improve the log when meets the error. 137 | - 2023-07-27 v0.0.16 update: 138 | - Added the online conversion version of ModelScope. 139 | - Change python version from python 3.6 ~ 3.11. 140 | - 2023-04-13 update: 141 | - Add online conversion program [link](https://huggingface.co/spaces/SWHL/PaddleOCRModelConverter) 142 | - 2023-03-05 v0.0.4~7 update: 143 | - Support transliteration of local models and dictionaries 144 | - Optimize internal logic and error feedback 145 | - 2023-02-28 v0.0.3 update: 146 | - Added setting to automatically change to dynamic input for models that are not dynamic input 147 | - 2023-02-27 v0.0.2 update: 148 | - Encapsulate the conversion model code into a package, which is convenient for self-help model conversion 149 | - 2022-08-15 v0.0.1 update: 150 | - Write the dictionary of the recognition model into the meta in the onnx model for subsequent distribution. 151 | 152 |
153 | -------------------------------------------------------------------------------- /demo.py: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # @Author: SWHL 3 | # @Contact: liekkaskono@163.com 4 | from paddleocr_convert import PaddleOCRModelConvert 5 | 6 | 7 | converter = PaddleOCRModelConvert() 8 | 9 | # converter('ch_PP-OCRv3_det_infer.tar', save_dir) 10 | 11 | # url = 'https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_det_infer.tar' 12 | 13 | # url = 'https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_mobile_v2.0_cls_infer.tar' 14 | 15 | url = 'https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_rec_infer.tar' 16 | 17 | save_dir = 'models' 18 | txt_path = 'https://gitee.com/paddlepaddle/PaddleOCR/raw/release/2.6/ppocr/utils/ppocr_keys_v1.txt' 19 | 20 | converter(url, save_dir, txt_path=txt_path, is_del_raw=True) 21 | -------------------------------------------------------------------------------- /docs/docs_whl.md: -------------------------------------------------------------------------------- 1 | ## paddleocr_convert 2 |

3 | 4 | 5 | 6 | 7 | PyPI 8 | 9 | paddleocr_convert documentation 10 |

11 | 12 | ### 1. Install package by pypi. 13 | ```bash 14 | pip install paddleocr_convert 15 | ``` 16 | 17 | ### 2. Run by command line. 18 | - Usage: 19 | ```bash 20 | $ paddleocr_convert -h 21 | usage: paddleocr_convert [-h] [-p MODEL_PATH] [-o SAVE_DIR] 22 | [-txt_path TXT_PATH] 23 | 24 | optional arguments: 25 | -h, --help show this help message and exit 26 | -p MODEL_PATH, --model_path MODEL_PATH 27 | The inference model url or local path of paddleocr. 28 | e.g. https://paddleocr.bj.bcebos.com/PP- 29 | OCRv3/chinese/ch_PP-OCRv3_det_infer.tar or 30 | models/ch_PP-OCRv3_det_infer.tar 31 | -o SAVE_DIR, --save_dir SAVE_DIR 32 | The directory of saving the model. 33 | -txt_path TXT_PATH, --txt_path TXT_PATH 34 | The raw txt url or local txt path, if the model is 35 | recognition model. 36 | ``` 37 | - Example: 38 | ```bash 39 | # online 40 | $ paddleocr_convert -p https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_det_infer.tar \ 41 | -o models 42 | 43 | $ paddleocr_convert -p https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_rec_infer.tar \ 44 | -o models \ 45 | -txt_path https://raw.githubusercontent.com/PaddlePaddle/PaddleOCR/release/2.6/ppocr/utils/ppocr_keys_v1.txt 46 | 47 | # offline 48 | $ paddleocr_convert -p models/ch_PP-OCRv3_det_infer.tar \ 49 | -o models 50 | 51 | $ paddleocr_convert -p models/ch_PP-OCRv3_rec_infer.tar \ 52 | -o models \ 53 | -txt_path models/ppocr_keys_v1.txt 54 | ``` 55 | 56 | ### 3. Run by script. 57 | - online mode 58 | ```python 59 | from paddleocr_convert import PaddleOCRModelConvert 60 | 61 | converter = PaddleOCRModelConvert() 62 | 63 | save_dir = 'models' 64 | url = 'https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_rec_infer.tar' 65 | txt_url = 'https://raw.githubusercontent.com/PaddlePaddle/PaddleOCR/release/2.6/ppocr/utils/ppocr_keys_v1.txt' 66 | 67 | converter(url, save_dir, txt_path=txt_url) 68 | ``` 69 | - offline mode 70 | ```python 71 | from paddleocr_convert import PaddleOCRModelConvert 72 | 73 | converter = PaddleOCRModelConvert() 74 | 75 | save_dir = 'models' 76 | model_path = 'models/ch_PP-OCRv3_rec_infer.tar' 77 | txt_path = 'models/ppocr_keys_v1.txt' 78 | converter(model_path, save_dir, txt_path=txt_path) 79 | ``` 80 | 81 | ### See more details for [PaddleOCRModelConvert](https://github.com/RapidAI/PaddleOCRModelConvert). -------------------------------------------------------------------------------- /paddleocr_convert/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # @Author: SWHL 3 | # @Contact: liekkaskono@163.com 4 | from .main import PaddleOCRModelConvert 5 | from .utils import download_file 6 | -------------------------------------------------------------------------------- /paddleocr_convert/main.py: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # @Author: SWHL 3 | # @Contact: liekkaskono@163.com 4 | import argparse 5 | from pathlib import Path 6 | from subprocess import PIPE, STDOUT, Popen 7 | from typing import List, Optional, Union 8 | 9 | import onnx 10 | 11 | from .utils import InputType, download_file, is_http_url, unzip_file 12 | 13 | 14 | class PaddleOCRModelConvert: 15 | def __init__(self) -> None: 16 | self.opset = 14 17 | 18 | def __call__( 19 | self, 20 | model_path: InputType, 21 | save_dir: InputType, 22 | txt_path: Optional[str] = None, 23 | is_del_raw: bool = False, 24 | is_rec: Optional[bool] = None 25 | ) -> str: 26 | model_name = Path(model_path).stem 27 | 28 | if is_rec is None: 29 | is_rec = "rec" in model_name 30 | 31 | if is_rec and not txt_path: 32 | raise ConvertError("Please give the txt url.") 33 | 34 | model_path = self.get_file_path(model_path, save_dir) 35 | 36 | model_dir = unzip_file(model_path, save_dir, is_del_raw=is_del_raw) 37 | 38 | save_onnx_path = model_dir / f"{Path(model_path).stem}.onnx" 39 | try: 40 | self.convert_to_onnx(model_dir, save_onnx_path) 41 | except ConvertError as e: 42 | raise e 43 | 44 | print(f"Successfully convert model to {save_onnx_path}") 45 | 46 | try: 47 | self.change_to_dynamic(save_onnx_path) 48 | except Exception as e: 49 | raise ConvertError("change the model to dynamic meets error.") from e 50 | 51 | if is_rec: 52 | txt_path = self.get_file_path(txt_path, ".") 53 | character_dict = self.read_txt(txt_path) 54 | self.write_dict_to_onnx(save_onnx_path, character_dict) 55 | 56 | if is_del_raw: 57 | txt_path.unlink() 58 | 59 | print("The dict of recognition has been written to the onnx model.") 60 | return save_onnx_path 61 | 62 | @staticmethod 63 | def get_file_path(file_path: str, save_dir: InputType) -> str: 64 | """获得文件的本地路径，如果是url，则会自动下载到本地之后，再返回本地文件对应路径 65 | 66 | Args: 67 | file_path (str): url or 本地路径 68 | save_dir (InputType): 下载到本地的路径 69 | 70 | Raises: 71 | FileExistsError: 本地为存在该文件的异常 72 | 73 | Returns: 74 | str: 文件的本地路径 75 | """ 76 | if is_http_url(file_path): 77 | file_path = download_file(file_path, save_dir) 78 | 79 | if not Path(file_path).exists(): 80 | raise FileExistsError(f"{file_path} does not exist.") 81 | return file_path 82 | 83 | def convert_to_onnx(self, model_dir: str, save_onnx_path: str) -> None: 84 | """借助 :code:`paddle2onnx` 工具转换模型为onnx格式 85 | 86 | Args: 87 | model_dir (str): 保存paddle格式模型所在目录 88 | save_onnx_path (str): 保存的onnx全路径 89 | """ 90 | shell_str = ( 91 | f"paddle2onnx --model_dir {model_dir} " 92 | "--model_filename inference.pdmodel " 93 | "--params_filename inference.pdiparams " 94 | f"--opset_version {self.opset} " 95 | f"--save_file {save_onnx_path}" 96 | ) 97 | with Popen(shell_str, stdout=PIPE, stderr=STDOUT, shell=True) as proc: 98 | run_log = "\n".join([v.decode() for v in proc.stdout.readlines()]) 99 | 100 | failed_phrases = ["Failed to", "parsing failed", "convert failed", "Oops"] 101 | if self.is_contain(run_log, failed_phrases) or not save_onnx_path.exists(): 102 | raise ConvertError(run_log) 103 | 104 | def change_to_dynamic(self, onnx_path: Union[str, Path]) -> None: 105 | """更改onnx格式模型的指定为维度为动态输入 106 | 107 | Args: 108 | onnx_path (Union[str, Path]): onnx模型路径 109 | """ 110 | onnx_path = str(onnx_path) 111 | onnx_model = onnx.load_model(onnx_path) 112 | dim_shapes = onnx_model.graph.input[0].type.tensor_type.shape.ListFields()[0][1] 113 | 114 | dynamic_name = "DynamicDimension" 115 | if dynamic_name not in dim_shapes[0].dim_param: 116 | onnx_model.graph.input[0].type.tensor_type.shape.dim[0].dim_param = "None" 117 | 118 | if dynamic_name not in dim_shapes[2].dim_param: 119 | onnx_model.graph.input[0].type.tensor_type.shape.dim[2].dim_param = "?" 120 | 121 | if dynamic_name not in dim_shapes[3].dim_param: 122 | onnx_model.graph.input[0].type.tensor_type.shape.dim[3].dim_param = "?" 123 | 124 | print("The model has changed to dynamic inputs.") 125 | onnx.save(onnx_model, onnx_path) 126 | 127 | def write_dict_to_onnx(self, model_path: str, character_dict: str): 128 | """将文本识别模型对应的字典文件写入到onnx模型中 129 | 130 | Args: 131 | model_path (str): onnx模型路径 132 | character_dict (str): 字典列表 133 | """ 134 | model = onnx.load_model(str(model_path)) 135 | meta = model.metadata_props.add() 136 | meta.key = "character" 137 | meta.value = character_dict 138 | onnx.save_model(model, str(model_path)) 139 | 140 | @staticmethod 141 | def read_txt(txt_path: Union[str, Path]) -> str: 142 | """读取txt文件 143 | 144 | Args: 145 | txt_path (Union[str, Path]): 字典文件全路径 146 | 147 | Returns: 148 | str: 字典字符串 149 | """ 150 | with open(str(txt_path), "r", -1, "u8") as f: 151 | value = f.read() 152 | return value 153 | 154 | @staticmethod 155 | def is_contain( 156 | sentence: str, 157 | key_words: Union[str, List], 158 | ) -> bool: 159 | """sentences中是否包含key_words中任意一个""" 160 | return any(i in sentence for i in key_words) 161 | 162 | 163 | class ConvertError(Exception): 164 | pass 165 | 166 | 167 | def main(): 168 | parser = argparse.ArgumentParser() 169 | parser.add_argument( 170 | "-p", 171 | "--model_path", 172 | type=str, 173 | help="The inference model url or local path of paddleocr. e.g. https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_det_infer.tar or models/ch_PP-OCRv3_det_infer.tar", 174 | ) 175 | parser.add_argument( 176 | "-o", "--save_dir", type=str, help="The directory of saving the model." 177 | ) 178 | parser.add_argument( 179 | "-txt_path", 180 | "--txt_path", 181 | type=str, 182 | default=None, 183 | help="The raw txt url or local txt path, if the model is recognition model.", 184 | ) 185 | args = parser.parse_args() 186 | 187 | converter = PaddleOCRModelConvert() 188 | 189 | converter(args.model_path, args.save_dir, args.txt_path) 190 | 191 | 192 | if __name__ == "__main__": 193 | main() 194 | -------------------------------------------------------------------------------- /paddleocr_convert/utils.py: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # @Author: SWHL 3 | # @Contact: liekkaskono@163.com 4 | # github.com/PaddlePaddle/PaddleOCR/blob/release/2.6/ppocr/utils/network.py 5 | import re 6 | import tarfile 7 | from pathlib import Path 8 | from typing import Union 9 | 10 | import requests 11 | from tqdm import tqdm 12 | 13 | InputType = Union[str, Path] 14 | 15 | 16 | class DownloadModelError(Exception): 17 | pass 18 | 19 | 20 | def mkdir(dir_path: InputType): 21 | """创建目录 22 | 23 | Args: 24 | dir_path (Union[str, Path]): 路径地址 25 | """ 26 | Path(dir_path).mkdir(parents=True, exist_ok=True) 27 | 28 | 29 | def download_file(url: str, save_dir: InputType) -> Path: 30 | """下载指定url的文件 31 | 32 | Args: 33 | url (str): 文件url路径 34 | save_dir (InputType): 下载保存的目录 35 | 36 | Raises: 37 | DownloadModelError: 下载异常 38 | 39 | Returns: 40 | Path: 下载到本地的文件全路径 41 | """ 42 | mkdir(save_dir) 43 | 44 | response = requests.get(url, stream=True, timeout=(120, 120)) 45 | status_code = response.status_code 46 | 47 | if status_code != 200: 48 | raise DownloadModelError("Something went wrong while downloading models") 49 | 50 | total_size_in_bytes = int(response.headers.get("content-length", 1)) 51 | block_size = 1024 # 1 Kibibyte 52 | 53 | save_path = Path(save_dir) / Path(url).name 54 | with tqdm( 55 | total=total_size_in_bytes, unit="iB", unit_scale=True, desc="Downloading" 56 | ) as pb: 57 | with open(save_path, "wb") as file: 58 | for data in response.iter_content(block_size): 59 | pb.update(len(data)) 60 | file.write(data) 61 | return save_path 62 | 63 | 64 | def unzip_file(file_path: str, save_dir: InputType, is_del_raw: bool = True) -> Path: 65 | """解压下载得到的tar模型文件，会自动解压到save_dir下以file_path命名的目录下 66 | 67 | Args: 68 | file_path (str): tar格式文件路径 69 | save_dir (InputType): 解压路径 70 | is_del_raw (bool, optional): 是否删除原文件. Defaults to True. 71 | 72 | Returns: 73 | Path: 解压后模型保存路径 74 | """ 75 | model_dir = Path(save_dir) / Path(file_path).stem 76 | mkdir(model_dir) 77 | 78 | tar_file_name_list = [".pdiparams", ".pdiparams.info", ".pdmodel"] 79 | with tarfile.open(file_path, "r") as tarObj: 80 | for member in tarObj.getmembers(): 81 | filename = None 82 | 83 | for tar_file_name in tar_file_name_list: 84 | if member.name.endswith(tar_file_name): 85 | filename = "inference" + tar_file_name 86 | 87 | if filename is None: 88 | continue 89 | 90 | save_file_path = model_dir / filename 91 | file = tarObj.extractfile(member) 92 | with open(save_file_path, "wb") as f: 93 | f.write(file.read()) 94 | if is_del_raw: 95 | Path(file_path).unlink() 96 | print(f"The {file_path} has been deleted.") 97 | return model_dir 98 | 99 | 100 | def is_http_url(s: InputType) -> bool: 101 | """判断是否为url 102 | 103 | Args: 104 | s (InputType): 输入的字符串 105 | 106 | Returns: 107 | bool: 是或否 108 | """ 109 | regex = re.compile( 110 | r"^(?:http|ftp)s?://" # http:// or https:// 111 | # domain... 112 | r"(?:(?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+(?:[A-Z]{2,6}\.?|[A-Z0-9-]{2,}\.?)|" 113 | r"localhost|" # localhost... 114 | r"\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})" # ...or ip 115 | r"(?::\d+)?" # optional port 116 | r"(?:/?|[/?]\S+)$", 117 | re.IGNORECASE, 118 | ) 119 | 120 | if regex.match(str(s)): 121 | return True 122 | return False 123 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | onnx>=1.12.0 2 | requests>=2.27.1 3 | tqdm>=4.64.1 4 | paddle2onnx>=1.0.0 -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # @Author: SWHL 3 | # @Contact: liekkaskono@163.com 4 | import sys 5 | from pathlib import Path 6 | from typing import List 7 | 8 | import setuptools 9 | from get_pypi_latest_version import GetPyPiLatestVersion 10 | 11 | 12 | def read_txt(txt_path: str) -> List: 13 | if not isinstance(txt_path, str): 14 | txt_path = str(txt_path) 15 | 16 | with open(txt_path, "r", encoding="utf-8") as f: 17 | data = list(map(lambda x: x.rstrip("\n"), f)) 18 | return data 19 | 20 | 21 | def get_readme(): 22 | root_dir = Path(__file__).resolve().parent 23 | readme_path = str(root_dir / "docs" / "docs_whl.md") 24 | with open(readme_path, "r", encoding="utf-8") as f: 25 | readme = f.read() 26 | return readme 27 | 28 | 29 | MODULE_NAME = "paddleocr_convert" 30 | obtainer = GetPyPiLatestVersion() 31 | latest_version = obtainer(MODULE_NAME) 32 | VERSION_NUM = obtainer.version_add_one(latest_version) 33 | 34 | if len(sys.argv) > 2: 35 | match_str = " ".join(sys.argv[2:]) 36 | matched_versions = obtainer.extract_version(match_str) 37 | if matched_versions: 38 | VERSION_NUM = matched_versions 39 | 40 | sys.argv = sys.argv[:2] 41 | 42 | setuptools.setup( 43 | name=MODULE_NAME, 44 | version=VERSION_NUM, 45 | platforms="Any", 46 | description="Tool for converting the PaddleOCR model to onnx format.", 47 | long_description=get_readme(), 48 | long_description_content_type="text/markdown", 49 | author="SWHL", 50 | author_email="liekkaskono@163.com", 51 | url="https://github.com/RapidAI/PaddleOCRModelConvert", 52 | download_url="https://github.com/RapidAI/PaddleOCRModelConvert.git", 53 | license="Apache-2.0", 54 | include_package_data=True, 55 | install_requires=read_txt("requirements.txt"), 56 | packages=[MODULE_NAME], 57 | keywords=[ 58 | "ocr,text_detection,text_recognition,db,onnxruntime,paddleocr,openvino,rapidocr" 59 | ], 60 | classifiers=[ 61 | "Programming Language :: Python :: 3.6", 62 | "Programming Language :: Python :: 3.7", 63 | "Programming Language :: Python :: 3.8", 64 | "Programming Language :: Python :: 3.9", 65 | "Programming Language :: Python :: 3.10", 66 | "Programming Language :: Python :: 3.11", 67 | "Programming Language :: Python :: 3.12", 68 | ], 69 | python_requires=">=3.6,<3.13", 70 | entry_points={ 71 | "console_scripts": [f"{MODULE_NAME}={MODULE_NAME}.main:main"], 72 | }, 73 | ) 74 | -------------------------------------------------------------------------------- /tests/test_convert.py: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | # @Author: SWHL 3 | # @Contact: liekkaskono@163.com 4 | import hashlib 5 | import shutil 6 | import sys 7 | from pathlib import Path 8 | 9 | cur_dir = Path(__file__).resolve().parent 10 | root_dir = cur_dir.parent 11 | 12 | sys.path.append(str(root_dir)) 13 | 14 | from paddleocr_convert import PaddleOCRModelConvert, download_file 15 | 16 | 17 | def get_md5(filename): 18 | with open(filename, "rb") as file_txt: 19 | myhash = hashlib.md5(file_txt.read()) 20 | return myhash.hexdigest() 21 | 22 | 23 | def is_windows(): 24 | if sys.platform.startswith("win"): 25 | return True 26 | return False 27 | 28 | 29 | converter = PaddleOCRModelConvert() 30 | save_dir = cur_dir / "models" 31 | 32 | 33 | def test_url_input(): 34 | url = "https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_mobile_v2.0_cls_infer.tar" 35 | onnx_path = converter(url, save_dir, is_del_raw=True) 36 | assert Path(onnx_path).exists() 37 | shutil.rmtree(save_dir) 38 | 39 | 40 | def test_local_input(): 41 | url = "https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_mobile_v2.0_cls_infer.tar" 42 | tar_path = download_file(url, save_dir) 43 | onnx_path = converter(tar_path, save_dir, is_del_raw=True) 44 | 45 | assert Path(onnx_path).exists() 46 | 47 | shutil.rmtree(save_dir) 48 | 49 | 50 | def test_rec_input(): 51 | url = "https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_rec_infer.tar" 52 | txt_url = "https://gitee.com/paddlepaddle/PaddleOCR/raw/release/2.6/ppocr/utils/ppocr_keys_v1.txt" 53 | onnx_path = converter(url, save_dir, txt_path=txt_url, is_del_raw=True) 54 | 55 | assert Path(onnx_path).exists() 56 | 57 | shutil.rmtree(save_dir) 58 | 59 | 60 | def test_rec_input_local(): 61 | url = "https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_rec_infer.tar" 62 | txt_url = "https://gitee.com/paddlepaddle/PaddleOCR/raw/release/2.6/ppocr/utils/ppocr_keys_v1.txt" 63 | tar_path = download_file(url, save_dir) 64 | txt_path = download_file(txt_url, save_dir) 65 | 66 | onnx_path = converter(tar_path, save_dir, txt_path=txt_path, is_del_raw=True) 67 | 68 | assert Path(onnx_path).exists() 69 | 70 | shutil.rmtree(save_dir) 71 | --------------------------------------------------------------------------------