mkdocs.yml 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425
  1. site_name: PaddleX 文档 #站点名称
  2. site_url: https://paddlepaddle.github.io/PaddleX/
  3. docs_dir: docs # 文档路径
  4. repo_url: https://github.com/PaddlePaddle/PaddleX #仓库地址
  5. edit_uri: edit/develop/docs/ #修改文件的路径
  6. theme:
  7. name: material
  8. # logo: ./static/images/logo.jpg #设置左上角logo
  9. # favicon: ./static/images/logo.jpg
  10. custom_dir: overrides #用于自定义站点效果
  11. features:
  12. - announce.dismiss
  13. - content.action.edit #可以编辑页面源码
  14. - content.action.view #可以查看页面源码
  15. - content.code.annotate
  16. - content.code.copy
  17. # - content.code.select
  18. # - content.footnote.tooltips
  19. # - content.tabs.link
  20. - content.tooltips
  21. # - header.autohide
  22. # - navigation.expand
  23. - navigation.footer
  24. - navigation.indexes
  25. # - navigation.instant
  26. # - navigation.instant.prefetch
  27. # - navigation.instant.progress
  28. # - navigation.prune
  29. - navigation.sections
  30. - navigation.tabs
  31. - navigation.tabs.sticky
  32. - navigation.top
  33. - navigation.tracking
  34. - navigation.expand # 默认打开所有的字节
  35. - navigation.path
  36. - search.highlight
  37. - search.share
  38. - search.suggest
  39. - toc.follow
  40. # - toc.integrate
  41. palette: #设置切换light和dark模式
  42. - media: "(prefers-color-scheme: light)"
  43. scheme: default
  44. primary: indigo
  45. accent: indigo
  46. toggle:
  47. icon: material/weather-sunny
  48. name: Switch to dark mode
  49. - media: "(prefers-color-scheme: dark)"
  50. scheme: slate
  51. primary: black
  52. accent: indigo
  53. toggle:
  54. icon: material/weather-night
  55. name: Switch to system preference
  56. font:
  57. text: Roboto
  58. code: Roboto Mono
  59. favicon: assets/favicon.png
  60. icon:
  61. logo: logo
  62. edit: material/pencil
  63. view: material/eye
  64. repo: fontawesome/brands/github
  65. # Plugins
  66. plugins:
  67. - git-authors
  68. - tags
  69. - offline
  70. - blog
  71. - search:
  72. separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  73. - i18n: #设置中英文转换
  74. docs_structure: suffix
  75. fallback_to_default: true
  76. reconfigure_material: true
  77. reconfigure_search: true
  78. languages:
  79. - locale: zh
  80. name: 简体中文
  81. default: true
  82. build: true
  83. - locale: en
  84. name: English
  85. site_name: PaddleX Documentation
  86. link: /en/
  87. nav_translations:
  88. Home: Home
  89. 快速开始: Quick Start
  90. 安装: Installation
  91. 安装PaddlePaddle: PaddlePaddle Install
  92. 安装PaddleX: PaddleX Install
  93. 产线使用教程: Pipeline Tutorials
  94. 概述: Overview
  95. 文本图像智能分析: Informatio Extraction
  96. 文档场景信息抽取v3产线: PP-ChatOCRv3-doc
  97. 文档场景信息抽取v4产线: PP-ChatOCRv4-doc
  98. OCR: OCR
  99. 通用OCR产线: OCR
  100. 通用表格识别产线: General Table Recognition
  101. 通用版面解析产线: General Layout Parsing
  102. 公式识别产线: Formula Recognition
  103. 印章文本识别产线: Seal Recognition
  104. 计算机视觉: Computer Vision
  105. 通用图像分类: General Image Classification
  106. 通用目标检测: General Object Detection
  107. 通用实例分割: General Instance Segmentation
  108. 通用语义分割: General Semantic Segmentation
  109. 图像多标签分类: Image Multi-label Classification
  110. 小目标检测: Small Object Detection
  111. 图像异常检测: Image Anomaly Detection
  112. 通用图像识别: Image Feature
  113. 行人属性识别: Pedestrian Attribute Recognition
  114. 车辆属性识别: Vehicle Attribute Recognition
  115. 人脸识别: Face Feature
  116. 时序分析: Time Series Analysis
  117. 时序预测产线: Time Series Forecasting
  118. 时序异常检测产线: Time Series Anomaly Detection
  119. 时序分类产线: Time Series Classification
  120. 说明文件: Instructions
  121. PaddleX产线命令行使用说明: PaddleX Pipeline CLI Usage
  122. PaddleX产线Python脚本使用说明: PaddleX Pipeline Python API Usage
  123. 单功能模块使用教程: Module Tutorials
  124. OCR: OCR
  125. 文本检测模块: Text Detection
  126. 印章文本检测模块: Seal Detection
  127. 文本识别模块: Text Recognition
  128. 版面区域检测模块: Layout Parsing
  129. 表格结构识别模块: Table Structure Recognition
  130. 文档图像方向分类: Document Image Orientation Classification
  131. 文本图像矫正模块: Text Image Unwarping
  132. 公式识别模块: Formula Recognition
  133. 图像分类: Image Classification
  134. 图像分类模块: Image Classification
  135. 图像多标签分类模块: Image Multi-label Classification
  136. 行人属性识别模块: Pedestrian Attribute Recognition
  137. 车辆属性识别模块: Vehicle Attribute Recognition
  138. 图像特征: Image Features
  139. 图像特征模块: Image Feature
  140. 目标检测: Object Detection
  141. 目标检测模块: Object Detection
  142. 小目标检测模块: Small Object Detection
  143. 人脸检测模块: Face Detection
  144. 主体检测模块: Main Body Detection
  145. 行人检测模块: Human Detection
  146. 车辆检测模块: Vehicle Detection
  147. 图像分割: Image Segmentation
  148. 语义分割模块: Semantic Segmentation
  149. 实例分割模块: Instance Segmentation
  150. 图像异常检测模块: Image Anomaly Detection
  151. 时序分析: Time Series Analysis
  152. 时序预测模块: Time Series Forecasting
  153. 时序异常检测模块: Time Series Anomaly Detection
  154. 时序分类模块: Time Series Classification
  155. 说明文件: Instructions
  156. PaddleX单模型Python脚本使用说明: PaddleX Module Python API Usage
  157. PaddleX通用模型配置文件参数说明: PaddleX Common Module Config Parameters
  158. PaddleX时序任务模型配置文件参数说明: PaddleX Time Series Module Config Parameters
  159. 模型产线部署: Pipeline Deploy
  160. 高性能推理: High Performance Inference
  161. 服务化部署: Serving
  162. 端侧部署: Edge Deployment
  163. 多硬件使用: Multi-Device Usage
  164. 多硬件使用指南: Multi-Device Usage Guide
  165. 飞桨多硬件安装: PaddlePaddle Installation on Multiple Devices
  166. 海光 DCU 飞桨安装教程: Haiguang DCU PaddlePaddle Installation Guide
  167. 寒武纪 MLU 飞桨安装教程: Cambricon MLU PaddlePaddle Installation Guide
  168. 昇腾 NPU 飞桨安装教程: Ascend NPU PaddlePaddle Installation Guide
  169. 昆仑 XPU 飞桨安装教程: Kunlun XPU PaddlePaddle Installation Guide
  170. 燧原 GCU 飞桨安装教程: Enflame GCU PaddlePaddle Installation Guide
  171. 数据标注教程: Data Annotation Tutorials
  172. 计算机视觉: Computer Vision
  173. 图像分类任务模块: Image Classification Task
  174. 图像特征任务模块: Image Feature Task
  175. 实例分割任务模块: Instance Segmentation Task
  176. 图像多标签分类: Image Multi-label Classification
  177. 目标检测任务模块: Object Detection Task
  178. 语义分割任务模块: Semantic Segmentation Task
  179. OCR: OCR
  180. 表格识别任务模块: Table Recognition Task
  181. 文本检测/识别任务模块: Text Detection/Recognition Task
  182. 时序分析: Time Series Analysis
  183. 时序异常检测任务模块: Time Series Anomaly Detection Task
  184. 时序分类任务模块: Time Series Classification Task
  185. 时序预测任务模块: Time Series Forecasting Task
  186. 产线列表: Pipeline List
  187. PaddleX产线列表(CPU/GPU): PaddleX Pipeline List (CPU/GPU)
  188. PaddleX产线列表(DCU): PaddleX Pipeline List (DCU)
  189. PaddleX产线列表(MLU): PaddleX Pipeline List (MLU)
  190. PaddleX产线列表(NPU): PaddleX Pipeline List (NPU)
  191. PaddleX产线列表(XPU): PaddleX Pipeline List (XPU)
  192. 模型列表: Model List
  193. PaddleX模型列表(CPU/GPU): PaddleX Model List (CPU/GPU)
  194. PaddleX模型列表(DCU): PaddleX Model List (DCU)
  195. PaddleX模型列表(MLU): PaddleX Model List (MLU)
  196. PaddleX模型列表(NPU): PaddleX Model List (NPU)
  197. PaddleX模型列表(XPU): PaddleX Model List (XPU)
  198. PaddleX模型列表(GCU): PaddleX Model List (GCU)
  199. 产业实践教程&范例: Practical Tutorials & Examples
  200. 论文文献信息抽取教程: Document Scene Information Extraction Tutorial
  201. 垃圾分类教程: Garbage Classification Tutorial
  202. 遥感图像实例分割教程: Remote Sensing Image Instance Segmentation Tutorial
  203. 行人跌倒检测教程: Pedestrian Fall Detection Tutorial
  204. 服装时尚元素检测教程: Fashion Element Detection Tutorial
  205. 车牌识别教程: License Plate Recognition Tutorial
  206. 手写中文识别教程: Handwritten Chinese Recognition Tutorial
  207. 车道线分割教程: Lane Line Segmentation Tutorial
  208. 设备异常检测应用教程: Equipment Anomaly Detection Application Tutorial
  209. 心跳监测时序数据分类应用教程: Heartbeat Monitoring Time Series Data Classification Application Tutorial
  210. 用电量长期预测应用教程: Long-term Electricity Consumption Forecasting Application Tutorial
  211. 多语种语音识别模块: Multilingual Speech Recognition Task
  212. FAQ: FAQ
  213. 近期更新: Recently Update
  214. repository: PaddlePaddle/PaddleX #仓库名称
  215. branch: release/3.0-rc #仓库分支
  216. - git-revision-date-localized: #显示更新时间
  217. enable_creation_date: true
  218. # Additional configuration
  219. extra:
  220. version:
  221. provider: mike #显示版本
  222. status:
  223. new: Recently added
  224. deprecated: Deprecated
  225. analytics:
  226. provider: google
  227. property: !ENV GOOGLE_ANALYTICS_KEY
  228. social:
  229. - icon: fontawesome/brands/github
  230. link: https://github.com/PaddlePaddle/PaddleX
  231. extra_javascript:
  232. - javascripts/katex.min.js
  233. - https://unpkg.com/katex@0/dist/katex.min.js
  234. - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js
  235. extra_css:
  236. - https://unpkg.com/katex@0/dist/katex.min.css
  237. # Extensions
  238. markdown_extensions:
  239. - abbr
  240. - admonition
  241. - attr_list
  242. - def_list
  243. - footnotes
  244. - md_in_html
  245. - toc:
  246. permalink: true
  247. - pymdownx.arithmatex:
  248. generic: true
  249. - pymdownx.betterem:
  250. smart_enable: all
  251. - pymdownx.caret
  252. - pymdownx.details
  253. - pymdownx.emoji:
  254. emoji_generator: !!python/name:material.extensions.emoji.to_svg
  255. emoji_index: !!python/name:material.extensions.emoji.twemoji
  256. - pymdownx.highlight:
  257. anchor_linenums: true
  258. line_spans: __span
  259. pygments_lang_class: true
  260. - pymdownx.inlinehilite
  261. - pymdownx.keys
  262. - pymdownx.magiclink:
  263. normalize_issue_symbols: true
  264. repo_url_shorthand: true
  265. user: squidfunk
  266. repo: mkdocs-material
  267. - pymdownx.mark
  268. - pymdownx.smartsymbols
  269. - pymdownx.snippets:
  270. auto_append:
  271. - includes/mkdocs.md
  272. - pymdownx.superfences:
  273. custom_fences:
  274. - name: mermaid
  275. class: mermaid
  276. format: !!python/name:pymdownx.superfences.fence_code_format
  277. - pymdownx.tabbed:
  278. alternate_style: true
  279. combine_header_slug: true
  280. slugify: !!python/object/apply:pymdownx.slugs.slugify
  281. kwds:
  282. case: lower
  283. - pymdownx.tasklist:
  284. custom_checkbox: true
  285. - pymdownx.tilde
  286. # 页面结构
  287. nav:
  288. - Home: index.md
  289. - 安装:
  290. - 安装PaddlePaddle: installation/paddlepaddle_install.md
  291. - 安装PaddleX: installation/installation.md
  292. - 产线使用教程:
  293. - 概述: pipeline_usage/pipeline_develop_guide.md
  294. - 文本图像智能分析:
  295. - 文档场景信息抽取v3产线: pipeline_usage/tutorials/information_extraction_pipelines/document_scene_information_extraction_v3.md
  296. - 文档场景信息抽取v4产线: pipeline_usage/tutorials/information_extraction_pipelines/document_scene_information_extraction_v4.md
  297. - OCR:
  298. - 通用OCR产线: pipeline_usage/tutorials/ocr_pipelines/OCR.md
  299. - 通用表格识别产线: pipeline_usage/tutorials/ocr_pipelines/table_recognition.md
  300. - 通用版面解析产线: pipeline_usage/tutorials/ocr_pipelines/layout_parsing.md
  301. - 公式识别产线: pipeline_usage/tutorials/ocr_pipelines/formula_recognition.md
  302. - 印章文本识别产线: pipeline_usage/tutorials/ocr_pipelines/seal_recognition.md
  303. - 计算机视觉:
  304. - 通用图像分类: pipeline_usage/tutorials/cv_pipelines/image_classification.md
  305. - 通用目标检测: pipeline_usage/tutorials/cv_pipelines/object_detection.md
  306. - 通用实例分割: pipeline_usage/tutorials/cv_pipelines/instance_segmentation.md
  307. - 通用语义分割: pipeline_usage/tutorials/cv_pipelines/semantic_segmentation.md
  308. - 图像多标签分类: pipeline_usage/tutorials/cv_pipelines/image_multi_label_classification.md
  309. - 小目标检测: pipeline_usage/tutorials/cv_pipelines/small_object_detection.md
  310. - 图像异常检测: pipeline_usage/tutorials/cv_pipelines/image_anomaly_detection.md
  311. - 通用图像识别: pipeline_usage/tutorials/cv_pipelines/general_image_recognition.md
  312. - 行人属性识别: pipeline_usage/tutorials/cv_pipelines/pedestrian_attribute_recognition.md
  313. - 车辆属性识别: pipeline_usage/tutorials/cv_pipelines/vehicle_attribute_recognition.md
  314. - 人脸识别: pipeline_usage/tutorials/cv_pipelines/face_recognition.md
  315. - 时序分析:
  316. - 时序预测产线: pipeline_usage/tutorials/time_series_pipelines/time_series_forecasting.md
  317. - 时序异常检测产线: pipeline_usage/tutorials/time_series_pipelines/time_series_anomaly_detection.md
  318. - 时序分类产线: pipeline_usage/tutorials/time_series_pipelines/time_series_classification.md
  319. - 说明文件:
  320. - PaddleX产线命令行使用说明: pipeline_usage/instructions/pipeline_CLI_usage.md
  321. - PaddleX产线Python脚本使用说明: pipeline_usage/instructions/pipeline_python_API.md
  322. - 单功能模块使用教程:
  323. - OCR:
  324. - 文本检测模块: module_usage/tutorials/ocr_modules/text_detection.md
  325. - 印章文本检测模块: module_usage/tutorials/ocr_modules/seal_text_detection.md
  326. - 文本识别模块: module_usage/tutorials/ocr_modules/text_recognition.md
  327. - 版面区域检测模块: module_usage/tutorials/ocr_modules/layout_detection.md
  328. - 表格结构识别模块: module_usage/tutorials/ocr_modules/table_structure_recognition.md
  329. - 文档图像方向分类: module_usage/tutorials/ocr_modules/doc_img_orientation_classification.md
  330. - 文本图像矫正模块: module_usage/tutorials/ocr_modules/text_image_unwarping.md
  331. - 公式识别模块: module_usage/tutorials/ocr_modules/formula_recognition.md
  332. - 图像分类:
  333. - 图像分类模块: module_usage/tutorials/cv_modules/image_classification.md
  334. - 图像多标签分类模块: module_usage/tutorials/cv_modules/image_multilabel_classification.md
  335. - 行人属性识别模块: module_usage/tutorials/cv_modules/pedestrian_attribute_recognition.md
  336. - 车辆属性识别模块: module_usage/tutorials/cv_modules/vehicle_attribute_recognition.md
  337. - 图像特征:
  338. - 图像特征模块: module_usage/tutorials/cv_modules/image_feature.md
  339. - 人脸特征模块: module_usage/tutorials/cv_modules/face_feature.md
  340. - 目标检测:
  341. - 目标检测模块: module_usage/tutorials/cv_modules/object_detection.md
  342. - 小目标检测模块: module_usage/tutorials/cv_modules/small_object_detection.md
  343. - 人脸检测模块: module_usage/tutorials/cv_modules/face_detection.md
  344. - 主体检测模块: module_usage/tutorials/cv_modules/mainbody_detection.md
  345. - 行人检测模块: module_usage/tutorials/cv_modules/human_detection.md
  346. - 车辆检测模块: module_usage/tutorials/cv_modules/vehicle_detection.md
  347. - 图像分割:
  348. - 语义分割模块: module_usage/tutorials/cv_modules/semantic_segmentation.md
  349. - 实例分割模块: module_usage/tutorials/cv_modules/instance_segmentation.md
  350. - 图像异常检测模块: module_usage/tutorials/cv_modules/anomaly_detection.md
  351. - 时序分析:
  352. - 时序预测模块: module_usage/tutorials/time_series_modules/time_series_forecasting.md
  353. - 时序异常检测模块: module_usage/tutorials/time_series_modules/time_series_anomaly_detection.md
  354. - 时序分类模块: module_usage/tutorials/time_series_modules/time_series_classification.md
  355. - 语音识别:
  356. - 多语种语音识别模块: module_usage/tutorials/speech_modules/multilingual_speech_recognition.md
  357. - 3D检测:
  358. - BEV融合3D检测模块: module_usage/tutorials/cv_modules/3d_bev_detection.md
  359. - 说明文件:
  360. - PaddleX单模型Python脚本使用说明: module_usage/instructions/model_python_API.md
  361. - PaddleX通用模型配置文件参数说明: module_usage/instructions/config_parameters_common.md
  362. - PaddleX时序任务模型配置文件参数说明: module_usage/instructions/config_parameters_time_series.md
  363. - 模型产线部署:
  364. - 高性能推理: pipeline_deploy/high_performance_inference.md
  365. - 服务化部署: pipeline_deploy/serving.md
  366. - 端侧部署: pipeline_deploy/edge_deploy.md
  367. - 多硬件使用:
  368. - 多硬件使用指南: other_devices_support/multi_devices_use_guide.md
  369. - 飞桨多硬件安装:
  370. - 海光 DCU 飞桨安装教程: other_devices_support/paddlepaddle_install_DCU.md
  371. - 寒武纪 MLU 飞桨安装教程: other_devices_support/paddlepaddle_install_MLU.md
  372. - 昇腾 NPU 飞桨安装教程: other_devices_support/paddlepaddle_install_NPU.md
  373. - 昆仑 XPU 飞桨安装教程: other_devices_support/paddlepaddle_install_XPU.md
  374. - 燧原 GCU 飞桨安装教程: other_devices_support/paddlepaddle_install_GCU.md
  375. - 数据标注教程:
  376. - 计算机视觉:
  377. - 图像分类任务模块: data_annotations/cv_modules/image_classification.md
  378. - 图像特征任务模块: data_annotations/cv_modules/image_feature.md
  379. - 实例分割任务模块: data_annotations/cv_modules/instance_segmentation.md
  380. - 图像多标签分类: data_annotations/cv_modules/ml_classification.md
  381. - 目标检测任务模块: data_annotations/cv_modules/object_detection.md
  382. - 语义分割任务模块: data_annotations/cv_modules/semantic_segmentation.md
  383. - OCR:
  384. - 表格识别任务模块: data_annotations/ocr_modules/table_recognition.md
  385. - 文本检测/识别任务模块: data_annotations/ocr_modules/text_detection_recognition.md
  386. - 时序分析:
  387. - 时序异常检测任务模块: data_annotations/time_series_modules/time_series_anomaly_detection.md
  388. - 时序分类任务模块: data_annotations/time_series_modules/time_series_classification.md
  389. - 时序预测任务模块: data_annotations/time_series_modules/time_series_forecasting.md
  390. - 产线列表:
  391. - PaddleX产线列表(CPU/GPU): support_list/pipelines_list.md
  392. - PaddleX产线列表(DCU): support_list/pipelines_list_dcu.md
  393. - PaddleX产线列表(MLU): support_list/pipelines_list_mlu.md
  394. - PaddleX产线列表(NPU): support_list/pipelines_list_npu.md
  395. - PaddleX产线列表(XPU): support_list/pipelines_list_xpu.md
  396. - 模型列表:
  397. - PaddleX模型列表(CPU/GPU): support_list/models_list.md
  398. - PaddleX模型列表(DCU): support_list/model_list_dcu.md
  399. - PaddleX模型列表(MLU): support_list/model_list_mlu.md
  400. - PaddleX模型列表(NPU): support_list/model_list_npu.md
  401. - PaddleX模型列表(XPU): support_list/model_list_xpu.md
  402. - PaddleX模型列表(GCU): support_list/model_list_gcu.md
  403. - 产业实践教程&范例:
  404. - 论文文献信息抽取教程: practical_tutorials/document_scene_information_extraction(layout_detection)_tutorial.md
  405. - 垃圾分类教程: practical_tutorials/image_classification_garbage_tutorial.md
  406. - 遥感图像实例分割教程: practical_tutorials/instance_segmentation_remote_sensing_tutorial.md
  407. - 行人跌倒检测教程: practical_tutorials/object_detection_fall_tutorial.md
  408. - 服装时尚元素检测教程: practical_tutorials/object_detection_fashion_pedia_tutorial.md
  409. - 车牌识别教程: practical_tutorials/ocr_det_license_tutorial.md
  410. - 手写中文识别教程: practical_tutorials/ocr_rec_chinese_tutorial.md
  411. - 车道线分割教程: practical_tutorials/semantic_segmentation_road_tutorial.md
  412. - 设备异常检测应用教程: practical_tutorials/ts_anomaly_detection.md
  413. - 心跳监测时序数据分类应用教程: practical_tutorials/ts_classification.md
  414. - 用电量长期预测应用教程: practical_tutorials/ts_forecast.md
  415. - FAQ: FAQ.md
  416. - 近期更新: CHANGLOG.md