docling-ocr-onnxtr 0.1.0__py3-none-any.whl

docling_ocr_onnxtr/__init__.py

@@ -0,0 +1,2 @@
+from .options import OnnxtrOcrOptions
+from .version import __version__  # noqa: F401

docling_ocr_onnxtr/onnxtr_model.py

@@ -0,0 +1,208 @@
+# Copyright (C) 2021-2025, Felix Dittrich.
+
+# This program is licensed under the Apache License 2.0.
+# See LICENSE or go to <https://opensource.org/licenses/Apache-2.0> for full license details.
+
+import logging
+import os
+from collections.abc import Iterable
+from pathlib import Path
+
+import numpy
+import numpy as np
+from docling.datamodel.base_models import Page
+from docling.datamodel.document import ConversionResult
+from docling.datamodel.pipeline_options import (
+    AcceleratorOptions,
+    OcrOptions,
+)
+from docling.datamodel.settings import settings
+from docling.models.base_ocr_model import BaseOcrModel
+from docling.utils.profiling import TimeRecorder
+from docling_core.types.doc import BoundingBox, CoordOrigin  # type: ignore[attr-defined]
+from docling_core.types.doc.page import BoundingRectangle, TextCell
+
+from docling_ocr_onnxtr.options import OnnxtrOcrOptions
+
+__all__ = ["OnnxtrOcrModel"]
+
+_log = logging.getLogger(__name__)
+
+
+class OnnxtrOcrModel(BaseOcrModel):
+    """OCR engine using OnnxTR."""
+
+    def __init__(
+        self,
+        enabled: bool,
+        artifacts_path: Path | None,
+        options: OnnxtrOcrOptions,
+        accelerator_options: AcceleratorOptions,
+    ):
+        super().__init__(
+            enabled=enabled,
+            artifacts_path=artifacts_path,
+            options=options,
+            accelerator_options=accelerator_options,
+        )
+        self.options: OnnxtrOcrOptions
+
+        self.scale = 3  # multiplier for 72 dpi == 216 dpi.
+
+        if self.enabled:
+            try:
+                from onnxtr.models import (  # type: ignore
+                    EngineConfig,
+                    from_hub,
+                    ocr_predictor,
+                )
+
+                # We disable multiprocessing for OnnxTR,
+                # because the speed up is minimal and it can raise memory leaks on windows
+                os.environ["ONNXTR_MULTIPROCESSING_DISABLE"] = "TRUE"
+            except ImportError:  # pragma: no cover
+                raise ImportError(
+                    "OnnxTR is not installed. Please install it via `pip install 'onnxtr[gpu]'` to use this OCR engine. "  # noqa: E501
+                    "Alternatively, Docling has support for other OCR engines. See the documentation."
+                )
+
+            if options.auto_correct_orientation:
+                config = {
+                    "assume_straight_pages": False,
+                    "straighten_pages": True,
+                    "export_as_straight_boxes": True,
+                    # Disable crop orientation because we straighten the pages already
+                    "disable_crop_orientation": True,
+                    "disable_page_orientation": False,
+                }
+            else:
+                config = {
+                    "assume_straight_pages": True,
+                    "straighten_pages": False,
+                    "export_as_straight_boxes": False,
+                    "disable_crop_orientation": False,
+                    "disable_page_orientation": False,
+                }
+
+            engine_cfg = EngineConfig(
+                providers=self.options.providers,
+                session_options=self.options.session_options,
+            )
+
+            self.reader = ocr_predictor(
+                det_arch=(
+                    from_hub(self.options.det_arch) if self.options.det_arch.count("/") == 1 else self.options.det_arch
+                ),
+                reco_arch=(
+                    from_hub(self.options.reco_arch)
+                    if self.options.reco_arch.count("/") == 1
+                    else self.options.reco_arch
+                ),
+                det_bs=1,  # NOTE: Should be always 1, because docling handles batching
+                preserve_aspect_ratio=self.options.preserve_aspect_ratio,
+                symmetric_pad=self.options.symmetric_pad,
+                paragraph_break=self.options.paragraph_break,
+                load_in_8_bit=self.options.load_in_8_bit,
+                **config,
+                det_engine_cfg=engine_cfg,
+                reco_engine_cfg=engine_cfg,
+                clf_engine_cfg=engine_cfg,
+            )
+
+    def _to_absolute_docling_format(
+        self,
+        geom: tuple[tuple[float, float], tuple[float, float]] | np.ndarray,
+        img_shape: tuple[int, int],
+    ) -> tuple[int, int, int, int]:
+        """
+        Convert a bounding box or polygon from relative to absolute coordinates and return in [x1, y1, x2, y2] format.
+
+        Args:
+            geom: Either [[xmin, ymin], [xmax, ymax]] or [[x1, y1], ..., [x4, y4]]
+            img_shape: (height, width) of the image
+
+        Returns:
+            top-left and bottom-right coordinates in absolute format (x1, y1, x2, y2)
+        """
+        h, w = img_shape
+        scale_inv = 1 / self.scale  # Precompute inverse for efficiency
+
+        def scale_point(x: float, y: float) -> tuple[int, int]:
+            """Scale and round a point to absolute coordinates."""
+            return int(round(x * w * scale_inv)), int(round(y * h * scale_inv))
+
+        if len(geom) == 2:
+            (xmin, ymin), (xmax, ymax) = geom
+            x1, y1 = scale_point(xmin, ymin)
+            x2, y2 = scale_point(xmax, ymax)
+        # 4-Point polygon - Unused atm until docling supports it
+        else:  # pragma: no cover
+            abs_points = [scale_point(*point) for point in geom]
+            x1, y1 = min(p[0] for p in abs_points), min(p[1] for p in abs_points)
+            x2, y2 = max(p[0] for p in abs_points), max(p[1] for p in abs_points)
+
+        return x1, y1, x2, y2
+
+    def __call__(self, conv_res: ConversionResult, page_batch: Iterable[Page]) -> Iterable[Page]:
+        if not self.enabled:
+            yield from page_batch
+            return
+
+        for page in page_batch:
+            assert page._backend is not None
+            if not page._backend.is_valid():
+                yield page
+                continue
+
+            with TimeRecorder(conv_res, "ocr"):
+                ocr_rects = self.get_ocr_rects(page)
+                all_ocr_cells = []
+
+                for ocr_rect in ocr_rects:
+                    if ocr_rect.area() == 0:
+                        continue
+
+                    with page._backend.get_page_image(scale=self.scale, cropbox=ocr_rect) as high_res_image:
+                        im_width, im_height = high_res_image.size
+                        result = self.reader([numpy.array(high_res_image)])
+
+                    if result is not None:
+                        for p in result.pages:
+                            for ix, word in enumerate(
+                                word for block in p.blocks for line in block.lines for word in line.words
+                            ):
+                                if (
+                                    word.confidence >= self.options.confidence_score
+                                    and word.objectness_score >= self.options.objectness_score
+                                ):
+                                    all_ocr_cells.append(
+                                        TextCell(
+                                            index=ix,
+                                            text=word.value,
+                                            orig=word.value,
+                                            from_ocr=True,
+                                            confidence=word.confidence,
+                                            rect=BoundingRectangle.from_bounding_box(
+                                                BoundingBox.from_tuple(
+                                                    self._to_absolute_docling_format(
+                                                        word.geometry,
+                                                        img_shape=(im_height, im_width),
+                                                    ),
+                                                    origin=CoordOrigin.TOPLEFT,
+                                                )
+                                            ),
+                                        )
+                                    )
+
+                # Post-process the cells
+                page.cells = self.post_process_cells(all_ocr_cells, page.cells)
+
+            # DEBUG code:
+            if settings.debug.visualize_ocr:
+                self.draw_ocr_rects_and_cells(conv_res, page, ocr_rects)
+
+            yield page
+
+    @classmethod
+    def get_options_type(cls) -> type[OcrOptions]:
+        return OnnxtrOcrOptions

docling_ocr_onnxtr/options.py

@@ -0,0 +1,40 @@
+# Copyright (C) 2021-2025, Felix Dittrich.
+
+# This program is licensed under the Apache License 2.0.
+# See LICENSE or go to <https://opensource.org/licenses/Apache-2.0> for full license details.
+
+from typing import Any, ClassVar, Literal
+
+from docling.datamodel.pipeline_options import OcrOptions
+from pydantic import ConfigDict
+
+__all__ = ["OnnxtrOcrOptions"]
+
+
+class OnnxtrOcrOptions(OcrOptions):
+    """Options for the Onnxtr engine."""
+
+    kind: ClassVar[Literal["onnxtr"]] = "onnxtr"
+
+    lang: list[str] = ["en", "fr"]
+    # word confidence threshold for the recognition model
+    confidence_score: float = 0.5
+    # detection model objectness score threshold 'fast algorithm'
+    objectness_score: float = 0.3
+
+    # NOTE: This can be also a hf hub model
+    det_arch: str = "fast_base"
+    reco_arch: str = "crnn_vgg16_bn"
+    reco_bs: int = 512
+    auto_correct_orientation: bool = False
+    preserve_aspect_ratio: bool = True
+    symmetric_pad: bool = True
+    paragraph_break: float = 0.035
+    load_in_8_bit: bool = False
+    # Ref.: https://onnxruntime.ai/docs/api/python/api_summary.html
+    providers: list[tuple[str, dict[str, Any]]] | None = None
+    session_options: Any | None = None
+
+    model_config = ConfigDict(
+        extra="forbid",
+    )

docling_ocr_onnxtr/plugin.py

@@ -0,0 +1,10 @@
+# Copyright (C) 2021-2025, Felix Dittrich.
+
+# This program is licensed under the Apache License 2.0.
+# See LICENSE or go to <https://opensource.org/licenses/Apache-2.0> for full license details.
+
+from .onnxtr_model import OnnxtrOcrModel
+
+
+def ocr_engines():  # noqa: D103
+    return {"ocr_engines": [OnnxtrOcrModel]}

docling_ocr_onnxtr/version.py

@@ -0,0 +1 @@
+__version__ = 'v0.1.0'

docling_ocr_onnxtr-0.1.0.dist-info/METADATA

@@ -0,0 +1,402 @@
+Metadata-Version: 2.4
+Name: docling-ocr-onnxtr
+Version: 0.1.0
+Summary: Onnx Text Recognition (OnnxTR) plugin for docling
+Author-email: Felix Dittrich <felixdittrich92@gmail.com>
+Maintainer: Felix Dittrich
+License:                                  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.
+        
+Project-URL: repository, https://github.com/felixdittrich92/docling-OCR-OnnxTR/OnnxTR
+Project-URL: tracker, https://github.com/felixdittrich92/docling-OCR-OnnxTR/issues
+Project-URL: changelog, https://github.com/felixdittrich92/docling-OCR-OnnxTR/releases
+Keywords: OCR,deep learning,computer vision,onnx,text detection,text recognition,docTR,document analysis,document processing,document AI,docling,plugin
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: <4,>=3.10.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic
+Requires-Dist: onnxtr
+Requires-Dist: docling
+Provides-Extra: cpu
+Requires-Dist: onnxtr[cpu]; extra == "cpu"
+Provides-Extra: gpu
+Requires-Dist: onnxtr[gpu]; extra == "gpu"
+Provides-Extra: openvino
+Requires-Dist: onnxtr[openvino]; extra == "openvino"
+Provides-Extra: cpu-headless
+Requires-Dist: onnxtr[cpu-headless]; extra == "cpu-headless"
+Provides-Extra: gpu-headless
+Requires-Dist: onnxtr[gpu-headless]; extra == "gpu-headless"
+Provides-Extra: openvino-headless
+Requires-Dist: onnxtr[openvino-headless]; extra == "openvino-headless"
+Provides-Extra: testing
+Requires-Dist: pytest>=5.3.2; extra == "testing"
+Requires-Dist: coverage[toml]>=4.5.4; extra == "testing"
+Requires-Dist: requests>=2.20.0; extra == "testing"
+Provides-Extra: quality
+Requires-Dist: ruff>=0.1.5; extra == "quality"
+Requires-Dist: mypy>=0.812; extra == "quality"
+Requires-Dist: pre-commit>=2.17.0; extra == "quality"
+Provides-Extra: dev
+Requires-Dist: onnxtr[gpu]; extra == "dev"
+Requires-Dist: pytest>=5.3.2; extra == "dev"
+Requires-Dist: coverage[toml]>=4.5.4; extra == "dev"
+Requires-Dist: requests>=2.20.0; extra == "dev"
+Requires-Dist: ruff>=0.1.5; extra == "dev"
+Requires-Dist: mypy>=0.812; extra == "dev"
+Requires-Dist: pre-commit>=2.17.0; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://github.com/felixdittrich92/OnnxTR/raw/main/docs/images/logo.jpg" width="40%">
+</p>
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+[![Test Status](https://github.com/felixdittrich92/docling-OCR-OnnxTR/actions/workflows/main.yml/badge.svg)](https://github.com/felixdittrich92/docling-OCR-OnnxTR/actions/workflows/main.yml)
+[![codecov](https://codecov.io/gh/felixdittrich92/docling-OCR-OnnxTR/graph/badge.svg?token=L3AHXKV86A)](https://codecov.io/gh/felixdittrich92/docling-OCR-OnnxTR)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/0d250447650240ee9ca573950fea8b99)](https://app.codacy.com/gh/felixdittrich92/docling-OCR-OnnxTR/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![CodeFactor](https://www.codefactor.io/repository/github/felixdittrich92/docling-ocr-onnxtr/badge)](https://www.codefactor.io/repository/github/felixdittrich92/docling-ocr-onnxtr)
+[![Pypi](https://img.shields.io/badge/pypi-v0.6.2-blue.svg)](https://pypi.org/project//)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/docling-ocr-onnxtr)
+
+The `docling-OCR-OnnxTR` repository provides a plugin that integrates the [OnnxTR OCR engine](https://github.com/felixdittrich92/OnnxTR) into the [Docling framework](https://github.com/docling-project/docling), enhancing document processing capabilities with efficient and accurate text recognition.
+
+**Key Features:**
+
+- **Seamless Integration:** Easily incorporate OnnxTR's OCR functionalities into your Docling workflows for improved document parsing and analysis.
+
+- **Optimized Performance:** Leverages OnnxTR's lightweight architecture to deliver faster inference times and reduced resource consumption compared to traditional OCR engines.
+
+- **Flexible Deployment:** Supports various hardware configurations, including CPU, GPU, and OpenVINO, allowing you to choose the best setup for your needs.
+
+**Installation:**
+
+To install the plugin, use one of the following commands based on your hardware:
+
+```bash
+# For CPU
+pip install docling-ocr-onnxtr[cpu]
+# For Nvidia GPU
+pip install docling-ocr-onnxtr[gpu]
+# For Intel GPU / Integrated Graphics
+pip install docling-ocr-onnxtr[openvino]
+
+# Headless mode (no GUI)
+# For CPU
+pip install docling-ocr-onnxtr[cpu-headless]
+# For Nvidia GPU
+pip install docling-ocr-onnxtr[gpu-headless]
+# For Intel GPU / Integrated Graphics
+pip install docling-ocr-onnxtr[openvino-headless]
+```
+
+By integrating OnnxTR with Docling, users can achieve more efficient and accurate OCR results, enhancing the overall document processing experience.
+
+## Usage
+
+```python
+from docling.datamodel.pipeline_options import PdfPipelineOptions
+from docling.document_converter import (
+    ConversionResult,
+    DocumentConverter,
+    InputFormat,
+    PdfFormatOption,
+)
+from docling_ocr_onnxtr import OnnxtrOcrOptions
+
+
+def main():
+    # Source document to convert
+    source = "https://arxiv.org/pdf/2408.09869v4"
+
+    # Available detection & recognition models can be found at
+    # https://github.com/felixdittrich92/OnnxTR
+
+    # Or you choose a model from Hugging Face Hub
+    # Collection: https://huggingface.co/collections/Felix92/onnxtr-66bf213a9f88f7346c90e842
+
+    ocr_options = OnnxtrOcrOptions(
+        # Text detection model
+        det_arch="db_mobilenet_v3_large",
+        # Text recognition model - from Hugging Face Hub
+        reco_arch="Felix92/onnxtr-parseq-multilingual-v1",
+        # This can be set to `True` to auto-correct the orientation of the pages
+        auto_correct_orientation=False,
+    )
+
+    pipeline_options = PdfPipelineOptions(
+        ocr_options=ocr_options,
+    )
+    pipeline_options.allow_external_plugins = True  # <-- enabled the external plugins
+
+    # Convert the document
+    converter = DocumentConverter(
+        format_options={
+            InputFormat.PDF: PdfFormatOption(
+                pipeline_options=pipeline_options,
+            ),
+        },
+    )
+
+    conversion_result: ConversionResult = converter.convert(source=source)
+    doc = conversion_result.document
+    md = doc.export_to_markdown()
+    print(md)
+
+
+if __name__ == "__main__":
+    main()
+```
+
+## Configuration
+
+The configuration of the OCR engine is done via the `OnnxtrOcrOptions` class. The following options are available:
+
+- `lang`: List of languages to use for OCR. Default is `["en", "fr"]`.
+- `confidence_score`: Word confidence threshold for the recognition model. Default is `0.5`.
+- `objectness_score`: Detection model objectness score threshold. Default is `0.3`.
+- `det_arch`: Detection model architecture. Default is `"fast_base"`.
+- `reco_arch`: Recognition model architecture. Default is `"crnn_vgg16_bn"`.
+- `reco_bs`: Batch size for the recognition model. Default is `512`.
+- `auto_correct_orientation`: Whether to auto-correct the orientation of the pages. Default is `False`.
+- `preserve_aspect_ratio`: Whether to preserve the aspect ratio of the images. Default is `True`.
+- `symmetric_pad`: Whether to use symmetric padding. Default is `True`.
+- `paragraph_break`: Paragraph break threshold. Default is `0.035`.
+- `load_in_8_bit`: Whether to load the model in 8-bit. Default is `False`. (Not supported for Hugging Face loaded models yet)
+- `providers`: List of providers to use for the Onnxruntime. Default is `None` which means auto-select.
+- `session_options`: Session options for the Onnxruntime. Default is `None` which means default OnnxTR session options.
+
+Available Hugging Face models can be found at [Hugging Face](https://huggingface.co/collections/Felix92/onnxtr-66bf213a9f88f7346c90e842).
+
+**Further information:**
+
+Please take a look at [OnnxTR](https://github.com/felixdittrich92/OnnxTR).
+
+## Contributing
+
+Contributions are welcome!
+
+Before opening a pull request, please ensure that your code passes the tests and adheres to the project's coding standards.
+
+You can run the tests and checks using:
+
+```bash
+make style
+make quality
+make test
+```
+
+## License
+
+Distributed under the Apache 2.0 License. See [`LICENSE`](https://github.com/felixdittrich92/OnnxTR?tab=Apache-2.0-1-ov-file#readme) for more information.

docling_ocr_onnxtr-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+docling_ocr_onnxtr/__init__.py,sha256=w8M8ctJDcDcxxrRJ_GT-G7JP3H7E1O50AuoK4l2djf0,85
+docling_ocr_onnxtr/onnxtr_model.py,sha256=FEEyFbRttBh4ckz5QgfT_n5zgtmfCNLr_bLhoobnl68,8490
+docling_ocr_onnxtr/options.py,sha256=gOzKHo86zwAVI_5-YxOr4NaRkNFwlv1RXeag7ZKWxtM,1266
+docling_ocr_onnxtr/plugin.py,sha256=qtPPjpsiXyExvK7Vu8ssZhqxDV2gqFTHIIBBv1qz1lA,317
+docling_ocr_onnxtr/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+docling_ocr_onnxtr/version.py,sha256=wC2oqFtrOUdONUyrZY5FqyMyRDiF3ryABp7mW73C87o,23
+docling_ocr_onnxtr-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+docling_ocr_onnxtr-0.1.0.dist-info/METADATA,sha256=W0nq79p0GmCLxIH75sVkmqAiY4DNM-JsVls3FMhPTsM,21695
+docling_ocr_onnxtr-0.1.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+docling_ocr_onnxtr-0.1.0.dist-info/entry_points.txt,sha256=4bUh15gjHVjgG1_vEtZgZ0Kyo7ygkWeAugc_W-EtSfo,57
+docling_ocr_onnxtr-0.1.0.dist-info/top_level.txt,sha256=srlsGnjF-Kcu5JHUTnp3rtFKPk6F_8fTOl2PTVia7c0,19
+docling_ocr_onnxtr-0.1.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+docling_ocr_onnxtr-0.1.0.dist-info/RECORD,,

docling_ocr_onnxtr-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (78.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

docling_ocr_onnxtr-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[docling]
+docling_ocr_onnxtr = docling_ocr_onnxtr.plugin

docling_ocr_onnxtr-0.1.0.dist-info/licenses/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.

docling_ocr_onnxtr-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+docling_ocr_onnxtr

docling_ocr_onnxtr-0.1.0.dist-info/zip-safe

@@ -0,0 +1 @@
+