Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: streamline kwarg handling #264

Merged
merged 7 commits into from
Oct 21, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## 0.7.10-dev1
## 0.7.10-dev2
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please make this is a release version


* Handle kwargs explicitly when needed, suppress otherwise
* fix: Reduce Chipper memory consumption on x86_64 cpus
* fix: Skips ordering elements coming from Chipper
* fix: After refactoring to introduce Chipper, annotate() weren't able to show text with extra info from elements, this is fixed now.
Expand Down
4 changes: 3 additions & 1 deletion test_unstructured_inference/inference/test_layout.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import os.path
import tempfile
from functools import partial
from unittest.mock import mock_open, patch
from unittest.mock import ANY, mock_open, patch

import numpy as np
import pytest
Expand Down Expand Up @@ -675,6 +675,8 @@ def test_process_file_with_model_routing(monkeypatch, model_type, is_detection_m
fixed_layouts=None,
extract_tables=False,
pdf_image_dpi=200,
extract_images_in_pdf=ANY,
image_output_dir_path=ANY,
)


Expand Down
2 changes: 1 addition & 1 deletion unstructured_inference/__version__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.7.10-dev1" # pragma: no cover
__version__ = "0.7.10-dev2" # pragma: no cover
18 changes: 4 additions & 14 deletions unstructured_inference/inference/layout.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,7 @@ def from_pages(cls, pages: List[PageLayout]) -> DocumentLayout:
def from_file(
cls,
filename: str,
detection_model: Optional[UnstructuredObjectDetectionModel] = None,
element_extraction_model: Optional[UnstructuredElementExtractionModel] = None,
fixed_layouts: Optional[List[Optional[List[TextRegion]]]] = None,
extract_tables: bool = False,
pdf_image_dpi: int = 200,
**kwargs,
) -> DocumentLayout:
Expand Down Expand Up @@ -108,11 +105,8 @@ def from_file(
image,
number=i + 1,
document_filename=filename,
detection_model=detection_model,
element_extraction_model=element_extraction_model,
layout=layout,
fixed_layout=fixed_layout,
extract_tables=extract_tables,
**kwargs,
)
pages.append(page)
Expand Down Expand Up @@ -453,10 +447,6 @@ def from_image(
def process_data_with_model(
data: BinaryIO,
model_name: Optional[str],
is_image: bool = False,
fixed_layouts: Optional[List[Optional[List[TextRegion]]]] = None,
extract_tables: bool = False,
pdf_image_dpi: int = 200,
**kwargs,
) -> DocumentLayout:
"""Processes pdf file in the form of a file handler (supporting a read method) into a
Expand All @@ -467,10 +457,6 @@ def process_data_with_model(
layout = process_file_with_model(
tmp_file.name,
model_name,
is_image=is_image,
fixed_layouts=fixed_layouts,
extract_tables=extract_tables,
pdf_image_dpi=pdf_image_dpi,
**kwargs,
)

Expand All @@ -484,6 +470,8 @@ def process_file_with_model(
fixed_layouts: Optional[List[Optional[List[TextRegion]]]] = None,
extract_tables: bool = False,
pdf_image_dpi: int = 200,
extract_images_in_pdf: bool = False,
image_output_dir_path: Optional[str] = None,
Comment on lines +473 to +474
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's the guide line here? When do we explicit set and when do we implicitly trust a kwarg does something down the call stack? And why are those two explicit here? It doesn't seem those two parameters are modified in this function and they are just passing through?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are explicit since we don't want them passed down to get_model, but we do want them passed down to .from_file

**kwargs,
) -> DocumentLayout:
"""Processes pdf file with name filename into a DocumentLayout by using a model identified by
Expand Down Expand Up @@ -514,6 +502,8 @@ def process_file_with_model(
fixed_layouts=fixed_layouts,
extract_tables=extract_tables,
pdf_image_dpi=pdf_image_dpi,
extract_images_in_pdf=extract_images_in_pdf,
image_output_dir_path=image_output_dir_path,
**kwargs,
)
)
Expand Down