Эх сурвалжийг харах

fix docs (#3234)

* fix docs

* fix docs
Sunflower7788 9 сар өмнө
parent
commit
73de0585f8

+ 10 - 2
docs/pipeline_usage/tutorials/cv_pipelines/image_anomaly_detection.md

@@ -5,7 +5,9 @@ comments: true
 # 图像异常检测产线使用教程
 
 ## 1. 图像异常检测产线介绍
-图像异常检测是一种通过分析图像中的内容,来识别与众不同或不符合正常模式的图像处理技术。它广泛应用于工业质量检测、医疗影像分析和安全监控等领域。通过使用机器学习和深度学习算法,图像异常检测能够自动识别出图像中潜在的缺陷、异常或异常行为,从而帮助我们及时发现问题并采取相应措施。图像异常检测系统被设计用于自动检测和标记图像中的异常情况,以提高工作效率和准确性。本产线同时提供了灵活的服务化部署方式,支持在多种硬件上使用多种编程语言调用。不仅如此,本产线也提供了二次开发的能力,您可以基于本产线在您自己的数据集上训练调优,训练后的模型也可以无缝集成。
+图像异常检测是一种通过分析图像中的内容,来识别与众不同或不符合正常模式的图像处理技术。图像异常检测能够自动识别出图像中潜在的缺陷、异常或异常行为,从而帮助我们及时发现问题并采取相应措施。
+
+本产线集成了高精度的异常检测模型 STFPM,提取图像中的异常或缺陷区域,使用场景覆盖工业制造、食品外观质检以及医疗影像分析等各个领域。本产线同时提供了灵活的服务化部署方式,支持在多种硬件上使用多种编程语言调用。不仅如此,本产线也提供了二次开发的能力,您可以基于本产线在您自己的数据集上训练调优,训练后的模型也可以无缝集成。
 
 <img src="https://raw.githubusercontent.com/cuicheng01/PaddleX_doc_images/main/images/pipelines/image_anomaly_detection/01.png">
 
@@ -92,6 +94,12 @@ for res in output:
 <td>无</td>
 </tr>
 <tr>
+<td><code>config</code></td>
+<td>产线具体的配置信息(如果和<code>pipeline</code>同时设置,优先级高于<code>pipeline</code>,且要求产线名和<code>pipeline</code>一致)。</td>
+<td><code>dict[str, Any]</code></td>
+<td><code>None</code></td>
+</tr>
+<tr>
 <td><code>device</code></td>
 <td>产线推理设备。支持指定GPU具体卡号,如“gpu:0”,其他硬件具体卡号,如“npu:0”,CPU如“cpu”。</td>
 <td><code>str</code></td>
@@ -789,7 +797,7 @@ SubModules:
   AnomalyDetection:
     module_name: anomaly_detection
     model_name: STFPM
-    model_dir: null  # 替换为微调后的文档图像方向分类模型权重路径
+    model_dir: null  # 替换为微调后的图像异常检测模型权重路径
     batch_size: 1
 ```
 

+ 31 - 9
docs/pipeline_usage/tutorials/ocr_pipelines/seal_recognition.md

@@ -805,7 +805,7 @@ for res in output:
 
 在上述 Python 脚本中,执行了如下几个步骤:
 
-(1)通过 `create_pipeline()` 实例化 OCR 产线对象,具体参数说明如下:
+(1)通过 `create_pipeline()` 实例化 印章文本识别 产线对象,具体参数说明如下:
 
 <table>
 <thead>
@@ -824,6 +824,12 @@ for res in output:
 <td><code>None</code></td>
 </tr>
 <tr>
+<td><code>config</code></td>
+<td>产线具体的配置信息(如果和<code>pipeline</code>同时设置,优先级高于<code>pipeline</code>,且要求产线名和<code>pipeline</code>一致)。</td>
+<td><code>dict[str, Any]</code></td>
+<td><code>None</code></td>
+</tr>
+<tr>
 <td><code>device</code></td>
 <td>产线推理设备。支持指定GPU具体卡号,如“gpu:0”,其他硬件具体卡号,如“npu:0”,CPU如“cpu”。</td>
 <td><code>str</code></td>
@@ -1491,20 +1497,36 @@ for i, res in enumerate(result[&quot;sealRecResults&quot;]):
 
 ```python
 ......
+SubModules:
+  LayoutDetection:
+    module_name: layout_detection
+    model_name: PP-DocLayout-L
+    model_dir: null # 修改此处为微调后的版面检测模型权重的本地路径
+    ...
+
+SubPipelines:
+  DocPreprocessor:
+    ...
+    SubModules:
+      DocOrientationClassify:
+        module_name: doc_text_orientation
+        model_name: PP-LCNet_x1_0_doc_ori
+        model_dir: null # 修改此处为微调后的文档图像方向分类模型权重的本地路径
+    ...
     SubModules:
       TextDetection:
         module_name: seal_text_detection
         model_name: PP-OCRv4_server_seal_det
-        model_dir: null # 修改此处为微调后模型权重的本地路径
-        limit_side_len: 736
-        limit_type: min
-        thresh: 0.2
-        box_thresh: 0.6
-        unclip_ratio: 0.5
-......
+        model_dir: null # 修改此处为微调后的文本检测模型权重的本地路径
+        ...
+      TextRecognition:
+        module_name: text_recognition
+        model_name: PP-OCRv4_server_rec
+        model_dir: null # 修改此处为微调后的文本识别模型权重的本地路径
+        ...
 ```
 
-随后, 参考[2.2 本地体验](#22-本地体验)中的命令行方式或Python脚本方式,加载修改后的产线配置文件即可。
+随后, 参考[2. 快速开始](#2-快速开始)中的命令行方式或Python脚本方式,加载修改后的产线配置文件即可。
 
 ##  5. 多硬件支持
 

+ 6 - 0
docs/pipeline_usage/tutorials/time_series_pipelines/time_series_anomaly_detection.md

@@ -140,6 +140,12 @@ for res in output:
 <td><code>None</code></td>
 </tr>
 <tr>
+<td><code>config</code></td>
+<td>产线具体的配置信息(如果和<code>pipeline</code>同时设置,优先级高于<code>pipeline</code>,且要求产线名和<code>pipeline</code>一致)。</td>
+<td><code>dict[str, Any]</code></td>
+<td><code>None</code></td>
+</tr>
+<tr>
 <td><code>device</code></td>
 <td>产线推理设备。支持指定GPU具体卡号,如“gpu:0”,其他硬件具体卡号,如“npu:0”,CPU如“cpu”。</td>
 <td><code>str</code></td>

+ 7 - 1
docs/pipeline_usage/tutorials/time_series_pipelines/time_series_classification.md

@@ -72,7 +72,7 @@ sample
 ```python
 from paddlex import create_pipeline
 
-pipeline = create_pipeline(pipeline="ts_cls")
+pipeline = create_pipeline(pipeline="ts_classification")
 output = pipeline.predict("ts_cls.csv")
 for res in output:
     res.print() ## 打印预测的结构化输出
@@ -101,6 +101,12 @@ for res in output:
 <td><code>None</code></td>
 </tr>
 <tr>
+<td><code>config</code></td>
+<td>产线具体的配置信息(如果和<code>pipeline</code>同时设置,优先级高于<code>pipeline</code>,且要求产线名和<code>pipeline</code>一致)。</td>
+<td><code>dict[str, Any]</code></td>
+<td><code>None</code></td>
+</tr>
+<tr>
 <td><code>device</code></td>
 <td>产线推理设备。支持指定GPU具体卡号,如“gpu:0”,其他硬件具体卡号,如“npu:0”,CPU如“cpu”。</td>
 <td><code>str</code></td>