-
Notifications
You must be signed in to change notification settings - Fork 4.5k
fix(table): add generic merged-cell reconciliation #3731
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
Open
dsolankii
wants to merge
5
commits into
docling-project:main
Choose a base branch
from
dsolankii:fix-table-topology-3698
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
e3b83bb
fix(table): add generic merged-cell reconciliation
dsolankii 39dbb56
fix(table): allow safe same-shape span repairs
dsolankii b3b9656
DCO Remediation Commit for dsolankii <soldarshu@gmail.com>
dsolankii c33338c
fix(table): narrow same-shape text-slot allowance
dsolankii 34a443b
fix(table): enforce local text ownership in reconciliation
dsolankii File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
390 changes: 390 additions & 0 deletions
390
docling/models/stages/table_structure/table_structure_acceptance.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,390 @@ | ||
| from __future__ import annotations | ||
|
|
||
| from dataclasses import dataclass | ||
|
|
||
|
|
||
| @dataclass(frozen=True) | ||
| class TableStructureAcceptanceReport: | ||
| accepted: bool | ||
| reason: str | ||
| baseline_rows: int | ||
| baseline_cols: int | ||
| candidate_rows: int | ||
| candidate_cols: int | ||
| baseline_token_count: int | ||
| preserved_token_count: int | ||
|
|
||
|
|
||
| def _normalized_cell_text(value: object) -> str: | ||
| return " ".join(str(value or "").split()).casefold() | ||
|
|
||
|
|
||
| def _nonempty_cell_texts(cells: list[object]) -> tuple[str, ...]: | ||
| return tuple( | ||
| text | ||
| for cell in cells | ||
| if (text := _normalized_cell_text(getattr(cell, "text", ""))) | ||
| ) | ||
|
|
||
|
|
||
| def _cell_text_tokens(cells: list[object]) -> tuple[str, ...]: | ||
| tokens: list[str] = [] | ||
| for text in _nonempty_cell_texts(cells): | ||
| tokens.extend(text.split()) | ||
|
|
||
| return tuple(tokens) | ||
|
|
||
|
|
||
| def _token_counts(tokens: tuple[str, ...]) -> dict[str, int]: | ||
| counts: dict[str, int] = {} | ||
| for token in tokens: | ||
| counts[token] = counts.get(token, 0) + 1 | ||
|
|
||
| return counts | ||
|
|
||
|
|
||
| def _count_tokens_preserved( | ||
| *, | ||
| baseline_cells: list[object], | ||
| candidate_cells: list[object], | ||
| ) -> int: | ||
| candidate_counts = _token_counts(_cell_text_tokens(candidate_cells)) | ||
|
|
||
| preserved = 0 | ||
| for token in _cell_text_tokens(baseline_cells): | ||
| available = candidate_counts.get(token, 0) | ||
| if available <= 0: | ||
| continue | ||
|
|
||
| candidate_counts[token] = available - 1 | ||
| preserved += 1 | ||
|
|
||
| return preserved | ||
|
|
||
|
|
||
| def _cell_index_range(cell: object, start_attr: str, end_attr: str) -> range: | ||
| start = getattr(cell, start_attr, None) | ||
| end = getattr(cell, end_attr, None) | ||
|
|
||
| if start is None or end is None: | ||
| return range(0) | ||
|
|
||
| return range(int(start), int(end)) | ||
|
|
||
|
|
||
| def _column_header_rows(cells: list[object]) -> set[int]: | ||
| rows: set[int] = set() | ||
|
|
||
| for cell in cells: | ||
| if not bool(getattr(cell, "column_header", False)): | ||
| continue | ||
|
|
||
| rows.update( | ||
| _cell_index_range( | ||
| cell, | ||
| "start_row_offset_idx", | ||
| "end_row_offset_idx", | ||
| ) | ||
| ) | ||
|
|
||
| return rows | ||
|
|
||
|
|
||
| def _row_header_cols(cells: list[object]) -> set[int]: | ||
| cols: set[int] = set() | ||
|
|
||
| for cell in cells: | ||
| if not bool(getattr(cell, "row_header", False)): | ||
| continue | ||
|
|
||
| cols.update( | ||
| _cell_index_range( | ||
| cell, | ||
| "start_col_offset_idx", | ||
| "end_col_offset_idx", | ||
| ) | ||
| ) | ||
|
|
||
| return cols | ||
|
|
||
|
|
||
| def _has_header_metadata_regression( | ||
| *, | ||
| baseline_cells: list[object], | ||
| candidate_cells: list[object], | ||
| ) -> bool: | ||
| baseline_column_header_rows = _column_header_rows(baseline_cells) | ||
| candidate_column_header_rows = _column_header_rows(candidate_cells) | ||
|
|
||
| baseline_row_header_cols = _row_header_cols(baseline_cells) | ||
| candidate_row_header_cols = _row_header_cols(candidate_cells) | ||
|
|
||
| return ( | ||
| candidate_column_header_rows != baseline_column_header_rows | ||
| or candidate_row_header_cols != baseline_row_header_cols | ||
| ) | ||
|
|
||
|
|
||
| def _cell_slot_key( | ||
| cell: object, | ||
| ) -> tuple[int | None, int | None, int | None, int | None]: | ||
| return ( | ||
| getattr(cell, "start_row_offset_idx", None), | ||
| getattr(cell, "end_row_offset_idx", None), | ||
| getattr(cell, "start_col_offset_idx", None), | ||
| getattr(cell, "end_col_offset_idx", None), | ||
| ) | ||
|
|
||
|
|
||
| def _slot_text_map( | ||
| cells: list[object], | ||
| ) -> dict[tuple[int | None, int | None, int | None, int | None], str]: | ||
| return { | ||
| _cell_slot_key(cell): _normalized_cell_text(getattr(cell, "text", "")) | ||
| for cell in cells | ||
| if _cell_slot_key(cell) != (None, None, None, None) | ||
| } | ||
|
|
||
|
|
||
| def _has_same_shape_text_slot_regression( | ||
| *, | ||
| baseline_cells: list[object], | ||
| candidate_cells: list[object], | ||
| ) -> bool: | ||
| return _slot_text_map(candidate_cells) != _slot_text_map(baseline_cells) | ||
|
|
||
|
|
||
| def _diagnostics_valid(diagnostics: object) -> bool: | ||
| return bool(getattr(diagnostics, "valid", True)) | ||
|
|
||
|
|
||
| def _diagnostic_issue_count(diagnostics: object) -> int: | ||
| total = 0 | ||
|
|
||
| for attr in ( | ||
| "overlaps", | ||
| "overlapping_cells", | ||
| "out_of_bounds", | ||
| "out_of_bounds_cells", | ||
| "invalid_spans", | ||
| "conflicts", | ||
| ): | ||
| value = getattr(diagnostics, attr, None) | ||
| if value is None: | ||
| continue | ||
|
|
||
| try: | ||
| total += len(value) | ||
| except TypeError: | ||
| if value: | ||
| total += 1 | ||
|
|
||
| return total | ||
|
|
||
|
|
||
| def _coverage_ratio(diagnostics: object) -> float | None: | ||
| value = getattr(diagnostics, "coverage_ratio", None) | ||
| if value is None: | ||
| return None | ||
|
|
||
| return float(value) | ||
|
|
||
|
|
||
| def _span_local_normalized_cell_text(cell: object) -> str: | ||
| return " ".join(str(getattr(cell, "text", "") or "").split()) | ||
|
|
||
|
|
||
| def _span_local_safe_int_or_none(value: object) -> int | None: | ||
| try: | ||
| return int(value) # type: ignore[arg-type] | ||
| except (TypeError, ValueError): | ||
| return None | ||
|
|
||
|
|
||
| def _span_local_cell_rect( | ||
| cell: object, | ||
| ) -> tuple[int | None, int | None, int | None, int | None]: | ||
| return ( | ||
| _span_local_safe_int_or_none(getattr(cell, "start_row_offset_idx", None)), | ||
| _span_local_safe_int_or_none(getattr(cell, "end_row_offset_idx", None)), | ||
| _span_local_safe_int_or_none(getattr(cell, "start_col_offset_idx", None)), | ||
| _span_local_safe_int_or_none(getattr(cell, "end_col_offset_idx", None)), | ||
| ) | ||
|
|
||
|
|
||
| def _span_local_rect_contains( | ||
| outer: tuple[int | None, int | None, int | None, int | None], | ||
| inner: tuple[int | None, int | None, int | None, int | None], | ||
| ) -> bool: | ||
| if None in outer or None in inner: | ||
| return False | ||
|
|
||
| outer_start_row, outer_end_row, outer_start_col, outer_end_col = outer | ||
| inner_start_row, inner_end_row, inner_start_col, inner_end_col = inner | ||
|
|
||
| return ( | ||
| outer_start_row <= inner_start_row | ||
| and inner_end_row <= outer_end_row | ||
| and outer_start_col <= inner_start_col | ||
| and inner_end_col <= outer_end_col | ||
| ) | ||
|
|
||
|
|
||
| def _span_local_text_rects_by_value( | ||
| cells: list[object], | ||
| ) -> dict[str, list[tuple[int | None, int | None, int | None, int | None]]]: | ||
| rects_by_text: dict[ | ||
| str, | ||
| list[tuple[int | None, int | None, int | None, int | None]], | ||
| ] = {} | ||
|
|
||
| for cell in cells: | ||
| text = _span_local_normalized_cell_text(cell) | ||
| if not text: | ||
| continue | ||
|
|
||
| rects_by_text.setdefault(text, []).append(_span_local_cell_rect(cell)) | ||
|
|
||
| return {text: sorted(rects) for text, rects in rects_by_text.items()} | ||
|
|
||
|
|
||
| def _same_shape_text_slot_changes_are_span_local( | ||
| *, | ||
| baseline_cells: list[object], | ||
| candidate_cells: list[object], | ||
| ) -> bool: | ||
| baseline_rects_by_text = _span_local_text_rects_by_value(baseline_cells) | ||
| candidate_rects_by_text = _span_local_text_rects_by_value(candidate_cells) | ||
|
|
||
| for text, baseline_rects in baseline_rects_by_text.items(): | ||
| candidate_rects = candidate_rects_by_text.get(text) | ||
|
|
||
| if candidate_rects is None: | ||
| return False | ||
|
|
||
| if baseline_rects == candidate_rects: | ||
| continue | ||
|
|
||
| if len(baseline_rects) != 1 or len(candidate_rects) != 1: | ||
| return False | ||
|
|
||
| baseline_rect = baseline_rects[0] | ||
| candidate_rect = candidate_rects[0] | ||
|
|
||
| if _span_local_rect_contains(candidate_rect, baseline_rect): | ||
| continue | ||
|
|
||
| if _span_local_rect_contains(baseline_rect, candidate_rect): | ||
| continue | ||
|
|
||
| return False | ||
|
|
||
| return True | ||
|
|
||
|
|
||
| def accept_reconciled_table_challenger( | ||
| *, | ||
| baseline_cells: list[object], | ||
| baseline_rows: int, | ||
| baseline_cols: int, | ||
| baseline_diagnostics: object, | ||
| candidate_cells: list[object], | ||
| candidate_rows: int, | ||
| candidate_cols: int, | ||
| candidate_diagnostics: object, | ||
| allow_same_shape_text_slot_change: bool = False, | ||
| ) -> TableStructureAcceptanceReport: | ||
| baseline_token_count = len(_cell_text_tokens(baseline_cells)) | ||
| preserved_token_count = _count_tokens_preserved( | ||
| baseline_cells=baseline_cells, | ||
| candidate_cells=candidate_cells, | ||
| ) | ||
|
|
||
| def reject(reason: str) -> TableStructureAcceptanceReport: | ||
| return TableStructureAcceptanceReport( | ||
| accepted=False, | ||
| reason=reason, | ||
| baseline_rows=baseline_rows, | ||
| baseline_cols=baseline_cols, | ||
| candidate_rows=candidate_rows, | ||
| candidate_cols=candidate_cols, | ||
| baseline_token_count=baseline_token_count, | ||
| preserved_token_count=preserved_token_count, | ||
| ) | ||
|
|
||
| def accept(reason: str) -> TableStructureAcceptanceReport: | ||
| return TableStructureAcceptanceReport( | ||
| accepted=True, | ||
| reason=reason, | ||
| baseline_rows=baseline_rows, | ||
| baseline_cols=baseline_cols, | ||
| candidate_rows=candidate_rows, | ||
| candidate_cols=candidate_cols, | ||
| baseline_token_count=baseline_token_count, | ||
| preserved_token_count=preserved_token_count, | ||
| ) | ||
|
|
||
| if candidate_rows <= 0 or candidate_cols <= 0: | ||
| return reject("candidate_empty_grid") | ||
|
|
||
| if not _diagnostics_valid(candidate_diagnostics): | ||
| return reject("candidate_invalid_topology") | ||
|
|
||
| if baseline_token_count and preserved_token_count < baseline_token_count: | ||
|
dsolankii marked this conversation as resolved.
Outdated
|
||
| return reject("text_token_regression") | ||
|
|
||
| grid_same_shape = ( | ||
| candidate_rows == baseline_rows and candidate_cols == baseline_cols | ||
| ) | ||
| grid_grew = candidate_rows > baseline_rows or candidate_cols > baseline_cols | ||
|
|
||
| # Same-shape repairs must not move text between logical slots. | ||
| # Token multiset preservation is sufficient for grid-growth repairs, but | ||
| # same-shape changes need stricter slot-level protection. | ||
| if grid_same_shape and _has_same_shape_text_slot_regression( | ||
|
dsolankii marked this conversation as resolved.
|
||
| baseline_cells=baseline_cells, | ||
| candidate_cells=candidate_cells, | ||
| ): | ||
| if not allow_same_shape_text_slot_change: | ||
| return reject("text_slot_regression") | ||
|
|
||
| if not _same_shape_text_slot_changes_are_span_local( | ||
|
dsolankii marked this conversation as resolved.
|
||
| baseline_cells=baseline_cells, | ||
| candidate_cells=candidate_cells, | ||
| ): | ||
| return reject("text_slot_regression") | ||
|
|
||
| # Header row/column indices are directly comparable only when grid shape is | ||
| # stable. Grid-growth repairs may shift coordinates while preserving text. | ||
| if grid_same_shape and _has_header_metadata_regression( | ||
| baseline_cells=baseline_cells, | ||
| candidate_cells=candidate_cells, | ||
| ): | ||
| return reject("header_metadata_regression") | ||
|
|
||
| baseline_issue_count = _diagnostic_issue_count(baseline_diagnostics) | ||
| candidate_issue_count = _diagnostic_issue_count(candidate_diagnostics) | ||
|
|
||
| if ( | ||
| _diagnostics_valid(baseline_diagnostics) | ||
| and candidate_issue_count > baseline_issue_count | ||
| ): | ||
| return reject("topology_issue_regression") | ||
|
|
||
| baseline_coverage = _coverage_ratio(baseline_diagnostics) | ||
| candidate_coverage = _coverage_ratio(candidate_diagnostics) | ||
|
|
||
| # Coverage can naturally decrease when an undersegmented table grows into a | ||
| # correct logical grid. Keep this protection only for same-shape changes. | ||
| if ( | ||
| grid_same_shape | ||
| and baseline_coverage is not None | ||
| and candidate_coverage is not None | ||
| and candidate_coverage + 0.05 < baseline_coverage | ||
| ): | ||
| return reject("coverage_ratio_regression") | ||
|
|
||
| if grid_grew: | ||
| return accept("grid_growth_challenger_accepted") | ||
|
|
||
| return accept("challenger_accepted") | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.