Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds/updates PyMuPDF4LLM documentation to describe the revised OCR plugin system and clarify OCR-related API behavior in the generated docs.
Changes:
- Adds a new documentation page describing default OCR plugins, selection order, hybrid OCR workflow, and how to provide custom OCR functions.
- Updates the PyMuPDF4LLM feature list to mention automatic OCR-benefit page detection and multiple OCR engines.
- Updates API docs for
force_ocr,ocr_dpi, andocr_functionto reflect default OCR engine/plugin behavior.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| docs/pymupdf4llm/ocr-plugins.rst | New page documenting OCR plugin options, selection logic, and customization. |
| docs/pymupdf4llm/index.rst | Adds OCR-related capability to the feature list. |
| docs/pymupdf4llm/api.rst | Clarifies OCR-related parameter documentation and defaults. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+1
to
+6
| Default OCR Functions | ||
| ====================== | ||
|
|
||
| PyMuPDF4LLM supports default OCR functions. They come in the form of plugins that are present in its `ocr` subpackage. They are based on currently 3 popular OCR engines, Tesseract OCR, RapidOCR and PaddleOCR. Some engines can be combined to make use of their strengths and mitigate their weaknesses. For example, Tesseract OCR is very good at **recognizing** text, while RapidOCR is better at **detecting** text bounding boxes in images with complex backgrounds. By combining the two engines, we can achieve better overall OCR results while at the samne time also reducing the overall OCR processing time. | ||
|
|
||
| Here is an overview of the available default plugins: |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.