Selaa lähdekoodia

Fix module docs (#3276)

* fix OVS doc

* fix modules docs
Zhang Zelun 9 kuukautta sitten
vanhempi
commit
4f4b652c69

+ 2 - 2
docs/module_usage/tutorials/cv_modules/human_detection.en.md

@@ -134,7 +134,7 @@ The explanations for the methods, parameters, etc., are as follows:
 <tr>
 <td><code>input</code></td>
 <td>Data to be predicted, supporting multiple input types</td>
-<td><code>Python Var</code>/<code>str</code>/<code>dict</code>/<code>list</code></td>
+<td><code>Python Var</code>/<code>str</code>/<code>list</code></td>
 <td>
 <ul>
   <li><b>Python variable</b>, such as image data represented by <code>numpy.ndarray</code></li>
@@ -302,7 +302,7 @@ After executing the above command, PaddleX will validate the dataset and collect
   &quot;analysis&quot;: {
     &quot;histogram&quot;: &quot;check_dataset/histogram.png&quot;
   },
-  &quot;dataset_path&quot;: &quot;./dataset/example_data/widerperson_coco_examples&quot;,
+  &quot;dataset_path&quot;: &quot;widerperson_coco_examples&quot;,
   &quot;show_type&quot;: &quot;image&quot;,
   &quot;dataset_type&quot;: &quot;COCODetDataset&quot;
 }

+ 2 - 2
docs/module_usage/tutorials/cv_modules/human_detection.md

@@ -129,7 +129,7 @@ for res in output:
 <tr>
 <td><code>input</code></td>
 <td>待预测数据,支持多种输入类型</td>
-<td><code>Python Var</code>/<code>str</code>/<code>dict</code>/<code>list</code></td>
+<td><code>Python Var</code>/<code>str</code>/<code>list</code></td>
 <td>
 <ul>
   <li><b>Python变量</b>,如<code>numpy.ndarray</code>表示的图像数据</li>
@@ -298,7 +298,7 @@ python main.py -c paddlex/configs/modules/human_detection/PP-YOLOE-S_human.yaml
   &quot;analysis&quot;: {
     &quot;histogram&quot;: &quot;check_dataset/histogram.png&quot;
   },
-  &quot;dataset_path&quot;: &quot;./dataset/example_data/widerperson_coco_examples&quot;,
+  &quot;dataset_path&quot;: &quot;widerperson_coco_examples&quot;,
   &quot;show_type&quot;: &quot;image&quot;,
   &quot;dataset_type&quot;: &quot;COCODetDataset&quot;
 }

+ 2 - 2
docs/module_usage/tutorials/cv_modules/instance_segmentation.en.md

@@ -254,7 +254,7 @@ Related methods, parameters, and explanations are as follows:
 <tr>
 <td><code>input</code></td>
 <td>Data to be predicted, supporting multiple input types</td>
-<td><code>Python Var</code>/<code>str</code>/<code>dict</code>/<code>list</code></td>
+<td><code>Python Var</code>/<code>str</code>/<code>list</code></td>
 <td>
 <ul>
   <li><b>Python variable</b>, such as image data represented by <code>numpy.ndarray</code></li>
@@ -418,7 +418,7 @@ After executing the above command, PaddleX will validate the dataset and summari
   &quot;analysis&quot;: {
     &quot;histogram&quot;: &quot;check_dataset/histogram.png&quot;
   },
-  &quot;dataset_path&quot;: &quot;./dataset/instance_seg_coco_examples&quot;,
+  &quot;dataset_path&quot;: &quot;instance_seg_coco_examples&quot;,
   &quot;show_type&quot;: &quot;image&quot;,
   &quot;dataset_type&quot;: &quot;COCOInstSegDataset&quot;
 }

+ 2 - 2
docs/module_usage/tutorials/cv_modules/instance_segmentation.md

@@ -250,7 +250,7 @@ for res in output:
 <tr>
 <td><code>input</code></td>
 <td>待预测数据,支持多种输入类型</td>
-<td><code>Python Var</code>/<code>str</code>/<code>dict</code>/<code>list</code></td>
+<td><code>Python Var</code>/<code>str</code>/<code>list</code></td>
 <td>
 <ul>
   <li><b>Python变量</b>,如<code>numpy.ndarray</code>表示的图像数据</li>
@@ -416,7 +416,7 @@ python main.py -c paddlex/configs/modules/instance_segmentation/Mask-RT-DETR-L.y
   &quot;analysis&quot;: {
     &quot;histogram&quot;: &quot;check_dataset/histogram.png&quot;
   },
-  &quot;dataset_path&quot;: &quot;./dataset/instance_seg_coco_examples&quot;,
+  &quot;dataset_path&quot;: &quot;instance_seg_coco_examples&quot;,
   &quot;show_type&quot;: &quot;image&quot;,
   &quot;dataset_type&quot;: &quot;COCOInstSegDataset&quot;
 }

+ 2 - 2
docs/module_usage/tutorials/cv_modules/mainbody_detection.en.md

@@ -126,7 +126,7 @@ Related methods, parameters, and explanations are as follows:
 <tr>
 <td><code>input</code></td>
 <td>Data to be predicted, supporting multiple input types</td>
-<td><code>Python Var</code>/<code>str</code>/<code>dict</code>/<code>list</code></td>
+<td><code>Python Var</code>/<code>str</code>/<code>list</code></td>
 <td>
 <ul>
   <li><b>Python variable</b>, such as image data represented by <code>numpy.ndarray</code></li>
@@ -293,7 +293,7 @@ After executing the above command, PaddleX will validate the dataset and collect
   &quot;analysis&quot;: {
     &quot;histogram&quot;: &quot;check_dataset/histogram.png&quot;
   },
-  &quot;dataset_path&quot;: &quot;./dataset/example_data/mainbody_det_examples&quot;,
+  &quot;dataset_path&quot;: &quot;mainbody_det_examples&quot;,
   &quot;show_type&quot;: &quot;image&quot;,
   &quot;dataset_type&quot;: &quot;COCODetDataset&quot;
 }

+ 2 - 2
docs/module_usage/tutorials/cv_modules/mainbody_detection.md

@@ -122,7 +122,7 @@ for res in output:
 <tr>
 <td><code>input</code></td>
 <td>待预测数据,支持多种输入类型</td>
-<td><code>Python Var</code>/<code>str</code>/<code>dict</code>/<code>list</code></td>
+<td><code>Python Var</code>/<code>str</code>/<code>list</code></td>
 <td>
 <ul>
   <li><b>Python变量</b>,如<code>numpy.ndarray</code>表示的图像数据</li>
@@ -289,7 +289,7 @@ python main.py -c paddlex/configs/modules/mainbody_detection/PP-ShiTuV2_det.yaml
   &quot;analysis&quot;: {
     &quot;histogram&quot;: &quot;check_dataset/histogram.png&quot;
   },
-  &quot;dataset_path&quot;: &quot;./dataset/example_data/mainbody_det_examples&quot;,
+  &quot;dataset_path&quot;: &quot;mainbody_det_examples&quot;,
   &quot;show_type&quot;: &quot;image&quot;,
   &quot;dataset_type&quot;: &quot;COCODetDataset&quot;
 }

+ 2 - 2
docs/module_usage/tutorials/cv_modules/semantic_segmentation.en.md

@@ -296,7 +296,7 @@ Related methods, parameters, and explanations are as follows:
 <tr>
 <td><code>input</code></td>
 <td>Data to be predicted, supports multiple input types</td>
-<td><code>Python Var</code>/<code>str</code>/<code>dict</code>/<code>list</code></td>
+<td><code>Python Var</code>/<code>str</code>/<code>list</code></td>
 <td>
 <ul>
   <li><b>Python Variable</b>, such as image data represented by <code>numpy.ndarray</code></li>
@@ -466,7 +466,7 @@ After executing the above command, PaddleX will verify the dataset and collect b
   &quot;analysis&quot;: {
     &quot;histogram&quot;: &quot;check_dataset/histogram.png&quot;
   },
-  &quot;dataset_path&quot;: &quot;./dataset/seg_optic_examples&quot;,
+  &quot;dataset_path&quot;: &quot;seg_optic_examples&quot;,
   &quot;show_type&quot;: &quot;image&quot;,
   &quot;dataset_type&quot;: &quot;SegDataset&quot;
 }

+ 2 - 2
docs/module_usage/tutorials/cv_modules/semantic_segmentation.md

@@ -293,7 +293,7 @@ for res in output:
 <tr>
 <td><code>input</code></td>
 <td>待预测数据,支持多种输入类型</td>
-<td><code>Python Var</code>/<code>str</code>/<code>dict</code>/<code>list</code></td>
+<td><code>Python Var</code>/<code>str</code>/<code>list</code></td>
 <td>
 <ul>
   <li><b>Python变量</b>,如<code>numpy.ndarray</code>表示的图像数据</li>
@@ -460,7 +460,7 @@ python main.py -c paddlex/configs/modules/semantic_segmentation/PP-LiteSeg-T.yam
   &quot;analysis&quot;: {
     &quot;histogram&quot;: &quot;check_dataset/histogram.png&quot;
   },
-  &quot;dataset_path&quot;: &quot;./dataset/seg_optic_examples&quot;,
+  &quot;dataset_path&quot;: &quot;seg_optic_examples&quot;,
   &quot;show_type&quot;: &quot;image&quot;,
   &quot;dataset_type&quot;: &quot;SegDataset&quot;
 }

+ 2 - 2
docs/module_usage/tutorials/cv_modules/small_object_detection.en.md

@@ -144,7 +144,7 @@ Related methods, parameters, and explanations are as follows:
 <tr>
 <td><code>input</code></td>
 <td>Data to be predicted, supporting multiple input types</td>
-<td><code>Python Var</code>/<code>str</code>/<code>dict</code>/<code>list</code></td>
+<td><code>Python Var</code>/<code>str</code>/<code>list</code></td>
 <td>
 <ul>
   <li><b>Python variable</b>, such as image data represented by <code>numpy.ndarray</code></li>
@@ -312,7 +312,7 @@ After executing the above command, PaddleX will validate the dataset and collect
   &quot;analysis&quot;: {
     &quot;histogram&quot;: &quot;check_dataset/histogram.png&quot;
   },
-  &quot;dataset_path&quot;: &quot;./dataset/example_data/small_det_examples&quot;,
+  &quot;dataset_path&quot;: &quot;small_det_examples&quot;,
   &quot;show_type&quot;: &quot;image&quot;,
   &quot;dataset_type&quot;: &quot;COCODetDataset&quot;
 }

+ 2 - 2
docs/module_usage/tutorials/cv_modules/small_object_detection.md

@@ -139,7 +139,7 @@ for res in output:
 <tr>
 <td><code>input</code></td>
 <td>待预测数据,支持多种输入类型</td>
-<td><code>Python Var</code>/<code>str</code>/<code>dict</code>/<code>list</code></td>
+<td><code>Python Var</code>/<code>str</code>/<code>list</code></td>
 <td>
 <ul>
   <li><b>Python变量</b>,如<code>numpy.ndarray</code>表示的图像数据</li>
@@ -306,7 +306,7 @@ python main.py -c paddlex/configs/modules/small_object_detection/PP-YOLOE_plus_S
   &quot;analysis&quot;: {
     &quot;histogram&quot;: &quot;check_dataset/histogram.png&quot;
   },
-  &quot;dataset_path&quot;: &quot;./dataset/example_data/small_det_examples&quot;,
+  &quot;dataset_path&quot;: &quot;small_det_examples&quot;,
   &quot;show_type&quot;: &quot;image&quot;,
   &quot;dataset_type&quot;: &quot;COCODetDataset&quot;
 }

+ 2 - 2
docs/module_usage/tutorials/cv_modules/vehicle_detection.en.md

@@ -130,7 +130,7 @@ Related methods, parameters, and explanations are as follows:
 <tr>
 <td><code>input</code></td>
 <td>Data to be predicted, supports multiple input types</td>
-<td><code>Python Var</code>/<code>str</code>/<code>dict</code>/<code>list</code></td>
+<td><code>Python Var</code>/<code>str</code>/<code>list</code></td>
 <td>
 <ul>
   <li><b>Python Variable</b>, such as image data represented by <code>numpy.ndarray</code></li>
@@ -297,7 +297,7 @@ After executing the above command, PaddleX will validate the dataset and collect
   &quot;analysis&quot;: {
     &quot;histogram&quot;: &quot;check_dataset/histogram.png&quot;
   },
-  &quot;dataset_path&quot;: &quot;./dataset/example_data/vehicle_coco_examples&quot;,
+  &quot;dataset_path&quot;: &quot;vehicle_coco_examples&quot;,
   &quot;show_type&quot;: &quot;image&quot;,
   &quot;dataset_type&quot;: &quot;COCODetDataset&quot;
 }

+ 2 - 2
docs/module_usage/tutorials/cv_modules/vehicle_detection.md

@@ -127,7 +127,7 @@ for res in output:
 <tr>
 <td><code>input</code></td>
 <td>待预测数据,支持多种输入类型</td>
-<td><code>Python Var</code>/<code>str</code>/<code>dict</code>/<code>list</code></td>
+<td><code>Python Var</code>/<code>str</code>/<code>list</code></td>
 <td>
 <ul>
   <li><b>Python变量</b>,如<code>numpy.ndarray</code>表示的图像数据</li>
@@ -294,7 +294,7 @@ python main.py -c paddlex/configs/modules/vehicle_detection/PP-YOLOE-S_vehicle.y
   &quot;analysis&quot;: {
     &quot;histogram&quot;: &quot;check_dataset/histogram.png&quot;
   },
-  &quot;dataset_path&quot;: &quot;./dataset/example_data/vehicle_coco_examples&quot;,
+  &quot;dataset_path&quot;: &quot;vehicle_coco_examples&quot;,
   &quot;show_type&quot;: &quot;image&quot;,
   &quot;dataset_type&quot;: &quot;COCODetDataset&quot;
 }