mirror of
https://github.com/PaddlePaddle/PaddleOCR.git
synced 2025-06-26 21:24:27 +00:00
add visualize parameter (#15849)
This commit is contained in:
Poki Bai
GitHub
parent
046a41dbad
commit
aa26c75878
@ -1546,6 +1546,26 @@ Below are the API reference for basic service deployment and examples of multi-l
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>
|
||||
Whether to return the final visualization image and intermediate images during the processing.<br/>
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>If <code>true</code> is provided: return images.</li>
|
||||
<li>If <code>false</code> is provided: do not return any images.</li>
|
||||
<li>If this parameter is omitted from the request body, or if <code>null</code> is explicitly passed, the behavior will follow the value of <code>Serving.visualize</code> in the pipeline configuration.</li>
|
||||
</ul>
|
||||
<br/>
|
||||
For example, adding the following setting to the pipeline config file:<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
will disable image return by default. This behavior can be overridden by explicitly setting the <code>visualize</code> parameter in the request.<br/>
|
||||
If neither the request body nor the configuration file is set (If <code>visualize</code> is set to <code>null</code> in the request and not defined in the configuration file), the image is returned by default.
|
||||
</td>
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>Refer to the <code>use_doc_orientation_classify</code> parameter in the pipeline object's <code>predict</code> method.</td>
|
||||
|
||||
@ -1549,6 +1549,23 @@ MKL-DNN 缓存容量。
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>是否返回可视化结果图以及处理过程中的中间图像等。
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>传入 <code>true</code>：返回图像。</li>
|
||||
<li>传入 <code>false</code>：不返回图像。</li>
|
||||
<li>若请求体中未提供该参数或传入 <code>null</code>：遵循产线配置文件<code>Serving.visualize</code> 的设置。</li>
|
||||
</ul>
|
||||
<br/>例如，在产线配置文件中添加如下字段：<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
将默认不返回图像，通过请求体中的<code>visualize</code>参数可以覆盖默认行为。如果请求体和配置文件中均未设置（或请求体传入<code>null</code>、配置文件中未设置），则默认返回图像。
|
||||
</td>
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>请参阅产线对象中 <code>predict</code> 方法的 <code>use_doc_orientation_classify</code> 参数相关说明。</td>
|
||||
|
||||
@ -2086,6 +2086,26 @@ To remove the page limit, please add the following configuration to the pipeline
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>
|
||||
Whether to return the final visualization image and intermediate images during the processing.<br/>
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>If <code>true</code> is provided: return images.</li>
|
||||
<li>If <code>false</code> is provided: do not return any images.</li>
|
||||
<li>If this parameter is omitted from the request body, or if <code>null</code> is explicitly passed, the behavior will follow the value of <code>Serving.visualize</code> in the pipeline configuration.</li>
|
||||
</ul>
|
||||
<br/>
|
||||
For example, adding the following setting to the pipeline config file:<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
will disable image return by default. This behavior can be overridden by explicitly setting the <code>visualize</code> parameter in the request.<br/>
|
||||
If neither the request body nor the configuration file is set (If <code>visualize</code> is set to <code>null</code> in the request and not defined in the configuration file), the image is returned by default.
|
||||
</td>
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>Please refer to the description of the <code>use_doc_orientation_classify</code> parameter of the pipeline object's <code>visual_predict</code> method.</td>
|
||||
|
||||
@ -2331,6 +2331,23 @@ for res in visual_predict_res:
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>是否返回可视化结果图以及处理过程中的中间图像等。
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>传入 <code>true</code>：返回图像。</li>
|
||||
<li>传入 <code>false</code>：不返回图像。</li>
|
||||
<li>若请求体中未提供该参数或传入 <code>null</code>：遵循产线配置文件<code>Serving.visualize</code> 的设置。</li>
|
||||
</ul>
|
||||
<br/>例如，在产线配置文件中添加如下字段：<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
将默认不返回图像，通过请求体中的<code>visualize</code>参数可以覆盖默认行为。如果请求体和配置文件中均未设置（或请求体传入<code>null</code>、配置文件中未设置），则默认返回图像。
|
||||
</td>
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>请参阅产线对象中 <code>visual_predict</code> 方法的 <code>use_doc_orientation_classify</code> 参数相关说明。</td>
|
||||
|
||||
@ -2573,6 +2573,26 @@ Below is the API reference and multi-language service invocation examples for ba
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>
|
||||
Whether to return the final visualization image and intermediate images during the processing.<br/>
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>If <code>true</code> is provided: return images.</li>
|
||||
<li>If <code>false</code> is provided: do not return any images.</li>
|
||||
<li>If this parameter is omitted from the request body, or if <code>null</code> is explicitly passed, the behavior will follow the value of <code>Serving.visualize</code> in the pipeline configuration.</li>
|
||||
</ul>
|
||||
<br/>
|
||||
For example, adding the following setting to the pipeline config file:<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
will disable image return by default. This behavior can be overridden by explicitly setting the <code>visualize</code> parameter in the request.<br/>
|
||||
If neither the request body nor the configuration file is set (If <code>visualize</code> is set to <code>null</code> in the request and not defined in the configuration file), the image is returned by default.
|
||||
</td>
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>Refer to the <code>use_doc_orientation_classify</code> parameter in the pipeline’s <code>predict</code> method.</td>
|
||||
|
||||
@ -2688,6 +2688,23 @@ MKL-DNN 缓存容量。
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>是否返回可视化结果图以及处理过程中的中间图像等。
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>传入 <code>true</code>：返回图像。</li>
|
||||
<li>传入 <code>false</code>：不返回图像。</li>
|
||||
<li>若请求体中未提供该参数或传入 <code>null</code>：遵循产线配置文件<code>Serving.visualize</code> 的设置。</li>
|
||||
</ul>
|
||||
<br/>例如，在产线配置文件中添加如下字段：<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
将默认不返回图像，通过请求体中的<code>visualize</code>参数可以覆盖默认行为。如果请求体和配置文件中均未设置（或请求体传入<code>null</code>、配置文件中未设置），则默认返回图像。
|
||||
</td>
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>请参阅产线对象中 <code>predict</code> 方法的 <code>use_doc_orientation_classify</code> 参数相关说明。</td>
|
||||
|
||||
@ -672,6 +672,26 @@ Below are the API references for basic service-oriented deployment and examples
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>
|
||||
Whether to return the final visualization image and intermediate images during the processing.<br/>
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>If <code>true</code> is provided: return images.</li>
|
||||
<li>If <code>false</code> is provided: do not return any images.</li>
|
||||
<li>If this parameter is omitted from the request body, or if <code>null</code> is explicitly passed, the behavior will follow the value of <code>Serving.visualize</code> in the pipeline configuration.</li>
|
||||
</ul>
|
||||
<br/>
|
||||
For example, adding the following setting to the pipeline config file:<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
will disable image return by default. This behavior can be overridden by explicitly setting the <code>visualize</code> parameter in the request.<br/>
|
||||
If neither the request body nor the configuration file is set (If <code>visualize</code> is set to <code>null</code> in the request and not defined in the configuration file), the image is returned by default.
|
||||
</td>
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>Please refer to the description of the <code>use_doc_orientation_classify</code> parameter in the <code>predict</code> method of the pipeline object.</td>
|
||||
|
||||
@ -679,6 +679,23 @@ MKL-DNN 缓存容量。
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>是否返回可视化结果图以及处理过程中的中间图像等。
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>传入 <code>true</code>：返回图像。</li>
|
||||
<li>传入 <code>false</code>：不返回图像。</li>
|
||||
<li>若请求体中未提供该参数或传入 <code>null</code>：遵循产线配置文件<code>Serving.visualize</code> 的设置。</li>
|
||||
</ul>
|
||||
<br/>例如，在产线配置文件中添加如下字段：<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
将默认不返回图像，通过请求体中的<code>visualize</code>参数可以覆盖默认行为。如果请求体和配置文件中均未设置（或请求体传入<code>null</code>、配置文件中未设置），则默认返回图像。
|
||||
</td>
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>请参阅产线对象中 <code>predict</code> 方法的 <code>use_doc_orientation_classify</code> 参数相关说明。</td>
|
||||
|
||||
@ -1200,6 +1200,26 @@ To remove the page limit, please add the following configuration to the pipeline
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>
|
||||
Whether to return the final visualization image and intermediate images during the processing.<br/>
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>If <code>true</code> is provided: return images.</li>
|
||||
<li>If <code>false</code> is provided: do not return any images.</li>
|
||||
<li>If this parameter is omitted from the request body, or if <code>null</code> is explicitly passed, the behavior will follow the value of <code>Serving.visualize</code> in the pipeline configuration.</li>
|
||||
</ul>
|
||||
<br/>
|
||||
For example, adding the following setting to the pipeline config file:<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
will disable image return by default. This behavior can be overridden by explicitly setting the <code>visualize</code> parameter in the request.<br/>
|
||||
If neither the request body nor the configuration file is set (If <code>visualize</code> is set to <code>null</code> in the request and not defined in the configuration file), the image is returned by default.
|
||||
</td>
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>Please refer to the description of the <code>use_doc_orientation_classify</code> parameter of the pipeline object's <code>predict</code> method.</td>
|
||||
|
||||
@ -1178,6 +1178,23 @@ MKL-DNN 缓存容量。
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>是否返回可视化结果图以及处理过程中的中间图像等。
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>传入 <code>true</code>：返回图像。</li>
|
||||
<li>传入 <code>false</code>：不返回图像。</li>
|
||||
<li>若请求体中未提供该参数或传入 <code>null</code>：遵循产线配置文件<code>Serving.visualize</code> 的设置。</li>
|
||||
</ul>
|
||||
<br/>例如，在产线配置文件中添加如下字段：<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
将默认不返回图像，通过请求体中的<code>visualize</code>参数可以覆盖默认行为。如果请求体和配置文件中均未设置（或请求体传入<code>null</code>、配置文件中未设置），则默认返回图像。
|
||||
</td>
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>请参阅产线对象中 <code>predict</code> 方法的 <code>use_doc_orientation_classify</code> 参数相关说明。</td>
|
||||
|
||||
@ -1614,6 +1614,26 @@ To remove the page limit, please add the following configuration to the pipeline
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>
|
||||
Whether to return the final visualization image and intermediate images during the processing.<br/>
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>If <code>true</code> is provided: return images.</li>
|
||||
<li>If <code>false</code> is provided: do not return any images.</li>
|
||||
<li>If this parameter is omitted from the request body, or if <code>null</code> is explicitly passed, the behavior will follow the value of <code>Serving.visualize</code> in the pipeline configuration.</li>
|
||||
</ul>
|
||||
<br/>
|
||||
For example, adding the following setting to the pipeline config file:<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
will disable image return by default. This behavior can be overridden by explicitly setting the <code>visualize</code> parameter in the request.<br/>
|
||||
If neither the request body nor the configuration file is set (If <code>visualize</code> is set to <code>null</code> in the request and not defined in the configuration file), the image is returned by default.
|
||||
</td>
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>Please refer to the description of the <code>use_doc_orientation_classify</code> parameter of the pipeline object's <code>predict</code> method.</td>
|
||||
|
||||
@ -1608,6 +1608,23 @@ MKL-DNN 缓存容量。
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>是否返回可视化结果图以及处理过程中的中间图像等。
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>传入 <code>true</code>：返回图像。</li>
|
||||
<li>传入 <code>false</code>：不返回图像。</li>
|
||||
<li>若请求体中未提供该参数或传入 <code>null</code>：遵循产线配置文件<code>Serving.visualize</code> 的设置。</li>
|
||||
</ul>
|
||||
<br/>例如，在产线配置文件中添加如下字段：<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
将默认不返回图像，通过请求体中的<code>visualize</code>参数可以覆盖默认行为。如果请求体和配置文件中均未设置（或请求体传入<code>null</code>、配置文件中未设置），则默认返回图像。
|
||||
</td>
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>请参阅产线对象中 <code>predict</code> 方法的 <code>use_doc_orientation_classify</code> 参数相关说明。</td>
|
||||
|
||||
@ -1858,6 +1858,26 @@ Below is the API reference for basic service-oriented deployment and examples of
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>
|
||||
Whether to return the final visualization image and intermediate images during the processing.<br/>
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>If <code>true</code> is provided: return images.</li>
|
||||
<li>If <code>false</code> is provided: do not return any images.</li>
|
||||
<li>If this parameter is omitted from the request body, or if <code>null</code> is explicitly passed, the behavior will follow the value of <code>Serving.visualize</code> in the pipeline configuration.</li>
|
||||
</ul>
|
||||
<br/>
|
||||
For example, adding the following setting to the pipeline config file:<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
will disable image return by default. This behavior can be overridden by explicitly setting the <code>visualize</code> parameter in the request.<br/>
|
||||
If neither the request body nor the configuration file is set (If <code>visualize</code> is set to <code>null</code> in the request and not defined in the configuration file), the image is returned by default.
|
||||
</td>
|
||||
<td>No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>Please refer to the <code>use_doc_orientation_classify</code> parameter description in the <code>predict</code> method of the model object.</td>
|
||||
|
||||
@ -1861,6 +1861,23 @@ MKL-DNN 缓存容量。
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>visualize</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>是否返回可视化结果图以及处理过程中的中间图像等。
|
||||
<ul style="margin: 0 0 0 1em; padding-left: 0em;">
|
||||
<li>传入 <code>true</code>：返回图像。</li>
|
||||
<li>传入 <code>false</code>：不返回图像。</li>
|
||||
<li>若请求体中未提供该参数或传入 <code>null</code>：遵循产线配置文件<code>Serving.visualize</code> 的设置。</li>
|
||||
</ul>
|
||||
<br/>例如，在产线配置文件中添加如下字段：<br/>
|
||||
<pre><code>Serving:
|
||||
visualize: False
|
||||
</code></pre>
|
||||
将默认不返回图像，通过请求体中的<code>visualize</code>参数可以覆盖默认行为。如果请求体和配置文件中均未设置（或请求体传入<code>null</code>、配置文件中未设置），则默认返回图像。
|
||||
</td>
|
||||
<td>否</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useDocOrientationClassify</code></td>
|
||||
<td><code>boolean</code> | <code>null</code></td>
|
||||
<td>请参阅产线对象中 <code>predict</code> 方法的 <code>use_doc_orientation_classify</code> 参数相关说明。</td>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user