API reference#

The complete reference of the public API, generated from the docstrings of the source code. For a guided tour, start with the user guide.

doctr.io

Reading files, the Document elements, and the exporters.

doctr.io
doctr.models

Predictors, architectures, the Hugging Face Hub integration and model utilities.

doctr.models
doctr.datasets

Public datasets, synthetic generators, custom loaders and vocabularies.

doctr.datasets
doctr.transforms

Data augmentation and pre-processing transformations.

doctr.transforms
doctr.utils

Visualization, page reconstruction and evaluation metrics.

doctr.utils
doctr.contrib

Complementary modules, such as the artefact detector.

doctr.contrib