deepdoctection 0.43.2__tar.gz → 0.43.4__tar.gz

{deepdoctection-0.43.2 → deepdoctection-0.43.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deepdoctection
-Version: 0.43.2
+Version: 0.43.4
 Summary: Repository for Document AI
 Home-page: https://github.com/deepdoctection/deepdoctection
 Author: Dr. Janis Meyer

{deepdoctection-0.43.2 → deepdoctection-0.43.4}/deepdoctection/__init__.py

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

{deepdoctection-0.43.2 → deepdoctection-0.43.4}/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-0.43.2 → deepdoctection-0.43.4}/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.2 → deepdoctection-0.43.4}/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}
@@ -183,7 +195,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}
 
@@ -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,
@@ -1390,19 +1414,34 @@ 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.2 → deepdoctection-0.43.4}/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.2 → deepdoctection-0.43.4}/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-0.43.2 → deepdoctection-0.43.4}/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.2 → deepdoctection-0.43.4}/deepdoctection/pipe/anngen.py

@@ -19,7 +19,7 @@
 Datapoint manager
 """
 from dataclasses import asdict
-from typing import Optional, Union
+from typing import Optional, Sequence, Union
 
 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.2 → deepdoctection-0.43.4}/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-0.43.2 → deepdoctection-0.43.4}/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.2 → deepdoctection-0.43.4}/deepdoctection/utils/settings.py

@@ -229,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.2 → deepdoctection-0.43.4}/deepdoctection.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deepdoctection
-Version: 0.43.2
+Version: 0.43.4
 Summary: Repository for Document AI
 Home-page: https://github.com/deepdoctection/deepdoctection
 Author: Dr. Janis Meyer