Skip to content

Commit 9b85646

Browse files
authored
update index.md (#2580)
* update docs * update docs
1 parent 6d896f1 commit 9b85646

File tree

4 files changed

+102
-43
lines changed

4 files changed

+102
-43
lines changed

.github/workflows/deploy_docs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,3 @@ jobs:
2929
git fetch origin gh-pages --depth=1
3030
mike deploy --push --update-aliases 3.0-beta2 latest
3131
mike set-default --push latest
32-

docs/index.en.md

Lines changed: 50 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -148,13 +148,15 @@ You only need to specify three parameters:
148148
=== "OCR"
149149

150150
```bash
151-
paddlex --pipeline OCR --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_ocr_002.png --device gpu:0
151+
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
152152
```
153153

154+
* 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.
155+
154156
??? question "What's the result"
155157
=== "output"
156158
```bash
157-
'input_path': '/root/.paddlex/predict_input/general_ocr_002.png',
159+
{'input_path': '/root/.paddlex/predict_input/general_ocr_002.png',
158160
'dt_polys': [array([[161, 27],
159161
[353, 22],
160162
[354, 69],
@@ -181,9 +183,11 @@ You only need to specify three parameters:
181183
=== "Table Recognition"
182184

183185
```bash
184-
paddlex --pipeline table_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/table_recognition.jpg --device gpu:0
186+
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
185187
```
186188

189+
* 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.
190+
187191
??? question "What's the result"
188192
=== "output"
189193
```bash
@@ -253,9 +257,11 @@ You only need to specify three parameters:
253257
=== "Layout Parsing"
254258

255259
```bash
256-
paddlex --pipeline layout_parsing --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/demo_paper.png --device gpu:0
260+
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
257261
```
258262

263+
* 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.
264+
259265
??? question "What's the result"
260266
```bash
261267
{'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],
@@ -284,9 +290,11 @@ You only need to specify three parameters:
284290
=== "Formula Recognition"
285291

286292
```bash
287-
paddlex --pipeline formula_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/demo_image/general_formula_recognition.png --device gpu:0
293+
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
288294
```
289295

296+
* 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.
297+
290298
??? question "What's the result"
291299
=== "output"
292300
```bash
@@ -315,13 +323,15 @@ You only need to specify three parameters:
315323
=== "Seal Text Recognition"
316324

317325
```bash
318-
paddlex --pipeline seal_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/seal_text_det.png --device gpu:0
326+
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
319327
```
320328

329+
* 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.
330+
321331
??? question "What's the result"
322332
=== "output"
323333
```bash
324-
{'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],
334+
{'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],
325335
[206, 503],
326336
[249, 523],
327337
[312, 535],
@@ -448,8 +458,8 @@ You only need to specify three parameters:
448458
[151, 92],
449459
[154, 91],
450460
[315, 38],
451-
[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}
452-
```
461+
[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}
462+
```
453463

454464
=== "img"
455465

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

463473
```bash
464-
paddlex --pipeline image_classification --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_image_classification_001.jpg --device gpu:0
474+
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
465475
```
466476

477+
* 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.
478+
467479
??? question "What's the result"
468480
=== "output"
469481
```bash
@@ -477,8 +489,11 @@ You only need to specify three parameters:
477489
=== "Object Detection"
478490

479491
```bash
480-
paddlex --pipeline object_detection --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_object_detection_002.png --device gpu:0
492+
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
481493
```
494+
495+
* 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.
496+
482497
??? question "What's the result"
483498
=== "output"
484499
```bash
@@ -492,9 +507,11 @@ You only need to specify three parameters:
492507
=== "Instance Segmentation"
493508

494509
```bash
495-
paddlex --pipeline instance_segmentation --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_instance_segmentation_004.png --device gpu:0
510+
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
496511
```
497512

513+
* 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.
514+
498515
??? question "What's the result"
499516
=== "output"
500517
```bash
@@ -508,9 +525,11 @@ You only need to specify three parameters:
508525
=== "Semantic Segmentation"
509526

510527
```bash
511-
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
528+
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
512529
```
513530

531+
* 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.
532+
514533
??? question "What's the result"
515534
=== "output"
516535
```bash
@@ -524,9 +543,11 @@ You only need to specify three parameters:
524543
=== "Image Multi-label Classification"
525544

526545
```bash
527-
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
546+
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
528547
```
529548

549+
* 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.
550+
530551
??? question "What's the result"
531552
=== "output"
532553
```bash
@@ -540,9 +561,11 @@ You only need to specify three parameters:
540561
=== "Small Object Detection"
541562

542563
```bash
543-
paddlex --pipeline small_object_detection --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/small_object_detection.jpg --device gpu:0
564+
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
544565
```
545566

567+
* 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.
568+
546569
??? question "What's the result"
547570
=== "output"
548571
```bash
@@ -556,9 +579,11 @@ You only need to specify three parameters:
556579
=== "Image Anomaly Detection"
557580

558581
```bash
559-
paddlex --pipeline anomaly_detection --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/uad_grid.png --device gpu:0
582+
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
560583
```
561584

585+
* 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.
586+
562587
??? question "What's the result"
563588
=== "output"
564589
```bash
@@ -574,9 +599,11 @@ You only need to specify three parameters:
574599
=== "Time Series Forecasting"
575600

576601
```bash
577-
paddlex --pipeline ts_fc --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_fc.csv --device gpu:0
602+
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
578603
```
579604

605+
* 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.
606+
580607
??? question "What's the result"
581608
```bash
582609
{'input_path': 'ts_fc.csv', 'forecast': OT
@@ -599,9 +626,11 @@ You only need to specify three parameters:
599626
=== "Time Series Anomaly Detection"
600627

601628
```bash
602-
paddlex --pipeline ts_ad --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_ad.csv --device gpu:0
629+
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
603630
```
604631

632+
* 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.
633+
605634
??? question "What's the result"
606635
```bash
607636
{'input_path': 'ts_ad.csv', 'anomaly': label
@@ -624,9 +653,11 @@ You only need to specify three parameters:
624653
=== "Time Series Classification"
625654

626655
```bash
627-
paddlex --pipeline ts_cls --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_cls.csv --device gpu:0
656+
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
628657
```
629658

659+
* 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.
660+
630661
??? question "What's the result"
631662
```bash
632663
{'input_path': 'ts_cls.csv', 'classification': classid score
@@ -924,4 +955,3 @@ The following steps were executed:
924955
## 💬 Discussion
925956

926957
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.
927-

0 commit comments

Comments
 (0)