openocr-python 0.1.0.dev0__tar.gz

openocr_python-0.1.0.dev0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

openocr_python-0.1.0.dev0/MANIFEST.in

@@ -0,0 +1,20 @@
+prune opendet
+prune openrec
+prune tools
+
+
+include openocr/README.md
+include openocr/README_ch.md
+include openocr/__init__.py
+include openocr/demo_gradio.py
+include openocr/demo_opendoc.py
+include openocr/demo_unirec.py
+include openocr/openocr.py
+include LICENSE
+
+# Include all config files
+recursive-include openocr/configs *.yml *.yaml
+recursive-include openocr/opendet *.py
+recursive-include openocr/openrec *.py
+recursive-include openocr/tools *.py
+recursive-include openocr/tools *.txt

openocr_python-0.1.0.dev0/PKG-INFO

@@ -0,0 +1,324 @@
+Metadata-Version: 2.4
+Name: openocr-python
+Version: 0.1.0.dev0
+Summary: Accurate and Efficient General OCR System
+Home-page: https://github.com/Topdu/OpenOCR
+Author: OCR Team, FVL Lab
+Author-email: "OCR Team, FVL Lab" <784990967@qq.com>
+Maintainer-email: "OCR Team, FVL Lab" <784990967@qq.com>
+License: Apache License 2.0
+Project-URL: Homepage, https://github.com/Topdu/OpenOCR
+Project-URL: Documentation, https://github.com/Topdu/OpenOCR/tree/main/docs
+Project-URL: Repository, https://github.com/Topdu/OpenOCR
+Project-URL: Bug Reports, https://github.com/Topdu/OpenOCR/issues
+Keywords: ocr,optical character recognition,text detection,text recognition,document parsing,deep learning,computer vision
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy==1.26.4
+Requires-Dist: opencv-python<=4.12.0
+Requires-Dist: Pillow>=8.0.0
+Requires-Dist: pyyaml>=5.4.0
+Requires-Dist: tqdm>=4.60.0
+Requires-Dist: rapidfuzz>=2.0.0
+Requires-Dist: pyclipper>=1.3.0
+Requires-Dist: pydantic
+Requires-Dist: shapely
+Provides-Extra: onnx
+Requires-Dist: onnxruntime>=1.12.0; extra == "onnx"
+Provides-Extra: onnx-gpu
+Requires-Dist: onnxruntime-gpu>=1.12.0; extra == "onnx-gpu"
+Provides-Extra: pytorch
+Requires-Dist: torch>=1.10.0; extra == "pytorch"
+Requires-Dist: torchvision>=0.11.0; extra == "pytorch"
+Provides-Extra: gradio
+Requires-Dist: gradio==4.20.0; extra == "gradio"
+Provides-Extra: huggingface
+Requires-Dist: huggingface-hub>=0.16.0; extra == "huggingface"
+Provides-Extra: modelscope
+Requires-Dist: modelscope>=1.9.0; extra == "modelscope"
+Provides-Extra: all
+Requires-Dist: onnxruntime>=1.12.0; extra == "all"
+Requires-Dist: torch>=1.10.0; extra == "all"
+Requires-Dist: torchvision>=0.11.0; extra == "all"
+Requires-Dist: gradio==4.20.0; extra == "all"
+Requires-Dist: huggingface-hub>=0.16.0; extra == "all"
+Requires-Dist: modelscope>=1.9.0; extra == "all"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# OpenOCR: An Open-Source Toolkit for General-OCR Research and Applications
+
+## For More Information
+
+Visit: https://github.com/Topdu/OpenOCR
+
+## Recent Updates
+
+- **0.1.0**: Use a unified interface for OCR, Document Parsing, and Unirec
+- **0.0.10**: Remove OpenCV version restrictions.
+- **0.0.9**: Fixing torch inference bug.
+- **0.0.8**: Automatic Downloading ONNX model.
+- **0.0.7**: Releasing the feature of [ONNX model export for wider compatibility](#export-onnx-model).
+
+# Quick Start Guide
+
+## Installation
+
+```bash
+# Install from PyPI (recommended)
+pip install openocr-python huggingface-hub==0.36.0 modelscope onnxruntime
+
+# Or install from source
+git clone https://github.com/Topdu/OpenOCR.git
+cd OpenOCR
+python build_package.py
+pip install ./build/dist/openocr_python-*.whl huggingface-hub==0.36.0 modelscope onnxruntime
+```
+
+## Command Line Usage
+
+### 1. Text Detection + Recognition (OCR)
+
+End-to-end OCR for Chinese/English text detection and recognition:
+
+```bash
+# Basic usage
+openocr --task ocr --input_path path/to/img
+
+# With visualization
+openocr --task ocr --input_path path/to/img --is_vis
+
+# Process directory with custom output
+openocr --task ocr --input_path ./images --output_path ./results --is_vis
+
+# Use server mode (higher accuracy)
+pip install torch torchvision
+openocr --task ocr --input_path path/to/img --mode server --backend torch
+```
+
+### 2. Text Detection Only
+
+Detect text regions without recognition:
+
+```bash
+# Basic detection
+openocr --task det --input_path path/to/img
+
+# With visualization
+openocr --task det --input_path path/to/img --is_vis
+
+# Use polygon detection (more accurate for curved text)
+openocr --task det --input_path path/to/img --det_box_type poly
+```
+
+### 3. Text Recognition Only
+
+Recognize text from cropped word/line images:
+
+```bash
+# Basic recognition
+openocr --task rec --input_path path/to/img
+
+# Use server mode (higher accuracy)
+pip install torch torchvision
+openocr --task rec --input_path path/to/img --mode server --backend torch
+
+# Batch processing
+openocr --task rec --input_path ./word_images --rec_batch_num 16
+```
+
+### 4. Universal Recognition (UniRec)
+
+Recognize text, formulas, and tables using Vision-Language Model:
+
+```bash
+# Basic usage
+openocr --task unirec --input_path path/to/img
+
+# Process directory
+openocr --task unirec --input_path ./images --output_path ./results
+```
+
+### 5. Document Parsing (OpenDoc)
+
+Parse documents with layout analysis, table/formula/table recognition:
+
+```bash
+# Full document parsing with all outputs
+openocr --task doc --input_path path/to/img --use_layout_detection --save_vis --save_json --save_markdown
+
+# Parse PDF document
+openocr --task doc --input_path document.pdf --use_layout_detection --save_vis --save_json --save_markdown
+
+# Custom layout threshold
+openocr --task doc --input_path path/to/img --use_layout_detection --save_vis --save_json --save_markdown --layout_threshold 0.5
+```
+
+## Launch Interactive Demos
+
+```bash
+# Install gradio
+pip install gradio==4.20.0
+```
+
+### OCR Demo
+
+Launch Gradio web interface for OCR tasks:
+
+```bash
+pip install onnxruntime
+# Local access only
+openocr --task launch_openocr_demo --server_port 7860
+
+# Public share link
+openocr --task launch_openocr_demo --server_port 7860 --share
+```
+
+### UniRec Demo
+
+Launch Gradio web interface for universal recognition:
+
+```bash
+pip install onnxruntime
+openocr --task launch_unirec_demo --server_port 7861 --share
+```
+
+### OpenDoc Demo
+
+Launch Gradio web interface for document parsing:
+
+```bash
+pip install onnxruntime
+openocr --task launch_opendoc_demo --server_port 7862 --share
+```
+
+## Python API Usage
+
+### OCR Task
+
+```python
+import json
+from openocr import OpenOCR
+
+# Initialize OCR engine
+ocr = OpenOCR(task='ocr', mode='mobile')
+
+# Process single image
+results, time_dicts = ocr(
+    image_path='path/to/image.jpg',
+    save_dir='./output',
+    is_visualize=True
+)
+
+# Access results
+for result in results:
+    image_name, ocr_result = result.split('\t')
+    ocr_result = json.loads(ocr_result)
+    print(f"✅ OCR: {image_name} results: {ocr_result}")
+```
+
+### Detection Task
+
+```python
+from openocr import OpenOCR
+
+# Initialize detector
+detector = OpenOCR(task='det')
+
+# Detect text regions
+results = detector(image_path='path/to/image.jpg')
+
+# Access detection boxes
+boxes = results[0]['boxes']
+print(f"Found {len(boxes)} text regions")
+```
+
+### Recognition Task
+
+```python
+from openocr import OpenOCR
+
+# Initialize recognizer
+recognizer = OpenOCR(task='rec', mode='server', backend='torch') # pip install torch torchvision
+
+# Recognize text
+results = recognizer(image_path='path/to/word.jpg')
+
+# Access recognition result
+text = results[0]['text']
+score = results[0]['score']
+print(f"Text: {text}, Confidence: {score}")
+```
+
+### UniRec Task
+
+```python
+from openocr import OpenOCR
+
+# Initialize UniRec
+unirec = OpenOCR(task='unirec')
+
+# Recognize text/formula/table
+result_text, generated_ids = unirec(
+    image_path='path/to/image.jpg',
+    max_length=2048
+)
+print(f"Result: {result_text}")
+```
+
+### Document Parsing Task
+
+```python
+from openocr import OpenOCR
+
+# Initialize OpenDoc
+doc_parser = OpenOCR(
+    task='doc',
+    use_layout_detection=True,
+)
+
+# Parse document
+result = doc_parser(image_path='path/to/document.jpg')
+
+# Save results
+doc_parser.save_to_markdown(result, './output')
+doc_parser.save_to_json(result, './output')
+doc_parser.save_visualization(result, './output')
+```
+
+## Common Parameters
+
+- `--task`: Task type (ocr, det, rec, unirec, doc, launch\_\*\_demo)
+- `--input_path`: Input image/PDF path or directory
+- `--output_path`: Output directory (default: openocr_output/{task})
+- `--use_gpu`: GPU usage (auto, true, false)
+- `--mode`: Model mode (mobile, server) - server mode has higher accuracy
+- `--is_vis`: Visualize results
+- `--save_vis`: Save visualization (doc task)
+- `--save_json`: Save JSON results (doc task)
+- `--save_markdown`: Save Markdown results (doc task)
+
+## Output Structure
+
+Results are saved to `openocr_output/{task}/` by default:
+
+- **OCR task**: `ocr_results.txt` + visualization images (if --is_vis)
+- **Detection task**: `det_results.txt` + visualization images (if --is_vis)
+- **Recognition task**: `rec_results.txt`
+- **UniRec task**: `unirec_results.txt`
+- **Doc task**: JSON files, Markdown files, visualization images (based on flags)