deepdoctection 0.43.4__tar.gz → 0.43.5__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deepdoctection
-Version: 0.43.4
+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.4 → deepdoctection-0.43.5}/README.md

@@ -25,13 +25,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 
@@ -54,6 +50,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
@@ -99,8 +143,9 @@ alt="text" width="40%">
 </p>
 
 
+-----------------------------------------------------------------------------------------
 
-## Requirements
+# Requirements
 
 ![requirements](https://github.com/deepdoctection/deepdoctection/raw/master/docs/tutorials/_imgs/install_01.png)
 
@@ -119,11 +164,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:
 
@@ -145,7 +192,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.
@@ -175,7 +222,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
 
@@ -198,8 +245,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).
 
@@ -217,16 +263,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.4 → deepdoctection-0.43.5}/deepdoctection/__init__.py

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

{deepdoctection-0.43.4 → deepdoctection-0.43.5}/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-0.43.4 → deepdoctection-0.43.5}/deepdoctection.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deepdoctection
-Version: 0.43.4
+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.