Skip to content

Commit 739db9e

Browse files
authored
update docs (#2556)
1 parent 083d885 commit 739db9e

File tree

10 files changed

+2086
-1631
lines changed

10 files changed

+2086
-1631
lines changed

.github/workflows/deploy_docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ name: Develop Docs
22
on:
33
push:
44
branches: #设置更新哪个分支会更新站点
5-
- develop
65
- release/3.0-beta2
76
permissions:
87
contents: write
@@ -28,5 +27,6 @@ jobs:
2827
- run: pip install mike mkdocs-material jieba mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-git-authors-plugin mkdocs-static-i18n mkdocs-minify-plugin
2928
- run: |
3029
git fetch origin gh-pages --depth=1
31-
mike deploy --push --update-aliases main latest
30+
mike deploy --push --update-aliases 3.0-beta2 latest
3231
mike set-default --push latest
32+

docs/index.en.md

Lines changed: 799 additions & 326 deletions
Large diffs are not rendered by default.

docs/index.md

Lines changed: 799 additions & 324 deletions
Large diffs are not rendered by default.

docs/pipeline_usage/pipeline_develop_guide.en.md

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -186,67 +186,84 @@ Choose the appropriate deployment method for your model pipeline based on your n
186186
<tbody>
187187
<tr>
188188
<td>PP-ChatOCR-doc v3</td>
189-
<td><a href="./tutorials/information_extraction_pipelines/document_scene_information_extraction.en.md">PP-ChatOCR-doc v3 Pipeline Usage Tutorial</a></td>
189+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/information_extraction_pipelines/document_scene_information_extraction.html">PP-ChatOCR-doc v3 Pipeline Usage Tutorial</a></td>
190190
</tr>
191191
<tr>
192192
<td>Image Classification</td>
193-
<td><a href="./tutorials/cv_pipelines/image_classification.en.md">Image Classification Pipeline Usage Tutorial</a></td>
193+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/cv_pipelines/image_classification.html">Image Classification Pipeline Usage Tutorial</a></td>
194194
</tr>
195195
<tr>
196196
<td>Object Detection</td>
197-
<td><a href="./tutorials/cv_pipelines/object_detection.en.md">Object Detection Pipeline Usage Tutorial</a></td>
197+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/cv_pipelines/object_detection.html">Object Detection Pipeline Usage Tutorial</a></td>
198198
</tr>
199199
<tr>
200200
<td>Instance Segmentation</td>
201-
<td><a href="./tutorials/cv_pipelines/instance_segmentation.en.md">Instance Segmentation Pipeline Usage Tutorial</a></td>
201+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/cv_pipelines/instance_segmentation.html">Instance Segmentation Pipeline Usage Tutorial</a></td>
202202
</tr>
203203
<tr>
204204
<td>Semantic Segmentation</td>
205-
<td><a href="./tutorials/cv_pipelines/semantic_segmentation.en.md">Semantic Segmentation Pipeline Usage Tutorial</a></td>
205+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/cv_pipelines/semantic_segmentation.html">Semantic Segmentation Pipeline Usage Tutorial</a></td>
206206
</tr>
207207
<tr>
208208
<td>Image Multi-label Classification</td>
209-
<td><a href="./tutorials/cv_pipelines/image_multi_label_classification.en.md">Image Multi-label Classification Pipeline Usage Tutorial</a></td>
209+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/cv_pipelines/image_multi_label_classification.html">Image Multi-label Classification Pipeline Usage Tutorial</a></td>
210+
</tr>
211+
<tr>
212+
<td>Image Recognition</td>
213+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/cv_pipelines/general_image_recognition.html">Image Recognition Pipeline Usage Tutorial</a></td>
214+
</tr>
215+
<tr>
216+
<td>Pedestrian Attribute Recognition</td>
217+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/cv_pipelines/pedestrian_attribute.html">Pedestrian Attribute Recognition Pipeline Usage Tutorial</a></td>
218+
</tr>
219+
<tr>
220+
<td>Vehicle Attribute Recognition</td>
221+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/cv_pipelines/vehicle_attribute.html">Vehicle Attribute Recognition Pipeline Usage Tutorial</a></td>
222+
</tr>
223+
<tr>
224+
<td>Face Recognition</td>
225+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/cv_pipelines/face_recognition.html">Face Recognition Pipeline Usage Tutorial</a></td>
210226
</tr>
211227
<tr>
212228
<td>Small Object Detection</td>
213-
<td><a href="./tutorials/cv_pipelines/small_object_detection.en.md">Small Object Detection Pipeline Usage Tutorial</a></td>
229+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/cv_pipelines/small_object_detection.html">Small Object Detection Pipeline Usage Tutorial</a></td>
214230
</tr>
215231
<tr>
216232
<td>Image Anomaly Detection</td>
217-
<td><a href="./tutorials/cv_pipelines/image_anomaly_detection.en.md">Image Anomaly Detection Pipeline Usage Tutorial</a></td>
233+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/cv_pipelines/image_anomaly_detection.html">Image Anomaly Detection Pipeline Usage Tutorial</a></td>
218234
</tr>
219235
<tr>
220236
<td>OCR</td>
221-
<td><a href="./tutorials/ocr_pipelines/OCR.en.md">OCR Pipeline Usage Tutorial</a></td>
237+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/ocr_pipelines/OCR.html">OCR Pipeline Usage Tutorial</a></td>
222238
</tr>
223239
<tr>
224240
<td>Table Recognition</td>
225-
<td><a href="./tutorials/ocr_pipelines/table_recognition.en.md">Table Recognition Pipeline Usage Tutorial</a></td>
241+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/ocr_pipelines/table_recognition.html">Table Recognition Pipeline Usage Tutorial</a></td>
226242
</tr>
227243
<tr>
228244
<td>Layout Parsing</td>
229-
<td><a href="./tutorials/ocr_pipelines/layout_parsing.en.md">Layout Parsing Pipeline Usage Tutorial</a></td>
245+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/ocr_pipelines/layout_parsing.html">Layout Parsing Pipeline Usage Tutorial</a></td>
230246
</tr>
231247
<tr>
232248
<td>Formula Recognition</td>
233-
<td><a href="./tutorials/ocr_pipelines/formula_recognition.en.md">Formula Recognition Pipeline Usage Tutorial</a></td>
249+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/ocr_pipelines/formula_recognition.html">Formula Recognition Pipeline Usage Tutorial</a></td>
234250
</tr>
235251
<tr>
236252
<td>Seal Recognition</td>
237-
<td><a href="./tutorials/ocr_pipelines/seal_recognition.en.md">Seal Recognition Pipeline Usage Tutorial</a></td>
253+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/ocr_pipelines/seal_recognition.html">Seal Recognition Pipeline Usage Tutorial</a></td>
238254
</tr>
239255
<tr>
240256
<td>Time Series Forecasting</td>
241-
<td><a href="./tutorials/time_series_pipelines/time_series_forecasting.en.md">Time Series Forecasting Pipeline Usage Tutorial</a></td>
257+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/time_series_pipelines/time_series_forecasting.html">Time Series Forecasting Pipeline Usage Tutorial</a></td>
242258
</tr>
243259
<tr>
244260
<td>Time Series Anomaly Detection</td>
245-
<td><a href="./tutorials/time_series_pipelines/time_series_anomaly_detection.en.md">Time Series Anomaly Detection Pipeline Usage Tutorial</a></td>
261+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/time_series_pipelines/time_series_anomaly_detection.html">Time Series Anomaly Detection Pipeline Usage Tutorial</a></td>
246262
</tr>
247263
<tr>
248264
<td>Time Series Classification</td>
249-
<td><a href="./tutorials/time_series_pipelines/time_series_classification.en.md">Time Series Classification Pipeline Usage Tutorial</a></td>
265+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/en/pipeline_usage/tutorials/time_series_pipelines/time_series_classification.html">Time Series Classification Pipeline Usage Tutorial</a></td>
250266
</tr>
251267
</tbody>
252268
</table>
269+

docs/pipeline_usage/pipeline_develop_guide.md

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -188,67 +188,84 @@ Pipeline:
188188
<tbody>
189189
<tr>
190190
<td>文档场景信息抽取v3</td>
191-
<td><a href="./tutorials/information_extraction_pipelines/document_scene_information_extraction.md">文档场景信息抽取v3产线使用教程</a></td>
191+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/information_extraction_pipelines/document_scene_information_extraction.html">文档场景信息抽取v3产线使用教程</a></td>
192192
</tr>
193193
<tr>
194194
<td>通用图像分类</td>
195-
<td><a href="./tutorials/cv_pipelines/image_classification.md">通用图像分类产线使用教程</a></td>
195+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/cv_pipelines/image_classification.html">通用图像分类产线使用教程</a></td>
196196
</tr>
197197
<tr>
198198
<td>通用目标检测</td>
199-
<td><a href="./tutorials/cv_pipelines/object_detection.md">通用目标检测产线使用教程</a></td>
199+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/cv_pipelines/object_detection.html">通用目标检测产线使用教程</a></td>
200200
</tr>
201201
<tr>
202202
<td>通用实例分割</td>
203-
<td><a href="./tutorials/cv_pipelines/instance_segmentation.md">通用实例分割产线使用教程</a></td>
203+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/cv_pipelines/instance_segmentation.html">通用实例分割产线使用教程</a></td>
204204
</tr>
205205
<tr>
206206
<td>通用语义分割</td>
207-
<td><a href="./tutorials/cv_pipelines/semantic_segmentation.md">通用语义分割产线使用教程</a></td>
207+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/cv_pipelines/semantic_segmentation.html">通用语义分割产线使用教程</a></td>
208208
</tr>
209209
<tr>
210210
<td>通用图像多标签分类</td>
211-
<td><a href="./tutorials/cv_pipelines/image_multi_label_classification.md">通用图像多标签分类产线使用教程</a></td>
211+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/cv_pipelines/image_multi_label_classification.html">通用图像多标签分类产线使用教程</a></td>
212+
</tr>
213+
<tr>
214+
<td>通用图像识别</td>
215+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/cv_pipelines/general_image_recognition.html">通用图像识别产线使用教程</a></td>
216+
</tr>
217+
<tr>
218+
<td>行人属性识别</td>
219+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/cv_pipelines/pedestrian_attribute_recognition.html">行人属性识别产线使用教程</a></td>
220+
</tr>
221+
<tr>
222+
<td>车辆属性识别</td>
223+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/cv_pipelines/vehicle_attribute_recognition.html">车辆属性识别产线使用教程</a></td>
224+
</tr>
225+
<tr>
226+
<td>人脸识别</td>
227+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/cv_pipelines/face_recognition.html">人脸识别产线使用教程</a></td>
212228
</tr>
213229
<tr>
214230
<td>小目标检测</td>
215-
<td><a href="./tutorials/cv_pipelines/small_object_detection.md">小目标检测产线使用教程</a></td>
231+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/cv_pipelines/small_object_detection.html">小目标检测产线使用教程</a></td>
216232
</tr>
217233
<tr>
218234
<td>图像异常检测</td>
219-
<td><a href="./tutorials/cv_pipelines/image_anomaly_detection.md">图像异常检测产线使用教程</a></td>
235+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/cv_pipelines/image_anomaly_detection.html">图像异常检测产线使用教程</a></td>
220236
</tr>
221237
<tr>
222238
<td>通用OCR</td>
223-
<td><a href="./tutorials/ocr_pipelines/OCR.md">通用OCR产线使用教程</a></td>
239+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/ocr_pipelines/OCR.html">通用OCR产线使用教程</a></td>
224240
</tr>
225241
<tr>
226242
<td>通用表格识别</td>
227-
<td><a href="./tutorials/ocr_pipelines/table_recognition.md">通用表格识别产线使用教程</a></td>
243+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/ocr_pipelines/table_recognition.html">通用表格识别产线使用教程</a></td>
228244
</tr>
229245
<tr>
230246
<td>通用版面解析</td>
231-
<td><a href="./tutorials/ocr_pipelines/layout_parsing.md">通用版面解析产线使用教程</a></td>
247+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/ocr_pipelines/layout_parsing.html">通用版面解析产线使用教程</a></td>
232248
</tr>
233249
<tr>
234250
<td>公式识别</td>
235-
<td><a href="./tutorials/ocr_pipelines/formula_recognition.md">公式识别产线使用教程</a></td>
251+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/ocr_pipelines/formula_recognition.html">公式识别产线使用教程</a></td>
236252
</tr>
237253
<tr>
238254
<td>印章文本识别</td>
239-
<td><a href="./tutorials/ocr_pipelines/seal_recognition.md">印章文本识别产线使用教程</a></td>
255+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/ocr_pipelines/seal_recognition.html">印章文本识别产线使用教程</a></td>
240256
</tr>
241257
<tr>
242258
<td>时序预测</td>
243-
<td><a href="./tutorials/time_series_pipelines/time_series_forecasting.md">通用时序预测产线使用教程</a></td>
259+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/time_series_pipelines/time_series_forecasting.html">通用时序预测产线使用教程</a></td>
244260
</tr>
245261
<tr>
246262
<td>时序异常检测</td>
247-
<td><a href="./tutorials/time_series_pipelines/time_series_anomaly_detection.md">通用时序异常检测产线使用教程</a></td>
263+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/time_series_pipelines/time_series_anomaly_detection.html">通用时序异常检测产线使用教程</a></td>
248264
</tr>
249265
<tr>
250266
<td>时序分类</td>
251-
<td><a href="./tutorials/time_series_pipelines/time_series_classification.md">通用时序分类产线使用教程</a></td>
267+
<td><a href="https://paddlepaddle.github.io/PaddleX/latest/pipeline_usage/tutorials/time_series_pipelines/time_series_classification.html">通用时序分类产线使用教程</a></td>
252268
</tr>
253269
</tbody>
254270
</table>
271+

0 commit comments

Comments
 (0)