sparrow-parse 0.3.4__tar.gz → 0.3.6__tar.gz

{sparrow-parse-0.3.4 → sparrow-parse-0.3.6}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.1
 Name: sparrow-parse
-Version: 0.3.4
-Summary: Sparrow Parse is a Python package for parsing and extracting information from documents.
+Version: 0.3.6
+Summary: Sparrow Parse is a Python package (part of Sparrow) for parsing and extracting information from documents.
 Home-page: https://github.com/katanaml/sparrow/tree/main/sparrow-data/parse
 Author: Andrej Baranovskij
 Author-email: andrejus.baranovskis@gmail.com
 License: UNKNOWN
 Project-URL: Homepage, https://github.com/katanaml/sparrow/tree/main/sparrow-data/parse
 Project-URL: Repository, https://github.com/katanaml/sparrow
-Keywords: llm,rag,vision
+Keywords: llm,vllm,ocr,vision
 Platform: UNKNOWN
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
@@ -21,7 +21,7 @@ Description-Content-Type: text/markdown
 
 ## Description
 
-This module implements Sparrow Parse [library](https://pypi.org/project/sparrow-parse/) with helpful methods for data pre-processing, parsing and extracting information.
+This module implements Sparrow Parse [library](https://pypi.org/project/sparrow-parse/) library with helpful methods for data pre-processing, parsing and extracting information. This library relies on Visual LLM functionality, Table Transformers and is part of Sparrow. Check main [README](https://github.com/katanaml/sparrow)
 
 ## Install
 
@@ -29,101 +29,16 @@ This module implements Sparrow Parse [library](https://pypi.org/project/sparrow-
 pip install sparrow-parse
 ```
 
-## Pre-processing
-
-### Unstructured
-
-```
-from sparrow_parse.extractor.unstructured_processor import UnstructuredProcessor
-
-processor = UnstructuredProcessor()
-
-content, table_content = processor.extract_data(
-        file_path,  # file to process
-        strategy,  # data processing strategy supported by unstructured
-        model_name,  # model supported by unstructured
-        options,  # table extraction into HTML format
-        local,  # True if running from CLI, or False if running from FastAPI
-        debug)  # Debug
-```
-
-Example:
-
-*file_path* - `/Users/andrejb/infra/shared/katana-git/sparrow/sparrow-ml/llm/data/invoice_1.pdf`
-
-*strategy* - `hi_res`
-
-*model_name* - `yolox`
-
-*options* - `['tables', 'unstructured']`
-
-*local* - `True`
-
-*debug* - `True`
-
-### Markdown
-
-```
-from sparrow_parse.extractor.markdown_processor import MarkdownProcessor
-
-processor = MarkdownProcessor()
-
-content, table_content = processor.extract_data(
-        file_path,  # file to process
-        options,  # table extraction into HTML format
-        local,  # True if running from CLI, or False if running from FastAPI
-        debug)  # Debug
-```
-
-Example:
-
-*file_path* - `/Users/andrejb/infra/shared/katana-git/sparrow/sparrow-ml/llm/data/invoice_1.pdf`
-
-*options* - `['tables', 'markdown']`
-
-*local* - `True`
-
-*debug* - `True`
-
 ## Parsing and extraction
 
-### HTML extractor
+### Sparrow Parse VL (vision-language model) extractor with Hugging Face GPU infra
 
 ```
-from sparrow_parse.extractor.html_extractor import HTMLExtractor
-
-extractor = HTMLExtractor()
-
-answer, targets_unprocessed = extractor.read_data(
-        target_columns,  # list of table columns data to fetch
-        data, # list of HTML tables
-        column_keywords,  # list of valid column names, can be empty. Useful to filter junk content
-        group_by_rows,  # JSON result grouping
-        update_targets,  # Set to true, if page contains multiple tables with the same columns
-        local,  # True if running from CLI, or False if running from FastAPI
-        debug)  # Debug
-
-```
-
-Example:
+# run locally: python -m sparrow_parse.extractors.vllm_extractor
 
-*target_columns* - `['description', 'qty', 'net_price', 'net_worth', 'vat', 'gross_worth']`
+from sparrow_parse.vllm.inference_factory import InferenceFactory
+from sparrow_parse.extractors.vllm_extractor import VLLMExtractor
 
-*data* - `list of HTML tables`
-
-*column_keywords* - `None`
-
-*group_by_rows* - `True`
-
-*update_targets* - `True`
-
-*local* - `True`
-
-*debug* - `True`
-
-### Sparrow Parse VL (vision-language) extractor
-
-```
 extractor = VLLMExtractor()
 
 # export HF_TOKEN="hf_"
@@ -141,17 +56,25 @@ model_inference_instance = factory.get_inference_instance()
 
 input_data = [
     {
-        "image": "/Users/andrejb/Documents/work/epik/bankstatement/bonds_table.png",
-        "text_input": "retrieve financial instruments data. return response in JSON format"
+        "file_path": "/data/oracle_10k_2014_q1_small.pdf",
+        "text_input": "retrieve {"table": [{"description": "str", "latest_amount": 0, "previous_amount": 0}]}. return response in JSON format"
     }
 ]
 
 # Now you can run inference without knowing which implementation is used
-result = extractor.run_inference(model_inference_instance, input_data, generic_query=False, debug=True)
-print("Inference Result:", result)
+results_array, num_pages = extractor.run_inference(model_inference_instance, input_data, generic_query=False,
+                                 debug_dir="/data/",
+                                 debug=True,
+                                 mode="static")
+
+for i, result in enumerate(results_array):
+    print(f"Result for page {i + 1}:", result)
+print(f"Number of pages: {num_pages}")
 ```
 
-## PDF optimization
+Use `mode="static"` if you want to simulate LLM call, without executing LLM backend.
+
+## PDF pre-processing
 
 ```
 from sparrow_parse.extractor.pdf_optimizer import PDFOptimizer
@@ -166,7 +89,7 @@ num_pages, output_files, temp_dir = pdf_optimizer.split_pdf_to_pages(file_path,
 
 Example:
 
-*file_path* - `/Users/andrejb/infra/shared/katana-git/sparrow/sparrow-ml/llm/data/invoice_1.pdf`
+*file_path* - `/data/invoice_1.pdf`
 
 *output_directory* - set to not `None`, for debug purposes only
 

{sparrow-parse-0.3.4 → sparrow-parse-0.3.6}/README.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-This module implements Sparrow Parse [library](https://pypi.org/project/sparrow-parse/) with helpful methods for data pre-processing, parsing and extracting information.
+This module implements Sparrow Parse [library](https://pypi.org/project/sparrow-parse/) library with helpful methods for data pre-processing, parsing and extracting information. This library relies on Visual LLM functionality, Table Transformers and is part of Sparrow. Check main [README](https://github.com/katanaml/sparrow)
 
 ## Install
 
@@ -10,101 +10,16 @@ This module implements Sparrow Parse [library](https://pypi.org/project/sparrow-
 pip install sparrow-parse
 ```
 
-## Pre-processing
-
-### Unstructured
-
-```
-from sparrow_parse.extractor.unstructured_processor import UnstructuredProcessor
-
-processor = UnstructuredProcessor()
-
-content, table_content = processor.extract_data(
-        file_path,  # file to process
-        strategy,  # data processing strategy supported by unstructured
-        model_name,  # model supported by unstructured
-        options,  # table extraction into HTML format
-        local,  # True if running from CLI, or False if running from FastAPI
-        debug)  # Debug
-```
-
-Example:
-
-*file_path* - `/Users/andrejb/infra/shared/katana-git/sparrow/sparrow-ml/llm/data/invoice_1.pdf`
-
-*strategy* - `hi_res`
-
-*model_name* - `yolox`
-
-*options* - `['tables', 'unstructured']`
-
-*local* - `True`
-
-*debug* - `True`
-
-### Markdown
-
-```
-from sparrow_parse.extractor.markdown_processor import MarkdownProcessor
-
-processor = MarkdownProcessor()
-
-content, table_content = processor.extract_data(
-        file_path,  # file to process
-        options,  # table extraction into HTML format
-        local,  # True if running from CLI, or False if running from FastAPI
-        debug)  # Debug
-```
-
-Example:
-
-*file_path* - `/Users/andrejb/infra/shared/katana-git/sparrow/sparrow-ml/llm/data/invoice_1.pdf`
-
-*options* - `['tables', 'markdown']`
-
-*local* - `True`
-
-*debug* - `True`
-
 ## Parsing and extraction
 
-### HTML extractor
+### Sparrow Parse VL (vision-language model) extractor with Hugging Face GPU infra
 
 ```
-from sparrow_parse.extractor.html_extractor import HTMLExtractor
-
-extractor = HTMLExtractor()
-
-answer, targets_unprocessed = extractor.read_data(
-        target_columns,  # list of table columns data to fetch
-        data, # list of HTML tables
-        column_keywords,  # list of valid column names, can be empty. Useful to filter junk content
-        group_by_rows,  # JSON result grouping
-        update_targets,  # Set to true, if page contains multiple tables with the same columns
-        local,  # True if running from CLI, or False if running from FastAPI
-        debug)  # Debug
-
-```
-
-Example:
+# run locally: python -m sparrow_parse.extractors.vllm_extractor
 
-*target_columns* - `['description', 'qty', 'net_price', 'net_worth', 'vat', 'gross_worth']`
+from sparrow_parse.vllm.inference_factory import InferenceFactory
+from sparrow_parse.extractors.vllm_extractor import VLLMExtractor
 
-*data* - `list of HTML tables`
-
-*column_keywords* - `None`
-
-*group_by_rows* - `True`
-
-*update_targets* - `True`
-
-*local* - `True`
-
-*debug* - `True`
-
-### Sparrow Parse VL (vision-language) extractor
-
-```
 extractor = VLLMExtractor()
 
 # export HF_TOKEN="hf_"
@@ -122,17 +37,25 @@ model_inference_instance = factory.get_inference_instance()
 
 input_data = [
     {
-        "image": "/Users/andrejb/Documents/work/epik/bankstatement/bonds_table.png",
-        "text_input": "retrieve financial instruments data. return response in JSON format"
+        "file_path": "/data/oracle_10k_2014_q1_small.pdf",
+        "text_input": "retrieve {"table": [{"description": "str", "latest_amount": 0, "previous_amount": 0}]}. return response in JSON format"
     }
 ]
 
 # Now you can run inference without knowing which implementation is used
-result = extractor.run_inference(model_inference_instance, input_data, generic_query=False, debug=True)
-print("Inference Result:", result)
+results_array, num_pages = extractor.run_inference(model_inference_instance, input_data, generic_query=False,
+                                 debug_dir="/data/",
+                                 debug=True,
+                                 mode="static")
+
+for i, result in enumerate(results_array):
+    print(f"Result for page {i + 1}:", result)
+print(f"Number of pages: {num_pages}")
 ```
 
-## PDF optimization
+Use `mode="static"` if you want to simulate LLM call, without executing LLM backend.
+
+## PDF pre-processing
 
 ```
 from sparrow_parse.extractor.pdf_optimizer import PDFOptimizer
@@ -147,7 +70,7 @@ num_pages, output_files, temp_dir = pdf_optimizer.split_pdf_to_pages(file_path,
 
 Example:
 
-*file_path* - `/Users/andrejb/infra/shared/katana-git/sparrow/sparrow-ml/llm/data/invoice_1.pdf`
+*file_path* - `/data/invoice_1.pdf`
 
 *output_directory* - set to not `None`, for debug purposes only
 

{sparrow-parse-0.3.4 → sparrow-parse-0.3.6}/setup.py

@@ -8,10 +8,10 @@ with open("requirements.txt", "r", encoding="utf-8") as fh:
 
 setup(
     name="sparrow-parse",
-    version="0.3.4",
+    version="0.3.6",
     author="Andrej Baranovskij",
     author_email="andrejus.baranovskis@gmail.com",
-    description="Sparrow Parse is a Python package for parsing and extracting information from documents.",
+    description="Sparrow Parse is a Python package (part of Sparrow) for parsing and extracting information from documents.",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/katanaml/sparrow/tree/main/sparrow-data/parse",
@@ -30,7 +30,7 @@ setup(
             'sparrow-parse=sparrow_parse:main',
         ],
     },
-    keywords="llm, rag, vision",
+    keywords="llm, vllm, ocr, vision",
     packages=find_packages(),
     python_requires='>=3.10',
     install_requires=requirements,

sparrow-parse-0.3.6/sparrow_parse/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.3.6'

sparrow-parse-0.3.6/sparrow_parse/extractors/vllm_extractor.py

@@ -0,0 +1,87 @@
+from sparrow_parse.vllm.inference_factory import InferenceFactory
+from sparrow_parse.helpers.pdf_optimizer import PDFOptimizer
+from rich import print
+import os
+import shutil
+
+
+class VLLMExtractor(object):
+    def __init__(self):
+        pass
+
+    def run_inference(self,
+                      model_inference_instance,
+                      input_data,
+                      generic_query=False,
+                      debug_dir=None,
+                      debug=False,
+                      mode=None):
+        if generic_query:
+            input_data[0]["text_input"] = "retrieve document data. return response in JSON format"
+
+        if debug:
+            print("Input Data:", input_data)
+
+        results_array = []
+
+        if self.is_pdf(input_data[0]["file_path"]):
+            pdf_optimizer = PDFOptimizer()
+            num_pages, output_files, temp_dir = pdf_optimizer.split_pdf_to_pages(input_data[0]["file_path"],
+                                                                                 debug_dir,
+                                                                                 True)
+
+            # Run inference on each page
+            for page_num, output_file in enumerate(output_files):
+                input_data[0]["file_path"] = output_file
+                if debug:
+                    print(f"Running inference on page {page_num + 1}...")
+
+                # Run inference on the page
+                result = model_inference_instance.inference(input_data, mode)
+                results_array.append(result)
+
+            shutil.rmtree(temp_dir, ignore_errors=True)
+            return results_array, num_pages
+
+        result = model_inference_instance.inference(input_data)
+        results_array.append(result)
+
+        return results_array, 1
+
+    def is_pdf(self, file_path):
+        return file_path.lower().endswith('.pdf')
+
+if __name__ == "__main__":
+    # run locally: python -m sparrow_parse.extractors.vllm_extractor
+
+    extractor = VLLMExtractor()
+
+    # # export HF_TOKEN="hf_"
+    # config = {
+    #     "method": "huggingface",  # Could be 'huggingface' or 'local_gpu'
+    #     "hf_space": "katanaml/sparrow-qwen2-vl-7b",
+    #     "hf_token": os.getenv('HF_TOKEN'),
+    #     # Additional fields for local GPU inference
+    #     # "device": "cuda", "model_path": "model.pth"
+    # }
+    #
+    # # Use the factory to get the correct instance
+    # factory = InferenceFactory(config)
+    # model_inference_instance = factory.get_inference_instance()
+    #
+    # input_data = [
+    #     {
+    #         "file_path": "/Users/andrejb/infra/shared/katana-git/sparrow/sparrow-ml/llm/data/oracle_10k_2014_q1_small.pdf",
+    #         "text_input": "retrieve {\"table\": [{\"description\": \"str\", \"latest_amount\": 0, \"previous_amount\": 0}]}. return response in JSON format"
+    #     }
+    # ]
+    #
+    # # Now you can run inference without knowing which implementation is used
+    # results_array, num_pages = extractor.run_inference(model_inference_instance, input_data, generic_query=False,
+    #                                  debug_dir="/Users/andrejb/infra/shared/katana-git/sparrow/sparrow-ml/llm/data/",
+    #                                  debug=True,
+    #                                  mode="static")
+    #
+    # for i, result in enumerate(results_array):
+    #     print(f"Result for page {i + 1}:", result)
+    # print(f"Number of pages: {num_pages}")

{sparrow-parse-0.3.4 → sparrow-parse-0.3.6}/sparrow_parse/helpers/pdf_optimizer.py

@@ -40,17 +40,18 @@ class PDFOptimizer(object):
             return number_of_pages, output_files, temp_dir
         else:
             # Convert the PDF to images
-            images = convert_from_path(file_path, dpi=400)
+            images = convert_from_path(file_path, dpi=300)
+            base_name = os.path.splitext(os.path.basename(file_path))[0]
 
             # Save the images to the temporary directory
             for i, image in enumerate(images):
-                output_filename = os.path.join(temp_dir, f'page_{i + 1}.jpg')
+                output_filename = os.path.join(temp_dir, f'{base_name}_page_{i + 1}.jpg')
                 image.save(output_filename, 'JPEG')
                 output_files.append(output_filename)
 
                 if output_dir:
                     # Save each image to the debug folder
-                    debug_output_filename = os.path.join(output_dir, f'page_{i + 1}.jpg')
+                    debug_output_filename = os.path.join(output_dir, f'{base_name}_page_{i + 1}.jpg')
                     image.save(debug_output_filename, 'JPEG')
 
             # Return the number of pages, the list of file paths, and the temporary directory
@@ -60,13 +61,17 @@ class PDFOptimizer(object):
 if __name__ == "__main__":
     pdf_optimizer = PDFOptimizer()
 
-    # output_directory = "/Users/andrejb/Documents/work/bankstatement/output_pages"
+    # output_directory = "/Users/andrejb/infra/shared/katana-git/sparrow/sparrow-ml/llm/data/"
     # # Ensure the output directory exists
     # os.makedirs(output_directory, exist_ok=True)
     #
     # # Split the optimized PDF into separate pages
-    # num_pages, output_files, temp_dir = pdf_optimizer.split_pdf_to_pages("/Users/andrejb/Documents/work/bankstatement/statement.pdf",
+    # num_pages, output_files, temp_dir = pdf_optimizer.split_pdf_to_pages("/Users/andrejb/infra/shared/katana-git/sparrow/sparrow-ml/llm/data/oracle_10k_2014_q1_small.pdf",
     #                                                                      output_directory,
-    #                                                                      False)
+    #                                                                      True)
+    #
+    # print(f"Number of pages: {num_pages}")
+    # print(f"Output files: {output_files}")
+    # print(f"Temporary directory: {temp_dir}")
     #
     # shutil.rmtree(temp_dir, ignore_errors=True)

{sparrow-parse-0.3.4 → sparrow-parse-0.3.6}/sparrow_parse/vllm/huggingface_inference.py

@@ -24,11 +24,15 @@ class HuggingFaceInference(ModelInference):
             return output_text
 
 
-    def inference(self, input_data):
+    def inference(self, input_data, mode=None):
+        if mode == "static":
+            simple_json = self.get_simple_json()
+            return simple_json
+
         client = Client(self.hf_space, hf_token=self.hf_token)
 
         result = client.predict(
-            image=handle_file(input_data[0]["image"]),
+            image=handle_file(input_data[0]["file_path"]),
             text_input=input_data[0]["text_input"],
             api_name="/run_inference"
         )

sparrow-parse-0.3.6/sparrow_parse/vllm/inference_base.py

@@ -0,0 +1,30 @@
+from abc import ABC, abstractmethod
+import json
+
+
+class ModelInference(ABC):
+    @abstractmethod
+    def inference(self, input_data, mode=None):
+        """This method should be implemented by subclasses."""
+        pass
+
+    def get_simple_json(self):
+        # Define a simple data structure
+        data = {
+          "table": [
+                {
+                  "description": "Revenues",
+                  "latest_amount": 12453,
+                  "previous_amount": 11445
+                },
+                {
+                  "description": "Operating expenses",
+                  "latest_amount": 9157,
+                  "previous_amount": 8822
+                }
+            ]
+        }
+
+        # Convert the dictionary to a JSON string
+        json_data = json.dumps(data, indent=4)
+        return json_data

{sparrow-parse-0.3.4 → sparrow-parse-0.3.6}/sparrow_parse/vllm/local_gpu_inference.py

@@ -8,7 +8,7 @@ class LocalGPUInference(ModelInference):
         self.device = device
         self.model.to(self.device)
 
-    def inference(self, input_data):
+    def inference(self, input_data, mode=None):
         self.model.eval()  # Set the model to evaluation mode
         with torch.no_grad():  # No need to calculate gradients
             input_tensor = torch.tensor(input_data).to(self.device)