7233295d6a
* Split dependencies * More dependency groups * Remove multimodal and rename doc to doc-parser * Fix docs * Fix bugs and polish docs
3.7 KiB
| comments |
|---|
| true |
Installation
1. Install PaddlePaddle Framework
Please refer to the PaddlePaddle Official Website to install PaddlePaddle framework version 3.0 or above. Using the official PaddlePaddle Docker image is recommended.
2. Install PaddleOCR
If you only want to use the inference capabilities of PaddleOCR, please refer to Install Inference Package; if you want to perform model training, exporting, etc., please refer to Install Training Dependencies. It is allowed to install both the inference package and training dependencies in the same environment without the need for environment isolation.
2.1 Install Inference Package
Install the latest version of the PaddleOCR inference package from PyPI:
# If you only want to use the basic text recognition feature (returning text position coordinates and content)
python -m pip install paddleocr
# If you want to use all functionalities, such as document parsing, document understanding, document translation, and key information extraction
# python -m pip install "paddleocr[all]"
Or install from source (default is the development branch):
# If you only want to use the basic text recognition feature (returning text position coordinates and content)
python -m pip install "paddleocr@git+https://github.com/PaddlePaddle/PaddleOCR.git"
# If you want to use all functionalities, such as document parsing, document understanding, document translation, and key information extraction
# python -m pip install "paddleocr[all]@git+https://github.com/PaddlePaddle/PaddleOCR.git"
In addition to the all dependency group demonstrated above, PaddleOCR also supports installing specific optional features by specifying other dependency groups. The available dependency groups provided by PaddleOCR are as follows:
| Dependency Group | Functionality |
|---|---|
doc-parser |
Document parsing, which can be used to extract layout elements in a document such as tables, formulas, stamps, and images. |
ie |
Information extraction, which can be used to extract key information from documents, such as names, dates, addresses, amounts, and more. |
trans |
Document translation, which can be used to translate a document from one language to another. |
all |
Full functionality. |
The general OCR pipeline (e.g., PP-OCRv3/v4/v5) and the document image preprocessing pipeline can be used without installing any additional dependency groups. Apart from these two pipelines, each remaining pipeline belongs to one and only one dependency group. You can refer to the usage documentation of each pipeline to determine which group it belongs to. For individual functional modules, installing any dependency group that includes the module will enable access to its core functionality.
2.2 Install Training Dependencies
To perform model training, exporting, etc., first clone the repository to your local machine:
# Recommended method
git clone https://github.com/PaddlePaddle/PaddleOCR
# (Optional) Switch to a specific branch
git checkout release/3.0
# If you encounter network issues preventing successful cloning, you can also use the repository on Gitee:
git clone https://gitee.com/paddlepaddle/PaddleOCR
# Note: The code hosted on Gitee may not be synchronized in real-time with updates from this GitHub project, with a delay of 3~5 days. Please prioritize using the recommended method.
Run the following command to install the dependencies:
python -m pip install -r requirements.txt