From 0d67020a3fa1829737fde898fd1ff7cc4602cda5 Mon Sep 17 00:00:00 2001 From: Lin Manhui Date: Sat, 14 Jun 2025 12:28:53 +0800 Subject: [PATCH] [Docs] Add get-pipeline-config-via-CLI example (#15697) * Add get-pipeline-config-via-CLI example * Fix typo --- docs/version3.x/paddleocr_and_paddlex.en.md | 7 +++++++ docs/version3.x/paddleocr_and_paddlex.md | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/docs/version3.x/paddleocr_and_paddlex.en.md b/docs/version3.x/paddleocr_and_paddlex.en.md index b139100022..1845a9ed70 100644 --- a/docs/version3.x/paddleocr_and_paddlex.en.md +++ b/docs/version3.x/paddleocr_and_paddlex.en.md @@ -56,6 +56,13 @@ pipeline.export_paddlex_config_to_yaml("ocr_config.yaml") The above code will generate a pipeline configuration file named `ocr_config.yaml` in the working directory. +You can also obtain the configuration file through the PaddleX CLI. Example: + +```bash +# Specify the pipeline registration name +paddlex --get_pipeline_config OCR +``` + ### 3.2 Editing Pipeline Configuration Files The exported PaddleX pipeline configuration file not only includes parameters supported by PaddleOCR's CLI and Python API but also allows for more advanced configurations. Please refer to the corresponding pipeline usage tutorials in [PaddleX Pipeline Usage Overview](https://paddlepaddle.github.io/PaddleX/3.0/en/pipeline_usage/pipeline_develop_guide.html) for detailed instructions on adjusting various configurations according to your needs. diff --git a/docs/version3.x/paddleocr_and_paddlex.md b/docs/version3.x/paddleocr_and_paddlex.md index 8e5a30b4e3..74970db65c 100644 --- a/docs/version3.x/paddleocr_and_paddlex.md +++ b/docs/version3.x/paddleocr_and_paddlex.md @@ -56,6 +56,13 @@ pipeline.export_paddlex_config_to_yaml("ocr_config.yaml") 上述代码会在工作目录下生成名为 `ocr_config.yaml` 的产线配置文件。 +也可以通过 PaddleX CLI 获取配置文件。示例如下： + +```bash +# 指定产线注册名 +paddlex --get_pipeline_config OCR +``` + ### 3.2 编辑产线配置文件 导出的 PaddleX 产线配置文件不仅包含 PaddleOCR CLI 和 Python API 支持的参数，还可进行更多高级配置。请在 [PaddleX模型产线使用概览](https://paddlepaddle.github.io/PaddleX/3.0/pipeline_usage/pipeline_develop_guide.html) 中找到对应的产线使用教程，参考其中的详细说明，根据需求调整各项配置。