@@ -116,18 +116,20 @@ for res in output:
116116```
117117
118118运行结果参数含义如下:
119- - ` input_path ` :表示输入图片的路径。
120- - ` class_ids ` :表示预测结果的类别id,含有四个类别,即0度,90度,180度和270度。
121- - ` scores ` :表示预测结果的置信度。
122- - ` label_names ` :表示预测结果的类别名。
119+ <ul >
120+ <li ><code >input_path</code >:表示输入图片的路径。</li >
121+ <li ><code >class_ids</code >:表示预测结果的类别id,含有四个类别,即0度,90度,180度和270度。</li >
122+ <li ><code >scores</code >:表示预测结果的置信度。</li >
123+ <li ><code >label_names</code >:表示预测结果的类别名。</li >
124+ </ul >
123125
124126可视化图片如下:
125127
126128<img src =" https://raw.githubusercontent.com/cuicheng01/PaddleX_doc_images/refs/heads/main/images/modules/doc_img_ori_classification/img_rot180_demo_res.jpg " >
127129
128130相关方法、参数等说明如下:
129131
130- * ` DocImgOrientationClassification ` 实例化文档图像方向分类模型(此处以` PP-LCNet_x1_0_doc_ori ` 为例),具体说明如下:
132+ * < code > DocImgOrientationClassification</ code > 实例化文档图像方向分类模型(此处以< code > PP-LCNet_x1_0_doc_ori</ code > 为例),具体说明如下:
131133<table >
132134<thead >
133135<tr >
@@ -140,19 +142,22 @@ for res in output:
140142<tbody >
141143<tr >
142144<td ><code >model_name</code ></td >
143- <td >模型名称。如果设置为<code >None</code >,则使用<code >PP-LCNet_x1_0_doc_ori</code >。</td >
145+ <td ><b >含义:</b >模型名称。<br />
146+ <b >说明:</b >
147+ 如果设置为<code >None</code >,则使用<code >PP-LCNet_x1_0_doc_ori</code >。</td >
144148<td ><code >str|None</code ></td >
145149<td ><code >None</code ></td >
146150</tr >
147151<tr >
148152<td ><code >model_dir</code ></td >
149- <td >模型存储路径。</td >
153+ <td >< b >含义:</ b > 模型存储路径。</td >
150154<td ><code >str|None</code ></td >
151155<td ><code >None</code ></td >
152156</tr >
153157<tr >
154158<td ><code >device</code ></td >
155- <td >用于推理的设备。<br />
159+ <td ><b >含义:</b >用于推理的设备。<br />
160+ <b >说明:</b >
156161<b >例如:</b ><code >"cpu"</code >、<code >"gpu"</code >、<code >"npu"</code >、<code >"gpu:0"</code >、<code >"gpu:0,1"</code >。<br />
157162如指定多个设备,将进行并行推理。<br />
158163默认情况下,优先使用 GPU 0;若不可用则使用 CPU。
@@ -162,13 +167,15 @@ for res in output:
162167</tr >
163168<tr >
164169<td ><code >enable_hpi</code ></td >
165- <td >是否启用高性能推理。</td >
170+ <td >< b >含义:</ b > 是否启用高性能推理。</td >
166171<td ><code >bool</code ></td >
167172<td ><code >False</code ></td >
168173</tr >
169174<tr >
170175<td ><code >use_tensorrt</code ></td >
171- <td >是否启用 Paddle Inference 的 TensorRT 子图引擎。如果模型不支持通过 TensorRT 加速,即使设置了此标志,也不会使用加速。<br />
176+ <td ><b >含义:</b >是否启用 Paddle Inference 的 TensorRT 子图引擎。<br />
177+ <b >说明:</b >
178+ 如果模型不支持通过 TensorRT 加速,即使设置了此标志,也不会使用加速。<br />
172179对于 CUDA 11.8 版本的飞桨,兼容的 TensorRT 版本为 8.x(x>=6),建议安装 TensorRT 8.6.1.6。<br />
173180
174181</td >
@@ -177,36 +184,40 @@ for res in output:
177184</tr >
178185<tr >
179186<td ><code >precision</code ></td >
180- <td >当使用 Paddle Inference 的 TensorRT 子图引擎时设置的计算精度。<br /><b >可选项:</b ><code >"fp32"</code >、<code >"fp16"</code >。</td >
187+ <td ><b >含义:</b >当使用 Paddle Inference 的 TensorRT 子图引擎时设置的计算精度。<br />
188+ <b >说明:</b >
189+ <b >例如:</b ><code >"fp32"</code >、<code >"fp16"</code >。</td >
181190<td ><code >str</code ></td >
182191<td ><code >"fp32"</code ></td >
183192</tr >
184193<tr >
185194<td ><code >enable_mkldnn</code ></td >
186195<td >
187- 是否启用 MKL-DNN 加速推理。如果 MKL-DNN 不可用或模型不支持通过 MKL-DNN 加速,即使设置了此标志,也不会使用加速。<br />
196+ <b >含义:</b >是否启用 MKL-DNN 加速推理。<br />
197+ <b >说明:</b >
198+ 如果 MKL-DNN 不可用或模型不支持通过 MKL-DNN 加速,即使设置了此标志,也不会使用加速。<br />
188199</td >
189200<td ><code >bool</code ></td >
190201<td ><code >True</code ></td >
191202</tr >
192203<tr >
193204<td ><code >mkldnn_cache_capacity</code ></td >
194205<td >
195- MKL-DNN 缓存容量。
206+ < b >含义:</ b > MKL-DNN 缓存容量。
196207</td >
197208<td ><code >int</code ></td >
198209<td ><code >10</code ></td >
199210</tr >
200211<tr >
201212<td ><code >cpu_threads</code ></td >
202- <td >在 CPU 上推理时使用的线程数量。</td >
213+ <td >< b >含义:</ b > 在 CPU 上推理时使用的线程数量。</td >
203214<td ><code >int|None</code ></td >
204215<td ><code >10</code ></td >
205216</tr >
206217</tbody >
207218</table >
208219
209- * 调用文档图像方向分类模型的 ` predict() ` 方法进行推理预测,该方法会返回一个结果列表。另外,本模块还提供了 ` predict_iter() ` 方法。两者在参数接受和结果返回方面是完全一致的,区别在于 ` predict_iter() ` 返回的是一个 ` generator ` ,能够逐步处理和获取预测结果,适合处理大型数据集或希望节省内存的场景。可以根据实际需求选择使用这两种方法中的任意一种。` predict() ` 方法参数有 ` input ` 和 ` batch_size ` ,具体说明如下:
220+ * 调用文档图像方向分类模型的 < code > predict()</ code > 方法进行推理预测,该方法会返回一个结果列表。另外,本模块还提供了 < code > predict_iter()</ code > 方法。两者在参数接受和结果返回方面是完全一致的,区别在于 < code > predict_iter()</ code > 返回的是一个 < code > generator</ code > ,能够逐步处理和获取预测结果,适合处理大型数据集或希望节省内存的场景。可以根据实际需求选择使用这两种方法中的任意一种。< code > predict()</ code > 方法参数有 < code > input</ code > 和 < code > batch_size</ code > ,具体说明如下:
210221
211222<table >
212223<thead >
@@ -219,10 +230,13 @@ MKL-DNN 缓存容量。
219230</thead >
220231<tr >
221232<td ><code >input</code ></td >
222- <td >待预测数据,支持多种输入类型,必填。
233+ <td ><b >含义:</b >待预测数据,支持多种输入类型,必填。<br />
234+ <b >说明:</b >
223235<ul >
224236<li ><b >Python Var</b >:如 <code >numpy.ndarray</code > 表示的图像数据</li >
225- <li ><b >str</b >:如图像文件或者PDF文件的本地路径:<code >/root/data/img.jpg</code >;<b >如URL链接</b >,如图像文件或PDF文件的网络URL:<a href =" https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/img_rot180_demo.jpg " >示例</a >;<b >如本地目录</b >,该目录下需包含待预测图像,如本地路径:<code >/root/data/</code >(当前不支持目录中包含PDF文件的预测,PDF文件需要指定到具体文件路径)</li >
237+ <li ><b >str</b >:如图像文件或者PDF文件的本地路径:<code >/root/data/img.jpg</code >;
238+ <b >如URL链接</b >,如图像文件或PDF文件的网络URL:<a href =" https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/img_rot180_demo.jpg " >示例</a >;
239+ <b >如本地目录</b >,该目录下需包含待预测图像,如本地路径:<code >/root/data/</code >(当前不支持目录中包含PDF文件的预测,PDF文件需要指定到具体文件路径)</li >
226240<li ><b >list</b >:列表元素需为上述类型数据,如<code >[numpy.ndarray, numpy.ndarray]</code >,<code >["/root/data/img1.jpg", "/root/data/img2.jpg"]</code >,<code >["/root/data1", "/root/data2"]</code ></li >
227241</ul >
228242</td >
@@ -231,13 +245,15 @@ MKL-DNN 缓存容量。
231245</tr >
232246<tr >
233247<td ><code >batch_size</code ></td >
234- <td >批大小,可设置为任意正整数。</td >
248+ <td ><b >含义:</b >批大小。<br />
249+ <b >说明:</b >
250+ 可设置为任意正整数。</td >
235251<td ><code >int</code ></td >
236252<td >1</td >
237253</tr >
238254</table >
239255
240- * 对预测结果进行处理,每个样本的预测结果均为对应的Result对象,且支持打印、保存为图片、保存为` json ` 文件的操作:
256+ * 对预测结果进行处理,每个样本的预测结果均为对应的Result对象,且支持打印、保存为图片、保存为< code > json</ code > 文件的操作:
241257
242258<table >
243259<thead >
0 commit comments