User guide#

The user guide explains how to get the most out of docTR on your own documents, one topic at a time. Each page is self-contained and full of examples you can copy.

The essentials#

Loading documents

Read PDFs, images, web pages and in-memory data into pages.

Loading documents
Running OCR

Choose the models and configure the end-to-end OCR predictor.

Running OCR
Working with results

Navigate the Document, convert coordinates, visualize and save predictions.

Working with results
Exporting results

Text, JSON, Markdown, AsciiDoc, HTML and hOCR, in reading order.

Exporting results

Beyond plain text#

Layout analysis & tables

Detect titles, figures and tables, and extract tables as row/column grids.

Layout analysis & tables
Rotated documents

Read skewed scans, photos and pages in any orientation.

Rotated documents
Key information extraction

Detect several classes of fields (dates, amounts…) and read them in one pass.

Key information extraction
Task-specific predictors

Use the detection, recognition, layout, table and orientation models on their own.

Task-specific predictors
Artefact detection

Find logos, QR codes, barcodes and photos with the contrib module.

Artefact detection
Command-line interface

Run OCR on files from your terminal with doctr-cli.

Command-line interface

When something goes wrong#

Troubleshooting & FAQ

Solutions to the most common installation, input and accuracy issues.

Troubleshooting & FAQ