-
Notifications
You must be signed in to change notification settings - Fork 3.3k
docs: Added documentation to use SuryaOCR via plugin docling-surya #2533
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
docs: Added documentation to use SuryaOCR via plugin docling-surya #2533
Conversation
|
✅ DCO Check Passed Thanks @harrykhh, all your commits are properly signed off. 🎉 |
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
3ed08c3 to
eb4a6c0
Compare
dolfim-ibm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately Surya is licenses as GPL and cannot legally be included in this software package (without license changes).
The integration of the OCR engine could anyway be done as a stand-alone plugin. See https://docling-project.github.io/docling/concepts/plugins/.
@harrykhh if you are willing to make such a plugin-package we will be glad to list and promote it in the Docling docs.
7410fca to
9a6fdf9
Compare
Signed-off-by: Harry Ho <[email protected]>
171f893 to
23bc9c4
Compare
|
Thanks for the review, @dolfim-ibm I reverted commits and updated the documents only to include the plugin https://pypi.org/project/docling-surya/ |
Added a link to the PyPI page for docling-surya. Signed-off-by: Harry Ho <[email protected]>
|
@harrykhh Great to see the docling-surya plugin. The example you provide looks fine. I would suggest adding somewhere in the comments that it brings a GPL license. Apart from that it would be fine to merge. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Added important licensing note regarding SuryaOCR integration. Signed-off-by: Harry Ho <[email protected]>
Done. Thanks @cau-git |
Signed-off-by: Harry Ho <[email protected]>
Signed-off-by: Harry Ho <[email protected]>
0eb8e59 to
1c04b39
Compare
This PR integrates Surya as an optional layout analysis backend in Docling.
re: #2222
Key Changes
SuryaLayoutModelindocling_core/layout_model.pyto wrap Surya's detection API.Non-breaking, modular enhancement for improved layout accuracy on complex PDFs.
Checklist: