Docling/docs/examples
nuridol 6efa96c983
feat: add support for ocrmac OCR engine on macOS (#276)
* feat: add support for `ocrmac` OCR engine on macOS

- Integrates `ocrmac` as an OCR engine option for macOS users.
- Adds configuration options and dependencies for `ocrmac`.
- Updates documentation to reflect new engine support.

This change allows macOS users to utilize `ocrmac` for improved OCR performance and compatibility.

Signed-off-by: Suhwan Seo <nuridol@gmail.com>

* updated the poetry lock

Signed-off-by: Suhwan Seo <nuridol@gmail.com>

* Fix linting issues, update CLI docs, and add error for ocrmac use on non-Mac systems

- Resolved formatting and linting issues
- Updated `--ocr-engine` CLI option documentation for `ocrmac`
- Added RuntimeError for attempts to use `ocrmac` on non-Mac platforms

Signed-off-by: Suhwan Seo <nuridol@gmail.com>

* feat: add support for `ocrmac` OCR engine on macOS

- Integrates `ocrmac` as an OCR engine option for macOS users.
- Adds configuration options and dependencies for `ocrmac`.
- Updates documentation to reflect new engine support.

This change allows macOS users to utilize `ocrmac` for improved OCR performance and compatibility.

Signed-off-by: Suhwan Seo <nuridol@gmail.com>

* docs: update examples and installation for ocrmac support

- Added `OcrMacOptions` to `custom_convert.py` and `full_page_ocr.py` examples.
- Included usage comments and examples for `OcrMacOptions` in OCR pipelines.
- Updated installation guide to include instructions for installing `ocrmac`, noting macOS version requirements (10.15+).
- Highlighted that `ocrmac` leverages Apple's Vision framework as an OCR backend.

This enhances documentation for users working on macOS to leverage `ocrmac` effectively.

Signed-off-by: Suhwan Seo <nuridol@gmail.com>

* fix: update `ocrmac` dependency with macOS-specific marker

- Added `sys_platform == 'darwin'` marker to the `ocrmac` dependency in `pyproject.toml` to specify macOS compatibility.
- Updated the content hash in `poetry.lock` to reflect the changes.

This ensures the `ocrmac` dependency is only installed on macOS systems.

Signed-off-by: Suhwan Seo <nuridol@gmail.com>

---------

Signed-off-by: Suhwan Seo <nuridol@gmail.com>
Co-authored-by: Suhwan Seo <nuridol@gmail.com>
2024-11-20 12:51:19 +01:00
..
batch_convert.py chore: make tests lighter (#228) 2024-11-04 14:02:28 +01:00
custom_convert.py feat: add support for ocrmac OCR engine on macOS (#276) 2024-11-20 12:51:19 +01:00
develop_picture_enrichment.py feat: added support for exporting DocItem to an image when page image is available (#379) 2024-11-19 16:28:52 +01:00
export_figures.py feat: added support for exporting DocItem to an image when page image is available (#379) 2024-11-19 16:28:52 +01:00
export_multimodal.py feat!: Docling v2 (#117) 2024-10-16 21:02:03 +02:00
export_tables.py feat!: Docling v2 (#117) 2024-10-16 21:02:03 +02:00
full_page_ocr.py feat: add support for ocrmac OCR engine on macOS (#276) 2024-11-20 12:51:19 +01:00
hybrid_rag_qdrant.ipynb chore: fix Qdrant notebook Colab link (#319) 2024-11-14 10:42:02 +01:00
index.md docs: add architecture outline (#341) 2024-11-15 12:52:41 +01:00
minimal.py chore: various minor docs fixes (#169) 2024-10-22 15:29:36 +02:00
rag_langchain.ipynb feat!: Docling v2 (#117) 2024-10-16 21:02:03 +02:00
rag_llamaindex.ipynb docs: update LlamaIndex docs for Docling v2 (#182) 2024-10-28 14:28:26 +01:00
run_md.py feat: Support AsciiDoc and Markdown input format (#168) 2024-10-23 16:14:26 +02:00
run_with_formats.py fix: fix duplicate title and heading + add e2e tests for html and docx (#186) 2024-10-30 13:14:56 +01:00