deepdoctection 0.43.3__py3-none-any.whl → 0.43.5__py3-none-any.whl

deepdoctection/__init__.py

@@ -25,7 +25,7 @@ from .utils.logger import LoggingRecord, logger
 
 # pylint: enable=wrong-import-position
 
-__version__ = "0.43.3"
+__version__ = "0.43.5"
 
 _IMPORT_STRUCTURE = {
     "analyzer": ["config_sanity_checks", "get_dd_analyzer", "ServiceFactory"],

deepdoctection/analyzer/config.py

@@ -903,6 +903,7 @@ cfg.LAYOUT_LINK.CHILD_CATEGORIES = [LayoutType.CAPTION]
 # This prevents accidental modification at runtime.
 cfg.freeze()
 
+
 def update_cfg_from_defaults() -> None:
     """
     Update the configuration with current values from IMAGE_DEFAULTS.

deepdoctection/datapoint/view.py

@@ -72,6 +72,18 @@ class ImageAnnotationBaseView(ImageAnnotation):
 
     base_page: Page
 
+    @property
+    def b64_image(self) -> Optional[str]:
+        """
+        Returns:
+            The base64 encoded image of the page if available, otherwise None.
+        """
+
+        if self.image is not None:
+            if self.image.image is not None:
+                return viz_handler.convert_np_to_b64(self.image.image)
+        return None
+
     @property
     def bbox(self) -> list[float]:
         """
@@ -157,7 +169,7 @@ class ImageAnnotationBaseView(ImageAnnotation):
         """
 
         # sub categories and summary sub categories are valid attribute names
-        attr_names = {"bbox", "np_image"}.union({cat.value for cat in self.sub_categories})
+        attr_names = {"bbox", "np_image", "b64_image"}.union({cat.value for cat in self.sub_categories})
         if self.image:
             attr_names = attr_names.union({cat.value for cat in self.image.summary.sub_categories.keys()})
         return {attr_name.value if isinstance(attr_name, ObjectTypes) else attr_name for attr_name in attr_names}
@@ -774,6 +786,7 @@ class Page(Image):
         "residual_layouts",
         "document_summary",
         "document_mapping",
+        "b64_image",
     }
     include_residual_text_container: bool = True
 
@@ -902,6 +915,17 @@ class Page(Image):
         """
         return self.get_annotation(category_names=self.residual_text_block_categories)
 
+    @property
+    def b64_image(self) -> Optional[str]:
+        """
+        Returns:
+            The base64 encoded image of the page if available, otherwise None.
+        """
+
+        if self.image_orig.image is not None:
+            return viz_handler.convert_np_to_b64(self.image_orig.image)
+        return None
+
     @classmethod
     def from_image(
         cls,
@@ -1410,10 +1434,12 @@ class Page(Image):
         for block in block_with_order:
             all_words.extend(block.get_ordered_words())  # type: ignore
         return [
-            {"word": word.characters,
-             "entity": word.token_tag.value,
-             "annotation_id": word.annotation_id,
-             "successor_annotation_id": word.successor[0].annotation_id if word.successor else None}
+            {
+                "word": word.characters,
+                "entity": word.token_tag.value,
+                "annotation_id": word.annotation_id,
+                "successor_annotation_id": word.successor[0].annotation_id if word.successor else None,
+            }
             for word in all_words
             if word.token_tag not in (TokenClasses.OTHER, None)
         ]

deepdoctection/datasets/base.py

@@ -484,7 +484,7 @@ class CustomDataset(DatasetBase):
         return DatasetInfo(
             name=self.name,
             type=self.type,
-            description=self.description if self.description is not None else "",
+            short_description=self.description if self.description is not None else "",
             license="",
             url="",
             splits={},

deepdoctection/extern/doctrocr.py

@@ -269,10 +269,7 @@ class DoctrTextlineDetector(DoctrTextlineDetectorMixin):
         if self.lib == "PT":
             self.device = get_torch_device(device)
 
-        self.doctr_predictor = self.get_wrapped_model(self.architecture,
-                                                      self.path_weights,
-                                                      self.device,
-                                                      self.lib)
+        self.doctr_predictor = self.get_wrapped_model(self.architecture, self.path_weights, self.device, self.lib)
 
     def predict(self, np_img: PixelValues) -> list[DetectionResult]:
         """

deepdoctection/pipe/anngen.py

@@ -19,7 +19,7 @@
 Datapoint manager
 """
 from dataclasses import asdict
-from typing import Optional, Union, Sequence
+from typing import Optional, Sequence, Union
 
 import numpy as np
 

deepdoctection/pipe/order.py

@@ -801,14 +801,13 @@ class TextOrderService(TextLineServiceMixin):
         if self.include_residual_text_container:
             add_category.append(LayoutType.LINE)
 
-        if set(self.floating_text_block_categories) <= set(
-            self.text_block_categories + tuple(add_category)
-        ):
-            logger.warning("In most cases floating_text_block_categories must be a subset of text_block_categories. "
-                           "Adding categories to floating_text_block_categories, that do not belong to "
-                           "text_block_categories makes only sense for categories set have CHILD relationships with"
-                           " annotations that belong to text_block_categories.")
-
+        if set(self.floating_text_block_categories) <= set(self.text_block_categories + tuple(add_category)):
+            logger.warning(
+                "In most cases floating_text_block_categories must be a subset of text_block_categories. "
+                "Adding categories to floating_text_block_categories, that do not belong to "
+                "text_block_categories makes only sense for categories set have CHILD relationships with"
+                " annotations that belong to text_block_categories."
+            )
 
     def get_meta_annotation(self) -> MetaAnnotation:
         add_category = [self.text_container]

deepdoctection/utils/develop.py

@@ -71,7 +71,6 @@ def log_deprecated(name: str, text: str, eos: str = "", max_num_warnings: Option
     logger.info(LoggingRecord(f"[Deprecated] {info_msg}"))
 
 
-
 def deprecated(
     text: str = "", eos: str = "", max_num_warnings: Optional[int] = None
 ) -> Callable[[Callable[..., T]], Callable[..., T]]:

{deepdoctection-0.43.3.dist-info → deepdoctection-0.43.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deepdoctection
-Version: 0.43.3
+Version: 0.43.5
 Summary: Repository for Document AI
 Home-page: https://github.com/deepdoctection/deepdoctection
 Author: Dr. Janis Meyer
@@ -168,13 +168,9 @@ Version `v.0.43` includes a significant redesign of the Analyzer's default confi
 </p>
 
 
-
 **deep**doctection is a Python library that orchestrates Scan and PDF document layout analysis and extraction for RAG.
 It also provides a framework for training, evaluating and inferencing Document AI models.
 
-Check the demo of a document layout analysis pipeline with OCR on 🤗
-[**Hugging Face spaces**](https://huggingface.co/spaces/deepdoctection/deepdoctection).
-
 # Overview
 
 - Document layout analysis and table recognition in PyTorch with 
@@ -197,6 +193,54 @@ for an easy start.
 
 Check the [**release notes**](https://github.com/deepdoctection/deepdoctection/releases) for recent updates.
 
+
+----------------------------------------------------------------------------------------
+
+# Hugging Face Space Demo
+
+Check the demo of a document layout analysis pipeline with OCR on 🤗
+[**Hugging Face spaces**](https://huggingface.co/spaces/deepdoctection/deepdoctection) or use the gradio client. 
+
+```
+pip install gradio_client   # requires Python >= 3.10 
+```
+
+To process a single image:
+
+```python
+from gradio_client import Client, handle_file
+
+if __name__ == "__main__":
+
+    client = Client("deepdoctection/deepdoctection")
+    result = client.predict(
+        img=handle_file('/local_path/to/dir/file_name.jpeg'),  # accepts image files, e.g. JPEG, PNG
+        pdf=None,   
+        max_datapoints = 2,
+        api_name = "/analyze_image"
+    )
+    print(result)
+```
+
+To process a PDF document:
+
+```python
+from gradio_client import Client, handle_file
+
+if __name__ == "__main__":
+
+    client = Client("deepdoctection/deepdoctection")
+    result = client.predict(
+        img=None,
+        pdf=handle_file("/local_path/to/dir/your_doc.pdf"),
+        max_datapoints = 2, # increase to process up to 9 pages
+        api_name = "/analyze_image"
+    )
+    print(result)
+```
+
+--------------------------------------------------------------------------------------------------------
+
 # Example
 
 ```python
@@ -242,8 +286,9 @@ alt="text" width="40%">
 </p>
 
 
+-----------------------------------------------------------------------------------------
 
-## Requirements
+# Requirements
 
 ![requirements](https://github.com/deepdoctection/deepdoctection/raw/master/docs/tutorials/_imgs/install_01.png)
 
@@ -262,11 +307,13 @@ alt="text" width="40%">
 | DocTr | ✅ | ❌ | ✅ |
 | LayoutLM (v1, v2, v3, XLM) via Transformers | ✅ | ❌ | ❌ |
 
-## Installation
+------------------------------------------------------------------------------------------
+
+# Installation
 
 We recommend using a virtual environment.
 
-#### Get started installation
+## Get started installation
 
 For a simple setup which is enough to parse documents with the default setting, install the following:
 
@@ -288,7 +335,7 @@ pip install deepdoctection
 
 Both setups are sufficient to run the [**introduction notebook**](https://github.com/deepdoctection/notebooks/blob/main/Get_Started.ipynb).
 
-#### Full installation
+### Full installation
 
 The following installation will give you ALL models available within the Deep Learning framework as well as all models
 that are independent of Tensorflow/PyTorch.
@@ -318,7 +365,7 @@ pip install deepdoctection[tf]
 For further information, please consult the [**full installation instructions**](https://deepdoctection.readthedocs.io/en/latest/install/).
 
 
-### Installation from source
+## Installation from source
 
 Download the repository or clone via
 
@@ -341,8 +388,7 @@ pip install ".[tf]" # or "pip install -e .[tf]"
 ```
 
 
-
-### Running a Docker container from Docker hub
+## Running a Docker container from Docker hub
 
 Pre-existing Docker images can be downloaded from the [Docker hub](https://hub.docker.com/r/deepdoctection/deepdoctection).
 
@@ -360,16 +406,18 @@ docker compose up -d
 
 will start the container. There is no endpoint exposed, though.
 
-## Credits
+-----------------------------------------------------------------------------------------------
+
+# Credits
 
 We thank all libraries that provide high quality code and pre-trained models. Without, it would have been impossible
 to develop this framework.
 
 
-## If you like **deep**doctection ...
+# If you like **deep**doctection ...
 
 ...you can easily support the project by making it more visible. Leaving a star or a recommendation will help.
 
-## License
+# License
 
 Distributed under the Apache 2.0 License. Check [LICENSE](https://github.com/deepdoctection/deepdoctection/blob/master/LICENSE) for additional information.

{deepdoctection-0.43.3.dist-info → deepdoctection-0.43.5.dist-info}/RECORD

@@ -1,7 +1,7 @@
-deepdoctection/__init__.py,sha256=nJ6cTH9fWxNIGSDjMS7AoU9hbJwfbb-SvTwOw6eiPAg,12964
+deepdoctection/__init__.py,sha256=ackdlzoLcoHJAmWtxrkE2PnYgG-3q9bL2c1d3kqFgTY,12964
 deepdoctection/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 deepdoctection/analyzer/__init__.py,sha256=wg0BcFwdCeREwzZfa--Yx8HUJ9LPv5z5PmLwtkZdPH8,772
-deepdoctection/analyzer/config.py,sha256=Uwi9MYOym0QXzFcip7bRXoy732P4tZVMFBUnUZk9c1w,41761
+deepdoctection/analyzer/config.py,sha256=DToaXs59w7SpEi2vkeBEyrBwyyGiXUST_N99wL9nHoI,41762
 deepdoctection/analyzer/dd.py,sha256=2BGvZpl9o9khcaOV52-DPHMrs0DsqUO8cpdqFVHHzDQ,5176
 deepdoctection/analyzer/factory.py,sha256=DI0S38KAG2sIROrSximsWJsMbem91a9zXaeWsDNvkGg,37574
 deepdoctection/configs/__init__.py,sha256=TX_P6tqDOF1LK1mi9ruAl7x0mtv1Asm8cYWCz3Pe2dk,646
@@ -21,10 +21,10 @@ deepdoctection/datapoint/annotation.py,sha256=f32BNmzUGJoNMeGst2RGC2jmjJpzzjxyBR
 deepdoctection/datapoint/box.py,sha256=QAS8sK2Ge4_ysW6zOYkLlzNwhSyw_mhYcYsxscClEno,31453
 deepdoctection/datapoint/convert.py,sha256=6ENXX3tBdY8ogb2NBPxsOsQMGnQux8ol5nrUfWS5tYE,7352
 deepdoctection/datapoint/image.py,sha256=kqwCz8DSc19hQpkl_4L1_Ek7_2KrH5KsV9e0S-R4n5w,35147
-deepdoctection/datapoint/view.py,sha256=lVUTi2vfh6w7k92kcwQNpKmfOGgZmM12bYJUFrO5Pno,57163
+deepdoctection/datapoint/view.py,sha256=YtoqafStrHqbfyD628-W1HOA2Gb0kUI2oaEiteBHjbA,57902
 deepdoctection/datasets/__init__.py,sha256=4ifjIwWCPYiS31GzUlVDScrkNOrb1eo5xHlRXNyg_58,994
 deepdoctection/datasets/adapter.py,sha256=VSLM_980aHi4TpgOxfxiBHiF_fUXyh348PXet6zTo-4,7779
-deepdoctection/datasets/base.py,sha256=HTIquJir2BZRTLl1HSQM0ICfvjIaWAjJeyz3BEHgdb0,23175
+deepdoctection/datasets/base.py,sha256=Qfh52aVtBd2df2ZY0hjLz4D1jrExnPuu_8uYpolVNks,23181
 deepdoctection/datasets/dataflow_builder.py,sha256=0vwkItr0wVbKPtTXoS6uJLO9QQNWbS0Ri7CySuywWxU,4186
 deepdoctection/datasets/info.py,sha256=DLRYq3cHp3L34CcSXPUJ8j8wguJp2aVdoH-AhODNLBA,20814
 deepdoctection/datasets/registry.py,sha256=qYRVycNYFeAzWB7jENGYzokgyzIEvTRb49he2UmPUe8,3451
@@ -54,7 +54,7 @@ deepdoctection/extern/__init__.py,sha256=jG2qe5_X7fJFnJlx04Lf1KUTXKKKYtCkKR7WQ7l
 deepdoctection/extern/base.py,sha256=LomTR9HXcBU55MPDIA8D1rIamk7DUmToJmgcRXzCoeU,31650
 deepdoctection/extern/d2detect.py,sha256=I0oEkprr5iVpKpM3a3nknAU-sXwNoDQdp_B1gzzODsk,22374
 deepdoctection/extern/deskew.py,sha256=L_jU0rXh03qzwaT79EIqE_zYMUVeFwWDbsGbtahuL2k,3124
-deepdoctection/extern/doctrocr.py,sha256=vOI67NCeEznHzdY4zu1tggwg3_PfwV1eigsr2Z8EPzc,25543
+deepdoctection/extern/doctrocr.py,sha256=jB0mnvGmmygoUu9e9zw2_HtAgQUdCJHbxMSt1cfK5bA,25381
 deepdoctection/extern/fastlang.py,sha256=4D9A-_hTXUcvXG6IJJknX34LrD71v08XtNdWgvXD7fE,4736
 deepdoctection/extern/hfdetr.py,sha256=N3eLNI5BsQS9_7YZyBeWndSgUydJij7ugZA9p4V1xaQ,14316
 deepdoctection/extern/hflayoutlm.py,sha256=3mZZ3byn00jSrLWO2vZFas9j4VrhbYQNmF1mwPG2ElQ,59642
@@ -103,7 +103,7 @@ deepdoctection/mapper/pubstruct.py,sha256=UTyfUmzMSuf2BXtdYwHjK7ngsIwAxSZjwTxDtz
 deepdoctection/mapper/tpstruct.py,sha256=dxtEVHYVnkH-zjjbHzkFrPgS9eheys6E-CMlsjaOnxo,5468
 deepdoctection/mapper/xfundstruct.py,sha256=JVs92T5l3HedQvdc6ZMACj2mq5Co4WCS9B-CnQ01opA,9092
 deepdoctection/pipe/__init__.py,sha256=E3cYAVWOvMzIN7jbKFyqLjFXahcFGcAGkb1uChM_XCY,1034
-deepdoctection/pipe/anngen.py,sha256=I7VFoTTa-sJCBwFJNaZeLD7pcrLjRPTX2I6-ZDCDHPI,16819
+deepdoctection/pipe/anngen.py,sha256=0zrP6DoN83ct1pKxGFpwHonFpP2GZV62lGsneymgOJo,16819
 deepdoctection/pipe/base.py,sha256=oszB_DepcFtORvDdGTZZPWMhk01C68RUWXHjeX7SF3M,18163
 deepdoctection/pipe/common.py,sha256=OcsqHr_c66Yqt98hFeKwaa0mciWMCauw0HZ3YnHx8MU,24586
 deepdoctection/pipe/concurrency.py,sha256=_EKZi4eCeF3mVHytZL_fMwyqa25C2aR9g8vrIFB8iR4,9780
@@ -111,7 +111,7 @@ deepdoctection/pipe/doctectionpipe.py,sha256=ik5F92F3klI5Nve_AnyIRj-ApMoKHSR2Sjc
 deepdoctection/pipe/language.py,sha256=T5g5_2GIsbTltAmn_PFymMUMoik8_b0uJNx8f5dT9MM,5898
 deepdoctection/pipe/layout.py,sha256=oAldMtwyZee1IqpuflKKvmeL2Z_nXFiqwFMS4VYv5eI,6391
 deepdoctection/pipe/lm.py,sha256=nYI2bm0sc9d3JMlIPyNyd4XxXFRBIHRUYfMImuek6b4,19793
-deepdoctection/pipe/order.py,sha256=8CqEWUA6U9HxThKKGP9yJMbRaML2by7do0Gdhl_7AdI,40964
+deepdoctection/pipe/order.py,sha256=apuJjZe2VhWVoYRPN-kLv9y6SULKhjPnGqFYRNqw8kQ,40938
 deepdoctection/pipe/refine.py,sha256=SrMcAWXRO5tJpqaZCEz9RzvjPyiQiE8fZ9TXBcaBKck,23310
 deepdoctection/pipe/registry.py,sha256=uT5fnHjffoNGk2JPuD2-pMYtO3Iko7-wrwVZVCWLtok,906
 deepdoctection/pipe/segment.py,sha256=rHhEWr5zZ1ppj-gMa-q-UCr1AYTWpUW7oA1umwebqBI,61302
@@ -126,7 +126,7 @@ deepdoctection/train/tp_frcnn_train.py,sha256=Tltb-v2JD5oPuHCZGA9B5DM4ZaidoBITlH
 deepdoctection/utils/__init__.py,sha256=brBceRWeov9WXMiJTjyJOF2rHMP8trGGRRjhMdZ61nI,2371
 deepdoctection/utils/concurrency.py,sha256=9ly81D5i2ZFzKfXMIUSmhT42eMs4QttsRhWXdkIk6Aw,5832
 deepdoctection/utils/context.py,sha256=5QfdzxsiSPnNs1qtJdgjguIoD8srLQ2W8oeDzwp9F78,4522
-deepdoctection/utils/develop.py,sha256=x2MhbmoKZyRluesmc01is7ldrUN9c0TX4OAuc1yt6dI,3569
+deepdoctection/utils/develop.py,sha256=4myrqBDypM6tQ2a2Jo3Q20RuE_W2czykpXBwgXPrxNw,3568
 deepdoctection/utils/env_info.py,sha256=b1WohrfQuoL-BPN0_s8Rjtwzx-WKvCyaX2I4qYl1Emc,19878
 deepdoctection/utils/error.py,sha256=sIry8F5MZ0yLvKfAwVz90IorKWVvjoRqcC0L8qq8mLk,2480
 deepdoctection/utils/file_utils.py,sha256=EepfAZVADaqpBdVq2LOJXLFLsMd_oZF_FAKUHOAhiZ0,25246
@@ -142,8 +142,8 @@ deepdoctection/utils/transform.py,sha256=jgeCyQWLN9q79jCGW7jysyKUKcJ1AVMk8OslF-3
 deepdoctection/utils/types.py,sha256=ti4WdtIJSg3TGK_YPkkoY9PYGMnR2tTX6Xfik8U1pNk,2986
 deepdoctection/utils/utils.py,sha256=NBUb1qbx8Jm-AvYN1Sdbk0huXhbAKxZ-ZtOcMespsMM,7064
 deepdoctection/utils/viz.py,sha256=bujRIujvX317rPz4jBrj0yd3WP8wPjDUiI5GUrw9MzQ,27339
-deepdoctection-0.43.3.dist-info/licenses/LICENSE,sha256=GQ0rUvuGdrMNEI3iHK5UQx6dIMU1QwAuyXsxUHn5MEQ,11351
-deepdoctection-0.43.3.dist-info/METADATA,sha256=tFoZH2VB3ZkiTwzVmd1OBlg1f6eFLrKwwcLyYo6BX1g,13389
-deepdoctection-0.43.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-deepdoctection-0.43.3.dist-info/top_level.txt,sha256=hs2DdoOL9h4mnHhmO82BT4pz4QATIoOZ20PZmlnxFI8,15
-deepdoctection-0.43.3.dist-info/RECORD,,
+deepdoctection-0.43.5.dist-info/licenses/LICENSE,sha256=GQ0rUvuGdrMNEI3iHK5UQx6dIMU1QwAuyXsxUHn5MEQ,11351
+deepdoctection-0.43.5.dist-info/METADATA,sha256=EeIEGN2SrcUzSny93poDmEM7Fogqqiep_XDHOs--XpM,14782
+deepdoctection-0.43.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+deepdoctection-0.43.5.dist-info/top_level.txt,sha256=hs2DdoOL9h4mnHhmO82BT4pz4QATIoOZ20PZmlnxFI8,15
+deepdoctection-0.43.5.dist-info/RECORD,,