From cb100437facdfc064c83396c3aebb185717bead6 Mon Sep 17 00:00:00 2001 From: Michele Dolfi <97102151+dolfim-ibm@users.noreply.github.com> Date: Fri, 31 Oct 2025 13:21:01 +0100 Subject: [PATCH] docs: Update installation options with extras and review FAQ (#2548) * revise install docs Signed-off-by: Michele Dolfi * add more FAQ Signed-off-by: Michele Dolfi --------- Signed-off-by: Michele Dolfi --- docs/faq/index.md | 47 +++++++++++++-- docs/installation/index.md | 119 ++++++++++++++++++++----------------- 2 files changed, 107 insertions(+), 59 deletions(-) diff --git a/docs/faq/index.md b/docs/faq/index.md index 9b2d4ec5..c620d3ee 100644 --- a/docs/faq/index.md +++ b/docs/faq/index.md @@ -3,6 +3,13 @@ This is a collection of FAQ collected from the user questions on . +??? question "Is Python 3.14 supported?" + + ### Is Python 3.14 supported? + + Python 3.14 is supported from Docling 2.59.0. + + ??? question "Is Python 3.13 supported?" ### Is Python 3.13 supported? @@ -61,14 +68,46 @@ This is a collection of FAQ collected from the user questions on Tesseract installation +## Available extras + +The `docling` package is designed to offer a working solution for the Docling default options. +Some Docling functionalities require additional third-party packages and are therefore installed only if selected as extras (or installed independently). + +The following table summarizes the extras available in the `docling` package. They can be activated with: +`pip install "docling[NAME1,NAME2]"` + + +| Extra | Description | +| - | - | +| `asr` | Installs dependencies for running the ASR pipeline. | +| `vlm` | Installs dependencies for running the VLM pipeline. | +| `easyocr` | Installs the [EasyOCR](https://github.com/JaidedAI/EasyOCR) OCR engine. | +| `tesserocr` | Installs the Tesseract binding for using it as OCR engine. | +| `ocrmac` | Installs the OcrMac OCR engine. | +| `rapidocr` | Installs the [RapidOCR](https://github.com/RapidAI/RapidOCR) OCR engine with [onnxruntime](https://github.com/microsoft/onnxruntime/) backend. | + + +### OCR engines + + +Docling supports multiple OCR engines for processing scanned documents. The current version provides +the following engines. + +| Engine | Installation | Usage | +| ------ | ------------ | ----- | +| [EasyOCR](https://github.com/JaidedAI/EasyOCR) | `easyocr` extra or via `pip install easyocr`. | `EasyOcrOptions` | +| Tesseract | System dependency. See description for Tesseract and Tesserocr below. | `TesseractOcrOptions` | +| Tesseract CLI | System dependency. See description below. | `TesseractCliOcrOptions` | +| OcrMac | System dependency. See description below. | `OcrMacOptions` | +| [RapidOCR](https://github.com/RapidAI/RapidOCR) | `rapidocr` extra can or via `pip install rapidocr onnxruntime` | `RapidOcrOptions` | +| [OnnxTR](https://github.com/felixdittrich92/OnnxTR) | Can be installed via the plugin system `pip install "docling-ocr-onnxtr[cpu]"`. Please take a look at [docling-OCR-OnnxTR](https://github.com/felixdittrich92/docling-OCR-OnnxTR).| `OnnxtrOcrOptions` | + +The Docling `DocumentConverter` allows to choose the OCR engine with the `ocr_options` settings. For example + +```python +from docling.datamodel.base_models import ConversionStatus, PipelineOptions +from docling.datamodel.pipeline_options import PipelineOptions, EasyOcrOptions, TesseractOcrOptions +from docling.document_converter import DocumentConverter + +pipeline_options = PipelineOptions() +pipeline_options.do_ocr = True +pipeline_options.ocr_options = TesseractOcrOptions() # Use Tesseract + +doc_converter = DocumentConverter( + pipeline_options=pipeline_options, +) +``` + +??? "Tesseract installation" [Tesseract](https://github.com/tesseract-ocr/tesseract) is a popular OCR engine which is available on most operating systems. For using this engine with Docling, Tesseract must be installed on your @@ -82,7 +121,7 @@ Works on macOS, Linux, and Windows, with support for both x86_64 and arm64 archi echo "Set TESSDATA_PREFIX=${TESSDATA_PREFIX}" ``` -

Linking to Tesseract

+

Linking to Tesseract

The most efficient usage of the Tesseract library is via linking. Docling is using the [Tesserocr](https://github.com/sirfz/tesserocr) package for this. @@ -94,36 +133,6 @@ Works on macOS, Linux, and Windows, with support for both x86_64 and arm64 archi pip install --no-binary :all: tesserocr ``` -

ocrmac installation

- - [ocrmac](https://github.com/straussmaximilian/ocrmac) is using - Apple's vision(or livetext) framework as OCR backend. - For using this engine with Docling, ocrmac must be installed on your system. - This only works on macOS systems with newer macOS versions (10.15+). - - ```console - pip install ocrmac - ``` - -??? "Installation on macOS Intel (x86_64)" - - When installing Docling on macOS with Intel processors, you might encounter errors with PyTorch compatibility. - This happens because newer PyTorch versions (2.6.0+) no longer provide wheels for Intel-based Macs. - - If you're using an Intel Mac, install Docling with compatible PyTorch - **Note:** PyTorch 2.2.2 requires Python 3.12 or lower. Make sure you're not using Python 3.13+. - - ```bash - # For uv users - uv add torch==2.2.2 torchvision==0.17.2 docling - - # For pip users - pip install "docling[mac_intel]" - - # For Poetry users - poetry add docling - ``` - ## Development setup To develop Docling features, bugfixes etc., install as follows from your local clone's root dir: