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

feat: Add pipeline timings and toggle visualization, establish debug settings #183

Merged
merged 10 commits into from
Oct 30, 2024

Conversation

cau-git
Copy link
Contributor

@cau-git cau-git commented Oct 28, 2024

This PR introduces two new features:

  1. Time profiling of the pipelines . The ConversionResult object carries a new field timings, which will be populated if the respective setting settings.debug.profile_pipeline_timings is turned on. The measurements are distinguished by scope (Page or Document) and the profiled sections, which rely on the newly implemented TimeRecorder context manager.
  2. Debug visualisations. We have new settings fields to control whether the cells, ocr, layout or table structure predictions should be visualized. When they are turned on, debug visualisations will be saved as PNG iamges by default under {current_working_directory}/debug/.

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the
    conventional commits.
  • Documentation has been updated, if necessary.
  • Examples have been added, if necessary.
  • Tests have been added, if necessary.

Signed-off-by: Christoph Auer <cau@zurich.ibm.com>
Signed-off-by: Christoph Auer <cau@zurich.ibm.com>
Signed-off-by: Christoph Auer <cau@zurich.ibm.com>
Signed-off-by: Christoph Auer <cau@zurich.ibm.com>
@cau-git cau-git marked this pull request as ready for review October 29, 2024 12:54
Signed-off-by: Christoph Auer <cau@zurich.ibm.com>
Signed-off-by: Christoph Auer <cau@zurich.ibm.com>
Signed-off-by: Christoph Auer <cau@zurich.ibm.com>
PeterStaar-IBM
PeterStaar-IBM previously approved these changes Oct 30, 2024
Copy link
Contributor

@PeterStaar-IBM PeterStaar-IBM left a comment

Choose a reason for hiding this comment

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

lgtm

Signed-off-by: Christoph Auer <cau@zurich.ibm.com>
@dolfim-ibm dolfim-ibm merged commit 2a2c65b into main Oct 30, 2024
7 checks passed
@dolfim-ibm dolfim-ibm deleted the cau/pipeline-profiling branch October 30, 2024 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants