site_name: PaddleX 文档 #站点名称 site_url: https://paddlepaddle.github.io/PaddleX/ docs_dir: docs # 文档路径 repo_url: https://github.com/PaddlePaddle/PaddleX #仓库地址 edit_uri: edit/develop/docs/ #修改文件的路径 theme: name: material # logo: ./static/images/logo.jpg #设置左上角logo # favicon: ./static/images/logo.jpg custom_dir: overrides #用于自定义站点效果 features: - announce.dismiss - content.action.edit #可以编辑页面源码 - content.action.view #可以查看页面源码 - content.code.annotate - content.code.copy # - content.code.select # - content.footnote.tooltips # - content.tabs.link - content.tooltips # - header.autohide # - navigation.expand - navigation.footer - navigation.indexes # - navigation.instant # - navigation.instant.prefetch # - navigation.instant.progress # - navigation.prune - navigation.sections - navigation.tabs - navigation.tabs.sticky - navigation.top - navigation.tracking - navigation.expand # 默认打开所有的字节 - navigation.path - search.highlight - search.share - search.suggest - toc.follow # - toc.integrate palette: #设置切换light和dark模式 - media: "(prefers-color-scheme: light)" scheme: default primary: indigo accent: indigo toggle: icon: material/weather-sunny name: Switch to dark mode - media: "(prefers-color-scheme: dark)" scheme: slate primary: black accent: indigo toggle: icon: material/weather-night name: Switch to system preference font: text: Roboto code: Roboto Mono favicon: assets/favicon.png icon: logo: logo edit: material/pencil view: material/eye repo: fontawesome/brands/github # Plugins plugins: - git-authors - tags - offline - blog - search: separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' - i18n: #设置中英文转换 docs_structure: suffix fallback_to_default: true reconfigure_material: true reconfigure_search: true languages: - locale: zh name: 简体中文 default: true build: true - locale: en name: English site_name: PaddleX Documentation link: /en/ nav_translations: Home: Home 快速开始: Quick Start 安装: Installation 安装PaddlePaddle: PaddlePaddle Install 安装PaddleX: PaddleX Install 产线使用教程: Pipeline Tutorials 概述: Overview 文本图像智能分析: Information Extraction 文档场景信息抽取v3产线: PP-ChatOCRv3-doc 文档场景信息抽取v4产线: PP-ChatOCRv4-doc OCR: OCR 通用OCR产线: OCR 通用表格识别产线: General Table Recognition 通用表格识别v2产线: General Table Recognition V2 通用版面解析产线: General Layout Parsing 通用版面解析v3产线: PP-StructureV3 公式识别产线: Formula Recognition 印章文本识别产线: Seal Recognition 文档图像预处理产线: Document Image Preprocessing 计算机视觉: Computer Vision 通用图像分类: General Image Classification 通用目标检测: General Object Detection 通用实例分割: General Instance Segmentation 通用语义分割: General Semantic Segmentation 图像多标签分类: Image Multi-label Classification 小目标检测: Small Object Detection 图像异常检测: Image Anomaly Detection 通用图像识别: Image Feature 行人属性识别: Pedestrian Attribute Recognition 车辆属性识别: Vehicle Attribute Recognition 人脸识别: Face Feature 时序分析: Time Series Analysis 时序预测产线: Time Series Forecasting 时序异常检测产线: Time Series Anomaly Detection 时序分类产线: Time Series Classification 说明文件: Instructions PaddleX产线命令行使用说明: PaddleX Pipeline CLI Usage PaddleX产线Python脚本使用说明: PaddleX Pipeline Python API Usage 单功能模块使用教程: Module Tutorials OCR: OCR 文本检测模块: Text Detection 印章文本检测模块: Seal Detection 文本识别模块: Text Recognition 版面区域检测模块: Layout Detection 表格结构识别模块: Table Structure Recognition 表格单元格检测模块: Table Cell Detection 表格分类模块: Table Classification 文本行方向分类: Text Line Orientation Classification 人体关键点检测模块: Human Keypoint Detection 开放词汇目标检测模块: Open-Vocabulary Object Detection 开放词汇目标分割模块: Open-Vocabulary Segmentation 多语种语音识别模块: Multilingual Speech Recognition BEV融合3D检测模块: 3D Multimodal Fusion Detection 文档图像方向分类: Document Image Orientation Classification 文本图像矫正模块: Text Image Unwarping 公式识别模块: Formula Recognition 图像分类: Image Classification 图像分类模块: Image Classification 图像多标签分类模块: Image Multi-label Classification 行人属性识别模块: Pedestrian Attribute Recognition 车辆属性识别模块: Vehicle Attribute Recognition 图像特征: Image Features 图像特征模块: Image Feature 目标检测: Object Detection 目标检测模块: Object Detection 小目标检测模块: Small Object Detection 人脸检测模块: Face Detection 主体检测模块: Main Body Detection 行人检测模块: Human Detection 车辆检测模块: Vehicle Detection 3D多模态融合检测: 3D Multi-modal Fusion Detection 人体关键点检测: Human Keypoint Detection 开放词汇检测: Open Vocabulary Detection 开放词汇分割: Open Vocabulary Segmentation 旋转目标检测: Rotated Object Detection 图像分割: Image Segmentation 语义分割模块: Semantic Segmentation 实例分割模块: Instance Segmentation 人脸特征模块: Face Feature 图像异常检测模块: Image Anomaly Detection 文档类视觉语言模型模块: Document Vision-Language Model 时序分析: Time Series Analysis 时序预测模块: Time Series Forecasting 时序异常检测模块: Time Series Anomaly Detection 时序分类模块: Time Series Classification 语音处理: Speech 多语种语音识别: Multilingual Speech Recognition 视频分析: Video 通用视频分类: General Video Classification 通用视频检测: General Video Detection 说明文件: Instructions PaddleX单模型Python脚本使用说明: PaddleX Module Python API Usage PaddleX通用模型配置文件参数说明: PaddleX Common Module Config Parameters PaddleX时序任务模型配置文件参数说明: PaddleX Time Series Module Config Parameters 模型产线部署: Pipeline Deploy 高性能推理: High Performance Inference 打包PaddleX项目: Package PaddleX Projects 服务化部署: Serving 端侧部署: On-Device Deployment 获取 ONNX 模型: Obtaining ONNX Models 多硬件使用: Multi-Device Usage 多硬件使用指南: Multi-Device Usage Guide 飞桨多硬件安装: PaddlePaddle Installation on Multiple Devices 海光 DCU 飞桨安装教程: HYGON DCU PaddlePaddle Installation Guide 寒武纪 MLU 飞桨安装教程: Cambricon MLU PaddlePaddle Installation Guide 昇腾 NPU 飞桨安装教程: Ascend NPU PaddlePaddle Installation Guide 昆仑 XPU 飞桨安装教程: Kunlun XPU PaddlePaddle Installation Guide 燧原 GCU 飞桨安装教程: Enflame GCU PaddlePaddle Installation Guide 数据标注教程: Data Annotation Tutorials 计算机视觉: Computer Vision 图像分类任务模块: Image Classification Task 图像特征任务模块: Image Feature Task 实例分割任务模块: Instance Segmentation Task 图像多标签分类: Image Multi-label Classification 目标检测任务模块: Object Detection Task 语义分割任务模块: Semantic Segmentation Task OCR: OCR 表格识别任务模块: Table Recognition Task 文本检测/识别任务模块: Text Detection/Recognition Task 时序分析: Time Series Analysis 时序异常检测任务模块: Time Series Anomaly Detection Task 时序分类任务模块: Time Series Classification Task 时序预测任务模块: Time Series Forecasting Task 语音识别: Speech 3D检测: 3D 产线列表: Pipeline List PaddleX产线列表(CPU/GPU): PaddleX Pipeline List (CPU/GPU) PaddleX产线列表(DCU): PaddleX Pipeline List (DCU) PaddleX产线列表(MLU): PaddleX Pipeline List (MLU) PaddleX产线列表(NPU): PaddleX Pipeline List (NPU) PaddleX产线列表(XPU): PaddleX Pipeline List (XPU) 模型列表: Model List PaddleX模型列表(CPU/GPU): PaddleX Model List (CPU/GPU) PaddleX模型列表(DCU): PaddleX Model List (DCU) PaddleX模型列表(MLU): PaddleX Model List (MLU) PaddleX模型列表(NPU): PaddleX Model List (NPU) PaddleX模型列表(XPU): PaddleX Model List (XPU) PaddleX模型列表(GCU): PaddleX Model List (GCU) 产业实践教程&范例: Practical Tutorials & Examples 论文文献信息抽取教程: Document Scene Information Extraction Tutorial 垃圾分类教程: Garbage Classification Tutorial 遥感图像实例分割教程: Remote Sensing Image Instance Segmentation Tutorial 行人跌倒检测教程: Pedestrian Fall Detection Tutorial 服装时尚元素检测教程: Fashion Element Detection Tutorial 车牌识别教程: License Plate Recognition Tutorial 手写中文识别教程: Handwritten Chinese Recognition Tutorial 车道线分割教程: Lane Line Segmentation Tutorial 设备异常检测应用教程: Equipment Anomaly Detection Application Tutorial 心跳监测时序数据分类应用教程: Heartbeat Monitoring Time Series Data Classification Application Tutorial 用电量长期预测应用教程: Long-term Electricity Consumption Forecasting Application Tutorial 多语种语音识别模块: Multilingual Speech Recognition Task 可视化工具: VisualDL FAQ: FAQ 近期更新: Recently Update repository: PaddlePaddle/PaddleX #仓库名称 branch: release/3.1 #仓库分支 - git-revision-date-localized: #显示更新时间 enable_creation_date: true # Additional configuration extra: version: provider: mike #显示版本 status: new: Recently added deprecated: Deprecated analytics: provider: google property: !ENV GOOGLE_ANALYTICS_KEY social: - icon: fontawesome/brands/github link: https://github.com/PaddlePaddle/PaddleX extra_javascript: - javascripts/katex.min.js - https://unpkg.com/katex@0/dist/katex.min.js - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js extra_css: - https://unpkg.com/katex@0/dist/katex.min.css # Extensions markdown_extensions: - abbr - admonition - attr_list - def_list - footnotes - md_in_html - toc: permalink: true - pymdownx.arithmatex: generic: true - pymdownx.betterem: smart_enable: all - pymdownx.caret - pymdownx.details - pymdownx.emoji: emoji_generator: !!python/name:material.extensions.emoji.to_svg emoji_index: !!python/name:material.extensions.emoji.twemoji - pymdownx.highlight: anchor_linenums: true line_spans: __span pygments_lang_class: true - pymdownx.inlinehilite - pymdownx.keys - pymdownx.magiclink: normalize_issue_symbols: true repo_url_shorthand: true user: squidfunk repo: mkdocs-material - pymdownx.mark - pymdownx.smartsymbols - pymdownx.snippets: auto_append: - includes/mkdocs.md - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.tabbed: alternate_style: true combine_header_slug: true slugify: !!python/object/apply:pymdownx.slugs.slugify kwds: case: lower - pymdownx.tasklist: custom_checkbox: true - pymdownx.tilde # 页面结构 nav: - Home: index.md - 安装: - 安装PaddlePaddle: installation/paddlepaddle_install.md - 安装PaddleX: installation/installation.md - 产线使用教程: - 概述: pipeline_usage/pipeline_develop_guide.md - 文本图像智能分析: - 文档场景信息抽取v3产线: pipeline_usage/tutorials/information_extraction_pipelines/document_scene_information_extraction_v3.md - 文档场景信息抽取v4产线: pipeline_usage/tutorials/information_extraction_pipelines/document_scene_information_extraction_v4.md - OCR: - 通用OCR产线: pipeline_usage/tutorials/ocr_pipelines/OCR.md - 通用表格识别产线: pipeline_usage/tutorials/ocr_pipelines/table_recognition.md - 通用表格识别v2产线: pipeline_usage/tutorials/ocr_pipelines/table_recognition_v2.md - 通用版面解析产线: pipeline_usage/tutorials/ocr_pipelines/layout_parsing.md - 通用版面解析v3产线: pipeline_usage/tutorials/ocr_pipelines/PP-StructureV3.md - 公式识别产线: pipeline_usage/tutorials/ocr_pipelines/formula_recognition.md - 印章文本识别产线: pipeline_usage/tutorials/ocr_pipelines/seal_recognition.md - 文档图像预处理产线: pipeline_usage/tutorials/ocr_pipelines/doc_preprocessor.md - 计算机视觉: - 通用图像分类: pipeline_usage/tutorials/cv_pipelines/image_classification.md - 通用目标检测: pipeline_usage/tutorials/cv_pipelines/object_detection.md - 通用实例分割: pipeline_usage/tutorials/cv_pipelines/instance_segmentation.md - 通用语义分割: pipeline_usage/tutorials/cv_pipelines/semantic_segmentation.md - 图像多标签分类: pipeline_usage/tutorials/cv_pipelines/image_multi_label_classification.md - 小目标检测: pipeline_usage/tutorials/cv_pipelines/small_object_detection.md - 图像异常检测: pipeline_usage/tutorials/cv_pipelines/image_anomaly_detection.md - 3D多模态融合检测: pipeline_usage/tutorials/cv_pipelines/3d_bev_detection.md - 人体关键点检测: pipeline_usage/tutorials/cv_pipelines/human_keypoint_detection.md - 开放词汇检测: pipeline_usage/tutorials/cv_pipelines/open_vocabulary_detection.md - 开放词汇分割: pipeline_usage/tutorials/cv_pipelines/open_vocabulary_segmentation.md - 旋转目标检测: pipeline_usage/tutorials/cv_pipelines/rotated_object_detection.md - 通用图像识别: pipeline_usage/tutorials/cv_pipelines/general_image_recognition.md - 行人属性识别: pipeline_usage/tutorials/cv_pipelines/pedestrian_attribute_recognition.md - 车辆属性识别: pipeline_usage/tutorials/cv_pipelines/vehicle_attribute_recognition.md - 人脸识别: pipeline_usage/tutorials/cv_pipelines/face_recognition.md - 时序分析: - 时序预测产线: pipeline_usage/tutorials/time_series_pipelines/time_series_forecasting.md - 时序异常检测产线: pipeline_usage/tutorials/time_series_pipelines/time_series_anomaly_detection.md - 时序分类产线: pipeline_usage/tutorials/time_series_pipelines/time_series_classification.md - 语音处理: - 多语种语音识别: pipeline_usage/tutorials/speech_pipelines/multilingual_speech_recognition.md - 视频分析: - 通用视频分类: pipeline_usage/tutorials/video_pipelines/video_classification.md - 通用视频检测: pipeline_usage/tutorials/video_pipelines/video_detection.md - 多模态视觉语言模型: - 文档理解产线: pipeline_usage/tutorials/vlm_pipelines/doc_understanding.md - 说明文件: - PaddleX产线命令行使用说明: pipeline_usage/instructions/pipeline_CLI_usage.md - PaddleX产线Python脚本使用说明: pipeline_usage/instructions/pipeline_python_API.md - 产线并行推理: pipeline_usage/instructions/parallel_inference.md - 单功能模块使用教程: - OCR: - 文本检测模块: module_usage/tutorials/ocr_modules/text_detection.md - 印章文本检测模块: module_usage/tutorials/ocr_modules/seal_text_detection.md - 文本识别模块: module_usage/tutorials/ocr_modules/text_recognition.md - 版面区域检测模块: module_usage/tutorials/ocr_modules/layout_detection.md - 表格结构识别模块: module_usage/tutorials/ocr_modules/table_structure_recognition.md - 表格单元格检测模块: module_usage/tutorials/ocr_modules/table_cells_detection.md - 表格分类模块: module_usage/tutorials/ocr_modules/table_classification.md - 文档图像方向分类: module_usage/tutorials/ocr_modules/doc_img_orientation_classification.md - 文本图像矫正模块: module_usage/tutorials/ocr_modules/text_image_unwarping.md - 文本行方向分类: module_usage/tutorials/ocr_modules/textline_orientation_classification.md - 公式识别模块: module_usage/tutorials/ocr_modules/formula_recognition.md - 图像分类: - 图像分类模块: module_usage/tutorials/cv_modules/image_classification.md - 图像多标签分类模块: module_usage/tutorials/cv_modules/image_multilabel_classification.md - 行人属性识别模块: module_usage/tutorials/cv_modules/pedestrian_attribute_recognition.md - 车辆属性识别模块: module_usage/tutorials/cv_modules/vehicle_attribute_recognition.md - 图像特征: - 图像特征模块: module_usage/tutorials/cv_modules/image_feature.md - 人脸特征模块: module_usage/tutorials/cv_modules/face_feature.md - 目标检测: - 目标检测模块: module_usage/tutorials/cv_modules/object_detection.md - 小目标检测模块: module_usage/tutorials/cv_modules/small_object_detection.md - 人脸检测模块: module_usage/tutorials/cv_modules/face_detection.md - 主体检测模块: module_usage/tutorials/cv_modules/mainbody_detection.md - 行人检测模块: module_usage/tutorials/cv_modules/human_detection.md - 车辆检测模块: module_usage/tutorials/cv_modules/vehicle_detection.md - 人体关键点检测模块: module_usage/tutorials/cv_modules/human_keypoint_detection.md - 开放词汇目标检测模块: module_usage/tutorials/cv_modules/open_vocabulary_detection.md - 图像分割: - 语义分割模块: module_usage/tutorials/cv_modules/semantic_segmentation.md - 实例分割模块: module_usage/tutorials/cv_modules/instance_segmentation.md - 图像异常检测模块: module_usage/tutorials/cv_modules/anomaly_detection.md - 开放词汇目标分割模块: module_usage/tutorials/cv_modules/open_vocabulary_segmentation.md - 时序分析: - 时序预测模块: module_usage/tutorials/time_series_modules/time_series_forecasting.md - 时序异常检测模块: module_usage/tutorials/time_series_modules/time_series_anomaly_detection.md - 时序分类模块: module_usage/tutorials/time_series_modules/time_series_classification.md - 语音识别: - 多语种语音识别模块: module_usage/tutorials/speech_modules/multilingual_speech_recognition.md - 3D检测: - BEV融合3D检测模块: module_usage/tutorials/cv_modules/3d_bev_detection.md - 多模态视觉语言模型: - 文档类视觉语言模型模块: module_usage/tutorials/vlm_modules/doc_vlm.md - 图表解析模块: module_usage/tutorials/vlm_modules/chart_parsing.md - 说明文件: - PaddleX单模型Python脚本使用说明: module_usage/instructions/model_python_API.md - PaddleX通用模型配置文件参数说明: module_usage/instructions/config_parameters_common.md - PaddleX时序任务模型配置文件参数说明: module_usage/instructions/config_parameters_time_series.md - 模型推理 Benchmark: module_usage/instructions/benchmark.md - 产线推理 Benchmark: pipeline_usage/instructions/benchmark.md - 模型产线部署: - 高性能推理: pipeline_deploy/high_performance_inference.md - 服务化部署: pipeline_deploy/serving.md - 端侧部署: pipeline_deploy/on_device_deployment.md - 获取 ONNX 模型: pipeline_deploy/paddle2onnx.md - 打包PaddleX项目: pipeline_deploy/packaging.md - 多硬件使用: - 多硬件使用指南: other_devices_support/multi_devices_use_guide.md - 飞桨多硬件安装: - 海光 DCU 飞桨安装教程: other_devices_support/paddlepaddle_install_DCU.md - 寒武纪 MLU 飞桨安装教程: other_devices_support/paddlepaddle_install_MLU.md - 昇腾 NPU 飞桨安装教程: other_devices_support/paddlepaddle_install_NPU.md - 昆仑 XPU 飞桨安装教程: other_devices_support/paddlepaddle_install_XPU.md - 燧原 GCU 飞桨安装教程: other_devices_support/paddlepaddle_install_GCU.md - 数据标注教程: - 计算机视觉: - 图像分类任务模块: data_annotations/cv_modules/image_classification.md - 图像特征任务模块: data_annotations/cv_modules/image_feature.md - 实例分割任务模块: data_annotations/cv_modules/instance_segmentation.md - 图像多标签分类: data_annotations/cv_modules/ml_classification.md - 目标检测任务模块: data_annotations/cv_modules/object_detection.md - 语义分割任务模块: data_annotations/cv_modules/semantic_segmentation.md - OCR: - 表格识别任务模块: data_annotations/ocr_modules/table_recognition.md - 文本检测/识别任务模块: data_annotations/ocr_modules/text_detection_recognition.md - 时序分析: - 时序异常检测任务模块: data_annotations/time_series_modules/time_series_anomaly_detection.md - 时序分类任务模块: data_annotations/time_series_modules/time_series_classification.md - 时序预测任务模块: data_annotations/time_series_modules/time_series_forecasting.md - 产线列表: - PaddleX产线列表(CPU/GPU): support_list/pipelines_list.md - PaddleX产线列表(DCU): support_list/pipelines_list_dcu.md - PaddleX产线列表(MLU): support_list/pipelines_list_mlu.md - PaddleX产线列表(NPU): support_list/pipelines_list_npu.md - PaddleX产线列表(XPU): support_list/pipelines_list_xpu.md - 模型列表: - PaddleX模型列表(CPU/GPU): support_list/models_list.md - PaddleX模型列表(DCU): support_list/model_list_dcu.md - PaddleX模型列表(MLU): support_list/model_list_mlu.md - PaddleX模型列表(NPU): support_list/model_list_npu.md - PaddleX模型列表(XPU): support_list/model_list_xpu.md - PaddleX模型列表(GCU): support_list/model_list_gcu.md - 产业实践教程&范例: - 文档场景信息抽取实践教程-如何微调版面区域检测: practical_tutorials/document_scene_information_extraction(layout_detection)_tutorial.md - 文档场景信息抽取实践教程-如何微调印章文本检测: practical_tutorials/document_scene_information_extraction(seal_recognition)_tutorial.md - 文档场景信息抽取实践教程-如何使用deepseek: practical_tutorials/document_scene_information_extraction(deepseek)_tutorial.md - OCR识别之车牌文本检测实践教程: practical_tutorials/ocr_det_license_tutorial.md - OCR识别之手写中文识别实践教程: practical_tutorials/ocr_rec_chinese_tutorial.md - 公式识别实践教程: practical_tutorials/formula_recognition_tutorial.md - 版面区域检测模型使用实践教程: practical_tutorials/layout_detection.md - 人脸识别之卡通人脸识别实践教程: practical_tutorials/face_recognition_tutorial.md - 垃圾分类实践教程: practical_tutorials/image_classification_garbage_tutorial.md - 遥感图像实例分割实践教程: practical_tutorials/instance_segmentation_remote_sensing_tutorial.md - 行人跌倒检测实践教程: practical_tutorials/object_detection_fall_tutorial.md - 服装时尚元素检测实践教程: practical_tutorials/object_detection_fashion_pedia_tutorial.md - 车牌识别实践教程: practical_tutorials/ocr_det_license_tutorial.md - 车道线分割实践教程: practical_tutorials/semantic_segmentation_road_tutorial.md - 设备异常检测应用实践教程: practical_tutorials/ts_anomaly_detection.md - 心跳监测时序数据分类应用实践教程: practical_tutorials/ts_classification.md - 用电量长期预测应用实践教程: practical_tutorials/ts_forecast.md - 产线部署实践教程: practical_tutorials/deployment_tutorial.md - 可视化工具: VisualDL.md - FAQ: FAQ.md - 近期更新: CHANGELOG.md