Skip to content

Commit 6dce3e0

Browse files
authored
fixed ocr docs (#15482)
* refine ocr pipeline docs * refine ocr module docs * refine ocr pipeline docs * refine ocr pipeline docs * fixed ocr docs
1 parent 09132f3 commit 6dce3e0

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

docs/version3.x/pipeline_usage/OCR.en.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -648,15 +648,15 @@ paddleocr ocr -i ./general_ocr_002.png --ocr_version PP-OCRv4
648648
<tr>
649649
<td><code>text_det_limit_side_len</code></td>
650650
<td>Maximum side length limit for text detection.
651-
Any integer greater than <code>0</code>. If not set, the pipeline's initialized value for this parameter (initialized to <code>960</code>) will be used.
651+
Any integer greater than <code>0</code>. If not set, the pipeline's initialized value for this parameter (initialized to <code>736</code>) will be used.
652652
</td>
653653
<td><code>int</code></td>
654654
<td></td>
655655
</tr>
656656
<tr>
657657
<td><code>text_det_limit_type</code></td>
658658
<td>Type of side length limit for text detection.
659-
Supports <code>min</code> and <code>max</code>. <code>min</code> means ensuring the shortest side of the image is not smaller than <code>det_limit_side_len</code>, and <code>max</code> means ensuring the longest side of the image is not larger than <code>limit_side_len</code>. If not set, the pipeline's initialized value for this parameter (initialized to <code>max</code>) will be used.
659+
Supports <code>min</code> and <code>max</code>. <code>min</code> means ensuring the shortest side of the image is not smaller than <code>det_limit_side_len</code>, and <code>max</code> means ensuring the longest side of the image is not larger than <code>limit_side_len</code>. If not set, the pipeline's initialized value for this parameter (initialized to <code>min</code>) will be used.
660660
</td>
661661
<td><code>str</code></td>
662662
<td></td>
@@ -1033,7 +1033,7 @@ In the above Python script, the following steps are performed:
10331033
<td>Maximum side length limit for text detection.
10341034
<ul>
10351035
<li><b>int</b>: Any integer greater than <code>0</code>;</li>
1036-
<li><b>None</b>: If set to <code>None</code>, the pipeline's initialized value for this parameter (initialized to <code>960</code>) will be used.</li>
1036+
<li><b>None</b>: If set to <code>None</code>, the pipeline's initialized value for this parameter (initialized to <code>736</code>) will be used.</li>
10371037
</ul>
10381038
</td>
10391039
<td><code>int</code></td>
@@ -1044,7 +1044,7 @@ In the above Python script, the following steps are performed:
10441044
<td>Type of side length limit for text detection.
10451045
<ul>
10461046
<li><b>str</b>: Supports <code>min</code> and <code>max</code>, where <code>min</code> means ensuring the shortest side of the image is not smaller than <code>det_limit_side_len</code>, and <code>max</code> means ensuring the longest side of the image is not larger than <code>limit_side_len</code>;</li>
1047-
<li><b>None</b>: If set to <code>None</code>, the pipeline's initialized value for this parameter (initialized to <code>max</code>) will be used.</li>
1047+
<li><b>None</b>: If set to <code>None</code>, the pipeline's initialized value for this parameter (initialized to <code>min</code>) will be used.</li>
10481048
</ul>
10491049
</td>
10501050
<td><code>str</code></td>
@@ -1763,8 +1763,8 @@ After obtaining the default pipeline configuration file, replace the paths of th
17631763
SubModules:
17641764
TextDetection:
17651765
box_thresh: 0.6
1766-
limit_side_len: 960
1767-
limit_type: max
1766+
limit_side_len: 736
1767+
limit_type: min
17681768
max_side_limit: 4000
17691769
model_dir: null # Replace with the path to your fine-tuned text detection model weights
17701770
model_name: PP-OCRv5_server_det # If the name of the fine-tuned model is different from the default model name, please modify it here as well

docs/version3.x/pipeline_usage/OCR.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -648,14 +648,14 @@ paddleocr ocr -i ./general_ocr_002.png --ocr_version PP-OCRv4
648648
<tr>
649649
<td><code>text_det_limit_side_len</code></td>
650650
<td>文本检测的最大边长度限制。
651-
大于 <code>0</code> 的任意整数。如果不设置,将默认使用产线初始化的该参数值,初始化为 <code>960</code>。
651+
大于 <code>0</code> 的任意整数。如果不设置,将默认使用产线初始化的该参数值,初始化为 <code>736</code>。
652652
</td>
653653
<td><code>int</code></td>
654654
<td></td>
655655
</tr>
656656
<tr>
657657
<td><code>text_det_limit_type</code></td>
658-
<td>文本检测的边长度限制类型。支持 <code>min</code> 和 <code>max</code>,<code>min</code> 表示保证图像最短边不小于 <code>det_limit_side_len</code>,<code>max</code> 表示保证图像最长边不大于 <code>limit_side_len</code>。如果不设置,将默认使用产线初始化的该参数值,初始化为 <code>max</code>。
658+
<td>文本检测的边长度限制类型。支持 <code>min</code> 和 <code>max</code>,<code>min</code> 表示保证图像最短边不小于 <code>det_limit_side_len</code>,<code>max</code> 表示保证图像最长边不大于 <code>limit_side_len</code>。如果不设置,将默认使用产线初始化的该参数值,初始化为 <code>min</code>。
659659
</td>
660660
<td><code>str</code></td>
661661
<td></td>
@@ -1031,7 +1031,7 @@ for res in result:
10311031
<td>文本检测的最大边长度限制。
10321032
<ul>
10331033
<li><b>int</b>:大于 <code>0</code> 的任意整数;</li>
1034-
<li><b>None</b>:如果设置为<code>None</code>, 将默认使用产线初始化的该参数值,初始化为 <code>960</code>。</li>
1034+
<li><b>None</b>:如果设置为<code>None</code>, 将默认使用产线初始化的该参数值,初始化为 <code>736</code>。</li>
10351035
</ur>
10361036
</td>
10371037
<td><code>int</code></td>
@@ -1042,7 +1042,7 @@ for res in result:
10421042
<td>文本检测的边长度限制类型。
10431043
<ul>
10441044
<li><b>str</b>:支持 <code>min</code> 和 <code>max</code>,<code>min</code> 表示保证图像最短边不小于 <code>det_limit_side_len</code>,<code>max</code> 表示保证图像最长边不大于 <code>limit_side_len</code>;</li>
1045-
<li><b>None</b>:如果设置为<code>None</code>, 将默认使用产线初始化的该参数值,初始化为 <code>max</code>。</li>
1045+
<li><b>None</b>:如果设置为<code>None</code>, 将默认使用产线初始化的该参数值,初始化为 <code>min</code>。</li>
10461046
</ur>
10471047
</td>
10481048
<td><code>str</code></td>
@@ -1765,8 +1765,8 @@ pipeline.export_paddlex_config_to_yaml("PaddleOCR.yaml")
17651765
SubModules:
17661766
TextDetection:
17671767
box_thresh: 0.6
1768-
limit_side_len: 960
1769-
limit_type: max
1768+
limit_side_len: 736
1769+
limit_type: min
17701770
max_side_limit: 4000
17711771
model_dir: null # 替换为微调后的文本测模型权重路径
17721772
model_name: PP-OCRv5_server_det # 如果微调的模型名称与默认模型名称不同,请一并修改此处

0 commit comments

Comments
 (0)