| Pipeline |
Ascend 910B |
Kunlunxin R200/R300 |
Cambricon MLU370X8 |
HYGON Z100 |
| OCR |
β
|
β
|
β
|
π§ |
| Table Recognition |
β
|
π§ |
π§ |
π§ |
| Object Detection |
β
|
β
|
β
|
π§ |
| Instance Segmentation |
β
|
π§ |
β
|
π§ |
| Image Classification |
β
|
β
|
β
|
β
|
| Semantic Segmentation |
β
|
β
|
β
|
β
|
| Time Series Forecasting |
β
|
β
|
β
|
π§ |
| Time Series Anomaly Detection |
β
|
π§ |
π§ |
π§ |
| Time Series Classification |
β
|
π§ |
π§ |
π§ |
| Multi-label Image Classification |
β
|
π§ |
π§ |
β
|
| Pedestrian Attribute Recognition |
β
|
π§ |
π§ |
π§ |
| Vehicle Attribute Recognition |
β
|
π§ |
π§ |
π§ |
| Image Recognition |
β
|
π§ |
β
|
β
|
| Seal Recognition |
β
|
π§ |
π§ |
π§ |
| Image Anomaly Detection |
β
|
β
|
β
|
β
|
| Face Recognition |
β
|
β
|
β
|
β
|
## βοΈ Quick Start
### π οΈ Installation
> βBefore installing PaddleX, please ensure that you have a basic **Python runtime environment** (Note: Currently supports Python 3.8 to Python 3.12). The PaddleX 3.0.x version depends on PaddlePaddle version 3.0.0 and above. Please make sure the version compatibility is maintained before use.
* **Installing PaddlePaddle**
```bash
# CPU
python -m pip install paddlepaddle==3.0.0 -i https://www.paddlepaddle.org.cn/packages/stable/cpu/
# gpuοΌrequires GPU driver version β₯450.80.02 (Linux) or β₯452.39 (Windows)
python -m pip install paddlepaddle-gpu==3.0.0 -i https://www.paddlepaddle.org.cn/packages/stable/cu118/
# gpuοΌrequires GPU driver version β₯550.54.14 (Linux) or β₯550.54.14 (Windows)
python -m pip install paddlepaddle-gpu==3.0.0 -i https://www.paddlepaddle.org.cn/packages/stable/cu126/
```
> βNo need to focus on the CUDA version on the physical machine, only the GPU driver version needs attention. For more information on PaddlePaddle Wheel versions, please refer to the [PaddlePaddle Official Website](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation./docs/en/install/pip/linux-pip.html).
* **Installing PaddleX**
```bash
pip install "paddlex[base]==3.0.0"
```
> βFor more installation methods, refer to the [PaddleX Installation Guide](https://paddlepaddle.github.io/PaddleX/latest/en/installation/installation.html).
### π» CLI Usage
One command can quickly experience the pipeline effect, the unified CLI format is:
```bash
paddlex --pipeline [Pipeline Name] --input [Input Image] --device [Running Device]
```
Each Pipeline in PaddleX corresponds to specific parameters, which you can view in the respective Pipeline documentation for detailed explanations. Each Pipeline requires specifying three necessary parameters:
* `pipeline`: The name of the Pipeline or the configuration file of the Pipeline
* `input`: The local path, directory, or URL of the input file (e.g., an image) to be processed
* `device`: The hardware device and its index to use (e.g., `gpu:0` indicates using the 0th GPU), or you can choose to use NPU (`npu:0`), XPU (`xpu:0`), CPU (`cpu`), etc.
For example, using the OCR pipeline:
```bash
paddlex --pipeline OCR \
--input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_ocr_002.png \
--use_doc_orientation_classify False \
--use_doc_unwarping False \
--use_textline_orientation False \
--save_path ./output \
--device gpu:0
```