sinapsis-deepseek-ocr 0.1.0__py3-none-any.whl

sinapsis_deepseek_ocr-0.1.0.dist-info/METADATA

@@ -0,0 +1,295 @@
+Metadata-Version: 2.4
+Name: sinapsis-deepseek-ocr
+Version: 0.1.0
+Summary: A powerful DeepSeek-based Optical Character Recognition (OCR) implementation supporting text extraction and grounding.
+Author-email: SinapsisAI <dev@sinapsis.tech>
+Project-URL: Homepage, https://sinapsis.tech
+Project-URL: Documentation, https://docs.sinapsis.tech/docs
+Project-URL: Tutorials, https://docs.sinapsis.tech/tutorials
+Project-URL: Repository, https://github.com/Sinapsis-AI/sinapsis-ocr.git
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sinapsis>=0.2.24
+Requires-Dist: flash-attn>=2.8.3
+Requires-Dist: torch==2.8.0
+Requires-Dist: transformers==4.46.3
+Requires-Dist: tokenizers==0.20.3
+Requires-Dist: einops>=0.8.1
+Requires-Dist: addict>=2.4.0
+Requires-Dist: easydict>=1.13
+Requires-Dist: accelerate>=1.12.0
+Requires-Dist: sinapsis-generic-data-tools>=0.1.11
+Provides-Extra: sinapsis-data-readers
+Requires-Dist: sinapsis-data-readers[opencv]>=0.1.0; extra == "sinapsis-data-readers"
+Provides-Extra: sinapsis-data-writers
+Requires-Dist: sinapsis-data-writers>=0.1.0; extra == "sinapsis-data-writers"
+Provides-Extra: sinapsis-data-visualization
+Requires-Dist: sinapsis-data-visualization[visualization-matplotlib]>=0.1.0; extra == "sinapsis-data-visualization"
+Provides-Extra: all
+Requires-Dist: sinapsis-deepseek-ocr[sinapsis-data-readers]; extra == "all"
+Requires-Dist: sinapsis-deepseek-ocr[sinapsis-data-writers]; extra == "all"
+Requires-Dist: sinapsis-deepseek-ocr[sinapsis-data-visualization]; extra == "all"
+Dynamic: license-file
+
+<h1 align="center">
+<br>
+<a href="https://sinapsis.tech/">
+  <img
+    src="https://github.com/Sinapsis-AI/brand-resources/blob/main/sinapsis_logo/4x/logo.png?raw=true"
+    alt="" width="300">
+</a><br>
+Sinapsis DeepSeek OCR
+<br>
+</h1>
+
+<h4 align="center">DeepSeek-based Optical Character Recognition (OCR) for images</h4>
+
+<p align="center">
+<a href="#installation">🐍 Installation</a> •
+<a href="#features">🚀 Features</a> •
+<a href="#usage">📚 Usage example</a> •
+<a href="#webapp">🌐 Webapp</a> •
+<a href="#documentation">📙 Documentation</a> •
+<a href="#license">🔍 License</a>
+</p>
+
+**Sinapsis DeepSeek OCR** provides a powerful implementation for extracting text from images using DeepSeek's OCR model. It supports optional grounding for bounding box extraction.
+
+<h2 id="installation">🐍 Installation</h2>
+
+Install using your package manager of choice. We encourage the use of <code>uv</code>
+
+Example with <code>uv</code>:
+
+```bash
+  uv pip install sinapsis-deepseek-ocr --extra-index-url https://pypi.sinapsis.tech
+```
+ or with raw <code>pip</code>:
+```bash
+  pip install sinapsis-deepseek-ocr --extra-index-url https://pypi.sinapsis.tech
+```
+
+> [!IMPORTANT]
+> Templates may require extra dependencies. For development, we recommend installing the package with all the optional dependencies:
+>
+
+with <code>uv</code>:
+
+```bash
+  uv pip install sinapsis-deepseek-ocr[all] --extra-index-url https://pypi.sinapsis.tech
+```
+ or with raw <code>pip</code>:
+```bash
+  pip install sinapsis-deepseek-ocr[all] --extra-index-url https://pypi.sinapsis.tech
+```
+
+> [!TIP]
+> Use CLI command ```sinapsis info --all-template-names``` to show a list with all the available Template names installed with Sinapsis OCR.
+
+> [!TIP]
+> Use CLI command ```sinapsis info --example-template-config DeepSeekOCRInference``` to produce an example Agent config for the DeepSeekOCRInference template.
+
+<h2 id="features">🚀 Features</h2>
+
+<h3>Templates Supported</h3>
+
+This module includes a template tailored for the DeepSeek OCR engine:
+
+- **DeepSeekOCRInference**: Uses DeepSeek's OCR model to extract text from images. Supports optional grounding for bounding box extraction.
+
+<details>
+<summary><strong><span style="font-size: 1.25em;">DeepSeekOCRInference Attributes</span></strong></summary>
+
+- **`prompt`** (str): The prompt to send to the model. Defaults to `"OCR the image."`.
+- **`enable_grounding`** (bool): Whether to enable grounding for bbox extraction. Defaults to `False`.
+- **`mode`** (str): The inference mode. Options: `"tiny"`, `"small"`, `"gundam"`, `"base"`, `"large"`. Defaults to `"base"`.
+- **`init_args`** (DeepSeekOCRInitArgs): Initialization arguments for the model including:
+  - `pretrained_model_name_or_path`: Model identifier. Defaults to `"deepseek-ai/DeepSeek-OCR"`.
+  - `torch_dtype`: Model precision (`"float16"`, `"bfloat16"`, `"auto"`). Defaults to `"auto"`.
+  - `attn_implementation`: Attention implementation. Defaults to `"flash_attention_2"`.
+  - **Note**: This model requires CUDA. CPU inference is not supported.
+
+</details>
+
+<h2 id="usage">📚 Usage example</h2>
+
+<details>
+<summary><strong><span style="font-size: 1.4em;">Text Extraction (No Grounding)</span></strong></summary>
+
+```yaml
+agent:
+  name: deepseek_ocr_agent
+  description: Agent to run inference with DeepSeek OCR
+
+templates:
+- template_name: InputTemplate
+  class_name: InputTemplate
+  attributes: {}
+
+- template_name: FolderImageDatasetCV2
+  class_name: FolderImageDatasetCV2
+  template_input: InputTemplate
+  attributes:
+    data_dir: dataset/input
+
+- template_name: DeepSeekOCRInference
+  class_name: DeepSeekOCRInference
+  template_input: FolderImageDatasetCV2
+  attributes:
+    prompt: "Perform OCR."
+    enable_grounding: false
+    mode: base
+```
+</details>
+
+<details>
+<summary><strong><span style="font-size: 1.4em;">With Grounding (Bounding Boxes)</span></strong></summary>
+
+```yaml
+agent:
+  name: deepseek_ocr_grounding_agent
+  description: Agent with grounding for bbox extraction
+
+templates:
+- template_name: InputTemplate
+  class_name: InputTemplate
+  attributes: {}
+
+- template_name: FolderImageDatasetCV2
+  class_name: FolderImageDatasetCV2
+  template_input: InputTemplate
+  attributes:
+    data_dir: dataset/input
+
+- template_name: DeepSeekOCRInference
+  class_name: DeepSeekOCRInference
+  template_input: FolderImageDatasetCV2
+  attributes:
+    prompt: "Convert the document to markdown."
+    enable_grounding: true
+    mode: base
+
+- template_name: BBoxDrawer
+  class_name: BBoxDrawer
+  template_input: DeepSeekOCRInference
+  attributes:
+    draw_confidence: True
+    draw_extra_labels: True
+
+- template_name: ImageSaver
+  class_name: ImageSaver
+  template_input: BBoxDrawer
+  attributes:
+    save_dir: output
+    root_dir: dataset
+```
+</details>
+
+To run, simply use:
+
+```bash
+sinapsis run name_of_the_config.yml
+```
+
+<h2 id="webapp">🌐 Webapp</h2>
+
+The webapp provides a simple interface to extract text from images using DeepSeek OCR. Upload your image, and the app will process it and display the detected text.
+
+> [!IMPORTANT]
+> To run the app you first need to clone the sinapsis-ocr repository:
+
+```bash
+git clone https://github.com/Sinapsis-ai/sinapsis-ocr.git
+cd sinapsis-ocr
+```
+
+> [!NOTE]
+> If you'd like to enable external app sharing in Gradio, `export GRADIO_SHARE_APP=True`
+
+> [!IMPORTANT]
+> To use DeepSeek OCR in the webapp, set the environment variable:
+> `AGENT_CONFIG_PATH=/app/packages/sinapsis_deepseek_ocr/src/sinapsis_deepseek_ocr/configs/inference.yaml`
+
+<details>
+<summary id="docker"><strong><span style="font-size: 1.4em;">🐳 Docker</span></strong></summary>
+
+**IMPORTANT** This docker image depends on the sinapsis:base image. Please refer to the official [sinapsis](https://github.com/Sinapsis-ai/sinapsis?tab=readme-ov-file#docker) instructions to Build with Docker.
+
+1. **Build the sinapsis-ocr image**:
+
+```bash
+docker compose -f docker/compose.yaml build
+```
+
+2. **Start the app container**:
+
+```bash
+docker compose -f docker/compose_app.yaml up
+```
+
+3. **Check the status**:
+
+```bash
+docker logs -f sinapsis-ocr-app
+```
+
+4. The logs will display the URL to access the webapp, e.g.:
+
+**NOTE**: The url can be different, check the output of logs
+
+```bash
+Running on local URL:  http://127.0.0.1:7860
+```
+
+5. To stop the app:
+
+```bash
+docker compose -f docker/compose_app.yaml down
+```
+
+</details>
+
+<details>
+<summary id="uv"><strong><span style="font-size: 1.4em;">💻 UV</span></strong></summary>
+
+To run the webapp using the <code>uv</code> package manager, please:
+
+1. **Create the virtual environment and sync the dependencies**:
+
+```bash
+uv sync --frozen
+```
+
+2. **Install packages**:
+```bash
+uv pip install sinapsis-deepseek-ocr[all] --extra-index-url https://pypi.sinapsis.tech
+```
+3. **Run the webapp**:
+
+```bash
+uv run webapps/gradio_ocr.py
+```
+
+4. **The terminal will display the URL to access the webapp, e.g.**:
+
+```bash
+Running on local URL:  http://127.0.0.1:7860
+```
+NOTE: The url can be different, check the output of the terminal
+
+5. To stop the app press `Control + C` on the terminal
+
+</details>
+
+<h2 id="documentation">📙 Documentation</h2>
+
+Documentation for this and other sinapsis packages is available on the [sinapsis website](https://docs.sinapsis.tech/docs)
+
+Tutorials for different projects within sinapsis are available at [sinapsis tutorials page](https://docs.sinapsis.tech/tutorials)
+
+<h2 id="license">🔍 License</h2>
+
+This project is licensed under the AGPLv3 license, which encourages open collaboration and sharing. For more details, please refer to the [LICENSE](LICENSE) file.
+
+For commercial use, please refer to our [official Sinapsis website](https://sinapsis.tech) for information on obtaining a commercial license.

sinapsis_deepseek_ocr-0.1.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+sinapsis_deepseek_ocr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sinapsis_deepseek_ocr/helpers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sinapsis_deepseek_ocr/helpers/bbox_utils.py,sha256=3lkYXPUP_bM0G1PClBA8364dtU9x9JCq_r_FaDyqX7I,565
+sinapsis_deepseek_ocr/helpers/grounding_parser.py,sha256=nFKjP1oR1wMgIGhPImM49I2DJ_8ThESsUER8rDUaVpA,1176
+sinapsis_deepseek_ocr/helpers/mode_registry.py,sha256=Waj27UsI9dOB9ATjfIxJgM-vOXUM_9JPlfqKzfmvBnY,1267
+sinapsis_deepseek_ocr/helpers/schemas.py,sha256=b6TsFzVii6wYe5FvoW4r1y1wg2906D8anDboDRqTQw4,2396
+sinapsis_deepseek_ocr/helpers/tags.py,sha256=-drXXyKOvPDlA5ykdpNMGrRd1nJJ7JZQ6xNUmU1FI-I,547
+sinapsis_deepseek_ocr/templates/__init__.py,sha256=4bVYh-bWmJj-g9ysLoFLcfIlHQzqlg-Pl-BADYuBl74,498
+sinapsis_deepseek_ocr/templates/deepseek_ocr_inference.py,sha256=PrHYjzP9TzjKVZg7bwApocq7MSmoyv2Mi8mVluWt6KM,7809
+sinapsis_deepseek_ocr-0.1.0.dist-info/licenses/LICENSE,sha256=ILBn-G3jdarm2w8oOrLmXeJNU3czuJvVhDLBASWdhM8,34522
+sinapsis_deepseek_ocr-0.1.0.dist-info/METADATA,sha256=2hFdUbA425nS20ZrRobECG0D57jZg86m13uHh6enWkk,9304
+sinapsis_deepseek_ocr-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sinapsis_deepseek_ocr-0.1.0.dist-info/top_level.txt,sha256=hb_Gw4JQgFdjuF9wjm4wwajLTiEhI79jzug9vgRbHv0,22
+sinapsis_deepseek_ocr-0.1.0.dist-info/RECORD,,

sinapsis_deepseek_ocr-0.1.0.dist-info/WHEEL

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