deepdoctection 0.43__tar.gz → 0.43.3__tar.gz

{deepdoctection-0.43 → deepdoctection-0.43.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deepdoctection
-Version: 0.43
+Version: 0.43.3
 Summary: Repository for Document AI
 Home-page: https://github.com/deepdoctection/deepdoctection
 Author: Dr. Janis Meyer
@@ -192,7 +192,7 @@ Check the demo of a document layout analysis pipeline with OCR on 🤗
 - Fine-tuning and evaluation tools.
 - Lot's of [tutorials](https://github.com/deepdoctection/notebooks)
 
-Have a look at the [**introduction notebook**](https://github.com/deepdoctection/notebooks/blob/main/Get_Started.ipynb)
+Have a look at the [**introduction notebook**](https://github.com/deepdoctection/notebooks/blob/main/Analyzer_Get_Started.ipynb)
 for an easy start.
 
 Check the [**release notes**](https://github.com/deepdoctection/deepdoctection/releases) for recent updates.
@@ -245,11 +245,11 @@ alt="text" width="40%">
 
 ## Requirements
 
-![requirements](https://github.com/deepdoctection/deepdoctection/raw/master/docs/tutorials/_imgs/requirements_deepdoctection_220525.png)
+![requirements](https://github.com/deepdoctection/deepdoctection/raw/master/docs/tutorials/_imgs/install_01.png)
 
 - Linux or macOS. Windows is not supported but there is a [Dockerfile](./docker/pytorch-cpu-jupyter/Dockerfile) available.
 - Python >= 3.9
-- 1.13 \<= PyTorch **or** 2.11 \<= Tensorflow < 2.16. (For lower Tensorflow versions the code will only run on a GPU).
+- 2.2 \<= PyTorch **or** 2.11 \<= Tensorflow < 2.16. (For lower Tensorflow versions the code will only run on a GPU).
   Tensorflow support will be stopped from Python 3.11 onwards.
 - To fine-tune models, a GPU is recommended.
 
@@ -344,8 +344,7 @@ pip install ".[tf]" # or "pip install -e .[tf]"
 
 ### 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).
+Pre-existing Docker images can be downloaded from the [Docker hub](https://hub.docker.com/r/deepdoctection/deepdoctection).
 
 ```
 docker pull deepdoctection/deepdoctection:<release_tag> 

{deepdoctection-0.43 → deepdoctection-0.43.3}/README.md

@@ -49,7 +49,7 @@ Check the demo of a document layout analysis pipeline with OCR on 🤗
 - Fine-tuning and evaluation tools.
 - Lot's of [tutorials](https://github.com/deepdoctection/notebooks)
 
-Have a look at the [**introduction notebook**](https://github.com/deepdoctection/notebooks/blob/main/Get_Started.ipynb)
+Have a look at the [**introduction notebook**](https://github.com/deepdoctection/notebooks/blob/main/Analyzer_Get_Started.ipynb)
 for an easy start.
 
 Check the [**release notes**](https://github.com/deepdoctection/deepdoctection/releases) for recent updates.
@@ -102,11 +102,11 @@ alt="text" width="40%">
 
 ## Requirements
 
-![requirements](https://github.com/deepdoctection/deepdoctection/raw/master/docs/tutorials/_imgs/requirements_deepdoctection_220525.png)
+![requirements](https://github.com/deepdoctection/deepdoctection/raw/master/docs/tutorials/_imgs/install_01.png)
 
 - Linux or macOS. Windows is not supported but there is a [Dockerfile](./docker/pytorch-cpu-jupyter/Dockerfile) available.
 - Python >= 3.9
-- 1.13 \<= PyTorch **or** 2.11 \<= Tensorflow < 2.16. (For lower Tensorflow versions the code will only run on a GPU).
+- 2.2 \<= PyTorch **or** 2.11 \<= Tensorflow < 2.16. (For lower Tensorflow versions the code will only run on a GPU).
   Tensorflow support will be stopped from Python 3.11 onwards.
 - To fine-tune models, a GPU is recommended.
 
@@ -201,8 +201,7 @@ pip install ".[tf]" # or "pip install -e .[tf]"
 
 ### 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).
+Pre-existing Docker images can be downloaded from the [Docker hub](https://hub.docker.com/r/deepdoctection/deepdoctection).
 
 ```
 docker pull deepdoctection/deepdoctection:<release_tag> 

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection/__init__.py

@@ -25,11 +25,11 @@ from .utils.logger import LoggingRecord, logger
 
 # pylint: enable=wrong-import-position
 
-__version__ = "0.43"
+__version__ = "0.43.3"
 
 _IMPORT_STRUCTURE = {
     "analyzer": ["config_sanity_checks", "get_dd_analyzer", "ServiceFactory"],
-    "configs": [],
+    "configs": ["update_cfg_from_defaults"],
     "dataflow": [
         "DataFlowTerminated",
         "DataFlowResetStateNotCalled",
@@ -98,6 +98,7 @@ _IMPORT_STRUCTURE = {
         "List",
         "Cell",
         "Table",
+        "IMAGE_DEFAULTS",
         "Page",
     ],
     "datasets": [

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection/analyzer/config.py

@@ -902,3 +902,18 @@ cfg.LAYOUT_LINK.CHILD_CATEGORIES = [LayoutType.CAPTION]
 # Freezes the configuration to make it immutable.
 # This prevents accidental modification at runtime.
 cfg.freeze()
+
+def update_cfg_from_defaults() -> None:
+    """
+    Update the configuration with current values from IMAGE_DEFAULTS.
+    """
+    cfg.freeze(False)
+
+    # Update all dependent fields from IMAGE_DEFAULTS
+    cfg.TEXT_CONTAINER = IMAGE_DEFAULTS.TEXT_CONTAINER
+    cfg.WORD_MATCHING.PARENTAL_CATEGORIES = IMAGE_DEFAULTS.TEXT_BLOCK_CATEGORIES
+    cfg.TEXT_ORDERING.TEXT_BLOCK_CATEGORIES = IMAGE_DEFAULTS.TEXT_BLOCK_CATEGORIES
+    cfg.TEXT_ORDERING.FLOATING_TEXT_BLOCK_CATEGORIES = IMAGE_DEFAULTS.FLOATING_TEXT_BLOCK_CATEGORIES
+
+    # Re-freeze the configuration
+    cfg.freeze()

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection/datapoint/image.py

@@ -479,8 +479,8 @@ class Image:
 
     def remove(
         self,
-        annotation_ids: Optional[Union[str, list[str]]] = None,
-        service_ids: Optional[Union[str, list[str]]] = None,
+        annotation_ids: Optional[Union[str, Sequence[str]]] = None,
+        service_ids: Optional[Union[str, Sequence[str]]] = None,
     ) -> None:
         """
         Instead of removing consider deactivating annotations.

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection/datapoint/view.py

@@ -183,7 +183,7 @@ class Word(ImageAnnotationBaseView):
         attr_names = (
             set(WordType)
             .union(super().get_attribute_names())
-            .union({Relationships.READING_ORDER, Relationships.LAYOUT_LINK})
+            .union({Relationships.READING_ORDER, Relationships.LAYOUT_LINK, Relationships.LINK})
         )
         return {attr_name.value if isinstance(attr_name, ObjectTypes) else attr_name for attr_name in attr_names}
 
@@ -773,6 +773,7 @@ class Page(Image):
         "figures",
         "residual_layouts",
         "document_summary",
+        "document_mapping",
     }
     include_residual_text_container: bool = True
 
@@ -1389,19 +1390,32 @@ class Page(Image):
             include_residual_text_container=include_residual_text_container,
         )
 
-    def get_token(self) -> list[Mapping[str, str]]:
+    def get_entities(self) -> list[Mapping[str, str]]:
         """
         Returns:
-             A list of tuples with word and non default token tags
+             A list of dicts with the following structure:
+
+            ```python
+            {
+                "word": str,  # word characters
+                "entity": str, # token tag
+                "annotation_id": str, # annotation id of the word
+                "successor_annotation_id": Optional[str] # annotation_id of the successor word, if any
+            }
+            ```
+
         """
         block_with_order = self._order("layouts")
         all_words = []
         for block in block_with_order:
             all_words.extend(block.get_ordered_words())  # type: ignore
         return [
-            {"word": word.CHARACTERS, "entity": word.TOKEN_TAG}
+            {"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)
+            if word.token_tag not in (TokenClasses.OTHER, None)
         ]
 
     def __copy__(self) -> Page:

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection/extern/base.py

@@ -502,6 +502,7 @@ class TokenClassResult:
        semantic_name: semantic name
        bio_tag: bio tag
        score: prediction score
+       successor_uuid: uuid of the next token in the sequence
     """
 
     uuid: str
@@ -512,6 +513,7 @@ class TokenClassResult:
     bio_tag: ObjectTypes = DefaultType.DEFAULT_TYPE
     score: Optional[float] = None
     token_id: Optional[int] = None
+    successor_uuid: Optional[str] = None
 
 
 @dataclass

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection/extern/doctrocr.py

@@ -269,7 +269,10 @@ 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]:
         """
@@ -424,7 +427,7 @@ class DoctrTextRecognizer(TextRecognizer):
         return _get_doctr_requirements()
 
     def clone(self) -> DoctrTextRecognizer:
-        return self.__class__(self.architecture, self.path_weights, self.device, self.lib)
+        return self.__class__(self.architecture, self.path_weights, self.device, self.lib, self.path_config_json)
 
     @staticmethod
     def load_model(

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection/extern/texocr.py

@@ -60,7 +60,7 @@ def _textract_to_detectresult(response: JsonDict, width: int, height: int, text_
     return all_results
 
 
-def predict_text(np_img: PixelValues, client: boto3.client, text_lines: bool) -> list[DetectionResult]:  # type: ignore
+def predict_text(np_img: PixelValues, client: boto3.client, text_lines: bool) -> list[DetectionResult]:
     """
     Calls AWS Textract client (`detect_document_text`) and returns plain OCR results.
     AWS account required.

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection/mapper/xfundstruct.py

@@ -200,7 +200,7 @@ def xfund_to_image(
                 ann_ids.extend(entity_id_to_ann_id[linked_entity])
             for ann_id in ann_ids:
                 if ann_id != word.annotation_id:
-                    word.dump_relationship(Relationships.SEMANTIC_ENTITY_LINK, ann_id)
+                    word.dump_relationship(Relationships.LINK, ann_id)
 
     if mapping_context.context_error:
         return None

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection/pipe/anngen.py

@@ -19,7 +19,7 @@
 Datapoint manager
 """
 from dataclasses import asdict
-from typing import Optional, Union
+from typing import Optional, Union, Sequence
 
 import numpy as np
 
@@ -372,6 +372,19 @@ class DatapointManager:
             return None
         return ann.annotation_id
 
+    def remove_annotations(self, annotation_ids: Sequence[str]) -> None:
+        """
+        Removes the annotation by the given `annotation_id`.
+
+        Args:
+            annotation_ids: The `annotation_id` to remove.
+        """
+        self.assert_datapoint_passed()
+        self.datapoint.remove(annotation_ids)
+        for ann_id in annotation_ids:
+            if ann_id in self._cache_anns:
+                self._cache_anns.pop(ann_id)
+
     def deactivate_annotation(self, annotation_id: str) -> None:
         """
         Deactivates the annotation by the given `annotation_id`.

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection/pipe/order.py

@@ -738,10 +738,8 @@ class TextOrderService(TextLineServiceMixin):
                 text_block_anns.extend(residual_text_container_anns)
         for text_block_ann in text_block_anns:
             self.order_text_in_text_block(text_block_ann)
-        floating_text_block_anns_to_order = [
-            ann for ann in text_block_anns if ann.category_name in self.floating_text_block_categories
-        ]
-        self.order_blocks(floating_text_block_anns_to_order)
+        floating_text_block_anns = dp.get_annotation(category_names=self.floating_text_block_categories)
+        self.order_blocks(floating_text_block_anns)
         self._create_columns()
 
     def _create_columns(self) -> None:
@@ -803,9 +801,14 @@ class TextOrderService(TextLineServiceMixin):
         if self.include_residual_text_container:
             add_category.append(LayoutType.LINE)
 
-        assert set(self.floating_text_block_categories) <= set(
+        if set(self.floating_text_block_categories) <= set(
             self.text_block_categories + tuple(add_category)
-        ), "floating_text_block_categories must be a subset of text_block_categories"
+        ):
+            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-0.43 → deepdoctection-0.43.3}/deepdoctection/utils/context.py

@@ -38,7 +38,7 @@ __all__ = ["timeout_manager", "save_tmp_file", "timed_operation"]
 
 
 @contextmanager
-def timeout_manager(proc: Any, seconds: Optional[int] = None) -> Iterator[str]:  # type: ignore
+def timeout_manager(proc: Any, seconds: Optional[int] = None) -> Iterator[str]:
     """
     Manager for time handling while some process is being called.
 

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection/utils/develop.py

@@ -71,6 +71,7 @@ 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 → deepdoctection-0.43.3}/deepdoctection/utils/env_info.py

@@ -462,7 +462,7 @@ def pt_info(data: KeyValEnvInfos) -> KeyValEnvInfos:
                 data.append(("torchvision arch flags", msg))
             except (ImportError, AttributeError):
                 data.append(("torchvision._C", "Not found"))
-    except AttributeError:
+    except (AttributeError, ModuleNotFoundError):
         data.append(("torchvision", "unknown"))
 
     return data

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection/utils/file_utils.py

@@ -12,7 +12,6 @@ import importlib.util
 import multiprocessing as mp
 import string
 import subprocess
-import sys
 from os import environ, path
 from shutil import which
 from types import ModuleType
@@ -22,7 +21,6 @@ import importlib_metadata
 from packaging import version
 
 from .error import DependencyError
-from .logger import LoggingRecord, logger
 from .metacfg import AttrDict
 from .types import PathLikeOrStr, Requirement
 
@@ -662,13 +660,6 @@ def get_doctr_requirement() -> Requirement:
         On macOS, if `poppler` is not available, this function will recursively check the requirement.
         It is not yet known how to check whether `pango`, `gdk-pixbuf`, and `libffi` are installed.
     """
-    if sys.platform == "darwin":
-        if not get_poppler_version():
-            return get_doctr_requirement()
-        # don't know yet how to check whether pango gdk-pixbuf libffi are installed
-        logger.info(
-            LoggingRecord("package requires weasyprint. Check that poppler pango gdk-pixbuf libffi are installed")
-        )
     return "doctr", doctr_available(), _DOCTR_ERR_MSG
 
 

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection/utils/settings.py

@@ -80,6 +80,7 @@ class SummaryType(ObjectTypes):
 
     SUMMARY = "summary"
     DOCUMENT_SUMMARY = "document_summary"
+    DOCUMENT_MAPPING = "document_mapping"
 
 
 @object_types_registry.register("DocumentType")
@@ -228,8 +229,9 @@ class Relationships(ObjectTypes):
 
     CHILD = "child"
     READING_ORDER = "reading_order"
-    SEMANTIC_ENTITY_LINK = "semantic_entity_link"
+    LINK = "link"
     LAYOUT_LINK = "layout_link"
+    SUCCESSOR = "successor"
 
 
 @object_types_registry.register("Languages")

{deepdoctection-0.43 → deepdoctection-0.43.3}/deepdoctection.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deepdoctection
-Version: 0.43
+Version: 0.43.3
 Summary: Repository for Document AI
 Home-page: https://github.com/deepdoctection/deepdoctection
 Author: Dr. Janis Meyer
@@ -192,7 +192,7 @@ Check the demo of a document layout analysis pipeline with OCR on 🤗
 - Fine-tuning and evaluation tools.
 - Lot's of [tutorials](https://github.com/deepdoctection/notebooks)
 
-Have a look at the [**introduction notebook**](https://github.com/deepdoctection/notebooks/blob/main/Get_Started.ipynb)
+Have a look at the [**introduction notebook**](https://github.com/deepdoctection/notebooks/blob/main/Analyzer_Get_Started.ipynb)
 for an easy start.
 
 Check the [**release notes**](https://github.com/deepdoctection/deepdoctection/releases) for recent updates.
@@ -245,11 +245,11 @@ alt="text" width="40%">
 
 ## Requirements
 
-![requirements](https://github.com/deepdoctection/deepdoctection/raw/master/docs/tutorials/_imgs/requirements_deepdoctection_220525.png)
+![requirements](https://github.com/deepdoctection/deepdoctection/raw/master/docs/tutorials/_imgs/install_01.png)
 
 - Linux or macOS. Windows is not supported but there is a [Dockerfile](./docker/pytorch-cpu-jupyter/Dockerfile) available.
 - Python >= 3.9
-- 1.13 \<= PyTorch **or** 2.11 \<= Tensorflow < 2.16. (For lower Tensorflow versions the code will only run on a GPU).
+- 2.2 \<= PyTorch **or** 2.11 \<= Tensorflow < 2.16. (For lower Tensorflow versions the code will only run on a GPU).
   Tensorflow support will be stopped from Python 3.11 onwards.
 - To fine-tune models, a GPU is recommended.
 
@@ -344,8 +344,7 @@ pip install ".[tf]" # or "pip install -e .[tf]"
 
 ### 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).
+Pre-existing Docker images can be downloaded from the [Docker hub](https://hub.docker.com/r/deepdoctection/deepdoctection).
 
 ```
 docker pull deepdoctection/deepdoctection:<release_tag>