Installation

Before you begin installing DocsaidKit, ensure your system meets the following requirements:

Prerequisites

Install the required dependency packages according to your operating system.

Ubuntu

Open the terminal and run the following command to install the dependencies:
```
sudo apt install libturbojpeg exiftool ffmpeg libheif-dev
```

MacOS

Use brew to install the dependencies:

brew install jpeg-turbo exiftool ffmpeg libheif

pdf2image is a Python module for converting PDF documents into images.

Follow the instructions below to install the necessary dependencies based on your operating system:

For detailed installation instructions, refer to the open-source project pdf2image.
MacOS: Mac users need to install poppler. Install it via Brew:
```
brew install poppler
```
Linux: Most Linux distributions come with pdftoppm and pdftocairo pre-installed.

If not installed, use your package manager to install poppler-utils.
```
sudo apt install poppler-utils
```

Once the prerequisites are met, you can proceed with the installation via git clone:

Download the package:

git clone https://github.com/DocsaidLab/DocsaidKit.git

Build the wheel file:

cd DocsaidKit
python setup.py bdist_wheel

Install the built wheel package:

pip install dist/docsaidkit-*-py3-none-any.whl

If you need to install the version supporting PyTorch:

pip install "dist/docsaidKit-${version}-none-any.whl[torch]"

Why is Windows not supported?

To avoid potential issues, we recommend avoiding Windows.
I insist on using Windows, what should I do?

In that case, we recommend installing Docker and using the above method to run your program within a Docker container.

Please refer to the next section: Advanced Installation.
How do I install Docker?

It's not difficult, but it involves several steps.

Refer to the Docker official documentation for installation instructions.