Installation

This library requires Python 3.8 or higher.

Prerequisites

Whichever OS you are running, you will need to install at least TensorFlow or PyTorch. You can refer to their corresponding installation pages to do so:

• TensorFlow 2

• PyTorch

For MacBooks with M1 chip, you will need some additional packages or specific versions:

• TensorFlow 2 Metal Plugin

• PyTorch >= 1.12.0

If you are running another OS than Linux, you will need a few extra dependencies.

For MacOS users, you can install them using Homebrew as follows:

brew install cairo pango gdk-pixbuf libffi

For Windows users, those dependencies are included in GTK. You can find the latest installer over here.

Via Python Package

Install the last stable release of the package using pip:

pip install python-doctr

We strive towards reducing framework-specific dependencies to a minimum, but some necessary features are developed by third-parties for specific frameworks. To avoid missing some dependencies for a specific framework, you can install specific builds as follows:

TensorFlowPyTorch

pip install "python-doctr[tf]"

Via Git

Install the library in developer mode:

TensorFlowPyTorch

git clone https://github.com/mindee/doctr.git
pip install -e doctr/.[tf]