Skip to content

Commit

Permalink
update index.md (#2580)
Browse files Browse the repository at this point in the history 
* update docs

* update docs
  • Loading branch information
@AmberC0209
AmberC0209 authored Nov 29, 2024
1 parent 6d896f1 commit 9b85646
Show file tree
Hide file tree
Showing 4 changed files with 102 additions and 43 deletions.
1 change: 0 additions & 1 deletion .github/workflows/deploy_docs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,3 @@ jobs:
git fetch origin gh-pages --depth=1
mike deploy --push --update-aliases 3.0-beta2 latest
mike set-default --push latest
70 changes: 50 additions & 20 deletions docs/index.en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,13 +148,15 @@ You only need to specify three parameters:
=== "OCR"

```bash
paddlex --pipeline OCR --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_ocr_002.png --device gpu:0
paddlex --pipeline OCR --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_ocr_002.png --device gpu:0 --save_path output
```

* After running, the output results and visualized images will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
=== "output"
```bash
'input_path': '/root/.paddlex/predict_input/general_ocr_002.png',
{'input_path': '/root/.paddlex/predict_input/general_ocr_002.png',
'dt_polys': [array([[161, 27],
[353, 22],
[354, 69],
Expand All @@ -181,9 +183,11 @@ You only need to specify three parameters:
=== "Table Recognition"

```bash
paddlex --pipeline table_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/table_recognition.jpg --device gpu:0
paddlex --pipeline table_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/table_recognition.jpg --device gpu:0 --save_path output
```

* After running, the output results and visualized images will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
=== "output"
```bash
Expand Down Expand Up @@ -253,9 +257,11 @@ You only need to specify three parameters:
=== "Layout Parsing"

```bash
paddlex --pipeline layout_parsing --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/demo_paper.png --device gpu:0
paddlex --pipeline layout_parsing --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/demo_paper.png --device gpu:0 --save_path output
```

* After running, the output results and visualized images will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
```bash
{'input_path': PosixPath('/root/.paddlex/temp/tmp5jmloefs.png'), 'parsing_result': [{'input_path': PosixPath('/root/.paddlex/temp/tmpshsq8_w0.png'), 'layout_bbox': [51.46833, 74.22329, 542.4082, 232.77504], 'image': {'img': array([[[255, 255, 255],
Expand Down Expand Up @@ -284,9 +290,11 @@ You only need to specify three parameters:
=== "Formula Recognition"

```bash
paddlex --pipeline formula_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/demo_image/general_formula_recognition.png --device gpu:0
paddlex --pipeline formula_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/demo_image/general_formula_recognition.png --device gpu:0 --save_path output
```

* After running, the output results and visualized images will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
=== "output"
```bash
Expand Down Expand Up @@ -315,13 +323,15 @@ You only need to specify three parameters:
=== "Seal Text Recognition"

```bash
paddlex --pipeline seal_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/seal_text_det.png --device gpu:0
paddlex --pipeline seal_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/seal_text_det.png --device gpu:0 --save_path output
```

* After running, the output results and visualized images will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
=== "output"
```bash
{'input_path': PosixPath('/root/.paddlex/temp/tmpa8eqnpus.png'), 'layout_result': {'input_path': PosixPath('/root/.paddlex/temp/tmpa8eqnpus.png'), 'boxes': [{'cls_id': 2, 'label': 'seal', 'score': 0.9813321828842163, 'coordinate': [0, 5.1820183, 639.59314, 637.7533]}]}, 'ocr_result': {'dt_polys': [array([[166, 468],
{'input_path': PosixPath('/root/.paddlex/temp/tmpa8eqnpus.png'), 'layout_result': {'input_path': PosixPath('/root/.paddlex/temp/tmpa8eqnpus.png'), 'boxes': [{'cls_id': 2, 'label': 'seal', 'score': 0.9813321828842163, 'coordinate': [0, 5.1820183, 639.59314, 637.7533]}]}, 'ocr_result': {'dt_polys': [array([[166, 468],
[206, 503],
[249, 523],
[312, 535],
Expand Down Expand Up @@ -448,8 +458,8 @@ You only need to specify three parameters:
[151, 92],
[154, 91],
[315, 38],
[320, 37]])], 'dt_scores': [0.99375725701319, 0.9871711582010613, 0.9937523531067023, 0.9911629231838204], 'rec_text': ['5263647368706', '吗繁物', '发票专天津君和缘商贸有限公司'], 'rec_score': [0.9933745265007019, 0.998288631439209, 0.9999362230300903, 0.9923253655433655], 'input_path': PosixPath('/Users/chenghong0temp/tmpa8eqnpus.png')}, 'src_file_name': 'https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/seal_text_det.png', 'page_id': 0}
```
[320, 37]])], 'dt_scores': [0.99375725701319, 0.9871711582010613, 0.9937523531067023, 0.9911629231838204], 'rec_text': ['5263647368706', '吗繁物', '发票专天津君和缘商贸有限公司'], 'rec_score': [0.9933745265007019, 0.998288631439209, 0.9999362230300903, 0.9923253655433655], 'input_path': PosixPath('/Users/chenghong0temp/tmpa8eqnpus.png')}, 'src_file_name': 'https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/seal_text_det.png', 'page_id': 0}
```

=== "img"

Expand All @@ -461,9 +471,11 @@ You only need to specify three parameters:
=== "Image Classification"

```bash
paddlex --pipeline image_classification --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_image_classification_001.jpg --device gpu:0
paddlex --pipeline image_classification --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_image_classification_001.jpg --device gpu:0 --save_path output
```

* After running, the output results and visualized images will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
=== "output"
```bash
Expand All @@ -477,8 +489,11 @@ You only need to specify three parameters:
=== "Object Detection"

```bash
paddlex --pipeline object_detection --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_object_detection_002.png --device gpu:0
paddlex --pipeline object_detection --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_object_detection_002.png --device gpu:0 --save_path output
```

* After running, the output results and visualized images will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
=== "output"
```bash
Expand All @@ -492,9 +507,11 @@ You only need to specify three parameters:
=== "Instance Segmentation"

```bash
paddlex --pipeline instance_segmentation --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_instance_segmentation_004.png --device gpu:0
paddlex --pipeline instance_segmentation --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_instance_segmentation_004.png --device gpu:0 --save_path output
```

* After running, the output results and visualized images will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
=== "output"
```bash
Expand All @@ -508,9 +525,11 @@ You only need to specify three parameters:
=== "Semantic Segmentation"

```bash
paddlex --pipeline semantic_segmentation --input https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/application/semantic_segmentation/makassaridn-road_demo.png --device gpu:0
paddlex --pipeline semantic_segmentation --input https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/application/semantic_segmentation/makassaridn-road_demo.png --device gpu:0 --save_path output
```

* After running, the output results and visualized images will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
=== "output"
```bash
Expand All @@ -524,9 +543,11 @@ You only need to specify three parameters:
=== "Image Multi-label Classification"

```bash
paddlex --pipeline multi_label_image_classification --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_image_classification_001.jpg --device gpu:0
paddlex --pipeline multi_label_image_classification --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_image_classification_001.jpg --device gpu:0 --save_path output
```

* After running, the output results and visualized images will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
=== "output"
```bash
Expand All @@ -540,9 +561,11 @@ You only need to specify three parameters:
=== "Small Object Detection"

```bash
paddlex --pipeline small_object_detection --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/small_object_detection.jpg --device gpu:0
paddlex --pipeline small_object_detection --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/small_object_detection.jpg --device gpu:0 --save_path output
```

* After running, the output results and visualized images will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
=== "output"
```bash
Expand All @@ -556,9 +579,11 @@ You only need to specify three parameters:
=== "Image Anomaly Detection"

```bash
paddlex --pipeline anomaly_detection --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/uad_grid.png --device gpu:0
paddlex --pipeline anomaly_detection --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/uad_grid.png --device gpu:0 --save_path output
```

* After running, the output results and visualized images will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
=== "output"
```bash
Expand All @@ -574,9 +599,11 @@ You only need to specify three parameters:
=== "Time Series Forecasting"

```bash
paddlex --pipeline ts_fc --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_fc.csv --device gpu:0
paddlex --pipeline ts_fc --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_fc.csv --device gpu:0 --save_path output
```

* After running, the output results will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
```bash
{'input_path': 'ts_fc.csv', 'forecast': OT
Expand All @@ -599,9 +626,11 @@ You only need to specify three parameters:
=== "Time Series Anomaly Detection"

```bash
paddlex --pipeline ts_ad --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_ad.csv --device gpu:0
paddlex --pipeline ts_ad --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_ad.csv --device gpu:0 --save_path output
```

* After running, the output results will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
```bash
{'input_path': 'ts_ad.csv', 'anomaly': label
Expand All @@ -624,9 +653,11 @@ You only need to specify three parameters:
=== "Time Series Classification"

```bash
paddlex --pipeline ts_cls --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_cls.csv --device gpu:0
paddlex --pipeline ts_cls --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_cls.csv --device gpu:0 --save_path output
```

* After running, the output results will be saved in the `output` folder. You can also customize the save path by modifying the `--save_path` parameter.

??? question "What's the result"
```bash
{'input_path': 'ts_cls.csv', 'classification': classid score
Expand Down Expand Up @@ -924,4 +955,3 @@ The following steps were executed:
## 💬 Discussion

We warmly welcome and encourage community members to raise questions, share ideas, and feedback in the [Discussions](https://github.com/PaddlePaddle/PaddleX/discussions) section. Whether you want to report a bug, discuss a feature request, seek help, or just want to keep up with the latest project news, this is a great platform.

Loading

0 comments on commit 9b85646

Please sign in to comment.