mirror of
https://github.com/PaddlePaddle/PaddleOCR.git
synced 2025-06-03 21:53:39 +08:00
2357c63a9a
* add ocr doc * add docs * fix * add pipeline docs * add module docs * update the descriptions of parameters * update * update the description of predict_iter * update * delete 2.2python脚本 * add char_recognition and region_detection * modify in predict * remove redundant 2.2 Python scripts * modify use_wired_table_cells_trans_to_html * add use_chart_recognition and use_region_detection * add information * add use_orc_model * add legacy docs * update --------- Co-authored-by: guoshengjian <guoshengjian@baidu.com>
294 lines
12 KiB
Markdown
294 lines
12 KiB
Markdown
---
|
||
comments: true
|
||
---
|
||
|
||
# 表格结构识别模块使用教程
|
||
|
||
## 一、概述
|
||
|
||
表格结构识别是表格识别系统中的重要组成部分，能够将不可编辑表格图片转换为可编辑的表格形式（例如html）。表格结构识别的目标是对表格的行、列和单元格位置进行识别，该模块的性能直接影响到整个表格识别系统的准确性和效率。表格结构识别模块通常会输出表格区域的html代码或Latex代码，这些代码将作为输入传递给表格内容识别模块进行后续处理。
|
||
|
||
## 二、支持模型列表
|
||
|
||
<table>
|
||
<tr>
|
||
<th>模型</th><th>模型下载链接</th>
|
||
<th>精度（%）</th>
|
||
<th>GPU推理耗时（ms）<br/>[常规模式 / 高性能模式]</th>
|
||
<th>CPU推理耗时（ms）<br/>[常规模式 / 高性能模式]</th>
|
||
<th>模型存储大小 (M)</th>
|
||
<th>介绍</th>
|
||
</tr>
|
||
<tr>
|
||
<td>SLANet</td><td><a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/official_inference_model/paddle3.0.0/SLANet_infer.tar">推理模型</a>/<a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/official_pretrained_model/SLANet_pretrained.pdparams">训练模型</a></td>
|
||
<td>59.52</td>
|
||
<td>103.08 / 103.08</td>
|
||
<td>197.99 / 197.99</td>
|
||
<td>6.9 M</td>
|
||
<td rowspan="1">SLANet 是百度飞桨视觉团队自研的表格结构识别模型。该模型通过采用 CPU 友好型轻量级骨干网络 PP-LCNet、高低层特征融合模块 CSP-PAN、结构与位置信息对齐的特征解码模块 SLA Head，大幅提升了表格结构识别的精度和推理速度。</td>
|
||
</tr>
|
||
<tr>
|
||
<td>SLANet_plus</td><td><a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/official_inference_model/paddle3.0.0/SLANet_plus_infer.tar">推理模型</a>/<a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/official_pretrained_model/SLANet_plus_pretrained.pdparams">训练模型</a></td>
|
||
<td>63.69</td>
|
||
<td>140.29 / 140.29</td>
|
||
<td>195.39 / 195.39</td>
|
||
<td>6.9 M</td>
|
||
<td rowspan="1">SLANet_plus 是百度飞桨视觉团队自研的表格结构识别模型 SLANet 的增强版。相较于 SLANet，SLANet_plus 对无线表、复杂表格的识别能力得到了大幅提升，并降低了模型对表格定位准确性的敏感度，即使表格定位出现偏移，也能够较准确地进行识别。
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>SLANeXt_wired</td>
|
||
<td><a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/official_inference_model/paddle3.0.0/SLANeXt_wired_infer.tar">推理模型</a>/<a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/official_pretrained_model/SLANeXt_wired_pretrained.pdparams">训练模型</a></td>
|
||
<td rowspan="2">69.65</td>
|
||
<td rowspan="2">--</td>
|
||
<td rowspan="2">--</td>
|
||
<td rowspan="2">351M</td>
|
||
<td rowspan="2">SLANeXt 系列是百度飞桨视觉团队自研的新一代表格结构识别模型。相较于 SLANet 和 SLANet_plus，SLANeXt 专注于对表格结构进行识别，并且对有线表格(wired)和无线表格(wireless)的识别分别训练了专用的权重，对各类型表格的识别能力都得到了明显提高，特别是对有线表格的识别能力得到了大幅提升。</td>
|
||
</tr>
|
||
<tr>
|
||
<td>SLANeXt_wireless</td>
|
||
<td><a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/official_inference_model/paddle3.0.0/SLANeXt_wireless_infer.tar">推理模型</a>/<a href="https://paddle-model-ecology.bj.bcebos.com/paddlex/official_pretrained_model/SLANeXt_wireless_pretrained.pdparams">训练模型</a></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<strong>测试环境说明:</strong>
|
||
|
||
<ul>
|
||
<li><b>性能测试环境</b>
|
||
<ul>
|
||
<li><strong>测试数据集：</strong>PaddleX 内部自建高难度中文表格识别数据集。</li>
|
||
<li><strong>硬件配置：</strong>
|
||
<ul>
|
||
<li>GPU：NVIDIA Tesla T4</li>
|
||
<li>CPU：Intel Xeon Gold 6271C @ 2.60GHz</li>
|
||
<li>其他环境：Ubuntu 20.04 / cuDNN 8.6 / TensorRT 8.5.2.2</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><b>推理模式说明</b></li>
|
||
</ul>
|
||
|
||
<table border="1">
|
||
<thead>
|
||
<tr>
|
||
<th>模式</th>
|
||
<th>GPU配置</th>
|
||
<th>CPU配置</th>
|
||
<th>加速技术组合</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>常规模式</td>
|
||
<td>FP32精度 / 无TRT加速</td>
|
||
<td>FP32精度 / 8线程</td>
|
||
<td>PaddleInference</td>
|
||
</tr>
|
||
<tr>
|
||
<td>高性能模式</td>
|
||
<td>选择先验精度类型和加速策略的最优组合</td>
|
||
<td>FP32精度 / 8线程</td>
|
||
<td>选择先验最优后端（Paddle/OpenVINO/TRT等）</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
## 三、快速开始
|
||
|
||
> ❗ 在快速开始前，请先安装 PaddleOCR 的 wheel 包，详细请参考 [安装教程](../ppocr/installation.md)。
|
||
|
||
使用一行命令即可快速体验：
|
||
|
||
```bash
|
||
paddleocr table_structure_recognition -i https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/table_recognition.jpg
|
||
```
|
||
|
||
您也可以将表格结构识别的模块中的模型推理集成到您的项目中。运行以下代码前，请您下载[示例图片](https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/table_recognition.jpg)到本地。
|
||
|
||
```python
|
||
from paddleocr import TableStructureRecognition
|
||
model = TableStructureRecognition(model_name="SLANet")
|
||
output = model.predict(input="table_recognition.jpg", batch_size=1)
|
||
for res in output:
|
||
res.print(json_format=False)
|
||
res.save_to_json("./output/res.json")
|
||
```
|
||
|
||
运行后，得到的结果为：
|
||
|
||
```
|
||
{'res': {'input_path': 'table_recognition.jpg', 'page_index': None, 'bbox': [[42, 2, 390, 2, 388, 27, 40, 26], [11, 35, 89, 35, 87, 63, 11, 63], [113, 34, 192, 34, 186, 64, 109, 64], [219, 33, 399, 33, 393, 62, 212, 62], [413, 33, 544, 33, 544, 64, 407, 64], [12, 67, 98, 68, 96, 93, 12, 93], [115, 66, 205, 66, 200, 91, 111, 91], [234, 65, 390, 65, 385, 92, 227, 92], [414, 66, 537, 67, 537, 95, 409, 95], [7, 97, 106, 97, 104, 128, 7, 128], [113, 96, 206, 95, 201, 127, 109, 127], [236, 96, 386, 96, 381, 128, 230, 128], [413, 96, 534, 95, 533, 127, 408, 127]], 'structure': ['<html>', '<body>', '<table>', '<tr>', '<td', ' colspan="4"', '>', '</td>', '</tr>', '<tr>', '<td></td>', '<td></td>', '<td></td>', '<td></td>', '</tr>', '<tr>', '<td></td>', '<td></td>', '<td></td>', '<td></td>', '</tr>', '<tr>', '<td></td>', '<td></td>', '<td></td>', '<td></td>', '</tr>', '</table>', '</body>', '</html>'], 'structure_score': 0.99948007}}
|
||
```
|
||
|
||
参数含义如下：
|
||
|
||
- `input_path`：输入的待预测表格图像的路径
|
||
- `page_index`：如果输入是PDF文件，则表示当前是PDF的第几页，否则为 `None`
|
||
- `boxes`：预测的表格单元格信息，一个列表，由预测的若干表格单元格坐标组成。特别地， SLANeXt 系列模型预测的表格单元格无效
|
||
- `structure`：预测的表格结构Html表达式，一个列表，由预测的若干Html关键字按顺序组成
|
||
- `structure_score`：预测表格结构的置信度
|
||
|
||
相关方法、参数等说明如下：
|
||
|
||
* `TableStructureRecognition`实例化表格结构识别模型（此处以`SLANet`为例），具体说明如下：
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>参数说明</th>
|
||
<th>参数类型</th>
|
||
<th>可选项</th>
|
||
<th>默认值</th>
|
||
</tr>
|
||
</thead>
|
||
<tr>
|
||
<td><code>model_name</code></td>
|
||
<td>模型名称</td>
|
||
<td><code>str</code></td>
|
||
<td>所有PaddleX支持的模型名称</td>
|
||
<td>无</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>model_dir</code></td>
|
||
<td>模型存储路径</td>
|
||
<td><code>str</code></td>
|
||
<td>无</td>
|
||
<td>无</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>device</code></td>
|
||
<td>模型推理设备</td>
|
||
<td><code>str</code></td>
|
||
<td>支持指定GPU具体卡号，如“gpu:0”，其他硬件具体卡号，如“npu:0”，CPU如“cpu”。</td>
|
||
<td><code>gpu:0</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>use_hpip</code></td>
|
||
<td>是否启用高性能推理插件</td>
|
||
<td><code>bool</code></td>
|
||
<td>无</td>
|
||
<td><code>False</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>hpi_config</code></td>
|
||
<td>高性能推理配置</td>
|
||
<td><code>dict</code> | <code>None</code></td>
|
||
<td>无</td>
|
||
<td><code>None</code></td>
|
||
</tr>
|
||
</table>
|
||
|
||
* 其中，`model_name` 必须指定，指定 `model_name` 后，默认使用 PaddleX 内置的模型参数，在此基础上，指定 `model_dir` 时，使用用户自定义的模型。
|
||
|
||
* 调用表格结构识别模型的 `predict()` 方法进行推理预测，该方法会返回一个结果列表。另外，本模块还提供了 `predict_iter()` 方法。两者在参数接受和结果返回方面是完全一致的，区别在于 `predict_iter()` 返回的是一个 `generator`，能够逐步处理和获取预测结果，适合处理大型数据集或希望节省内存的场景。可以根据实际需求选择使用这两种方法中的任意一种。`predict()` 方法参数有 `input` 和 `batch_size`，具体说明如下：
|
||
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>参数说明</th>
|
||
<th>参数类型</th>
|
||
<th>可选项</th>
|
||
<th>默认值</th>
|
||
</tr>
|
||
</thead>
|
||
<tr>
|
||
<td><code>input</code></td>
|
||
<td>待预测数据，支持多种输入类型</td>
|
||
<td><code>Python Var</code>/<code>str</code>/<code>list</code></td>
|
||
<td>
|
||
<ul>
|
||
<li><b>Python变量</b>，如<code>numpy.ndarray</code>表示的图像数据</li>
|
||
<li><b>文件路径</b>，如图像文件的本地路径：<code>/root/data/img.jpg</code></li>
|
||
<li><b>URL链接</b>，如图像文件的网络URL：<a href = "https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/table_recognition.jpg">示例</a></li>
|
||
<li><b>本地目录</b>，该目录下需包含待预测数据文件，如本地路径：<code>/root/data/</code></li>
|
||
<li><b>列表</b>，列表元素需为上述类型数据，如<code>[numpy.ndarray, numpy.ndarray]</code>，<code>["/root/data/img1.jpg", "/root/data/img2.jpg"]</code>，<code>["/root/data1", "/root/data2"]</code></li>
|
||
</ul>
|
||
</td>
|
||
<td>无</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>batch_size</code></td>
|
||
<td>批大小</td>
|
||
<td><code>int</code></td>
|
||
<td>任意整数</td>
|
||
<td>1</td>
|
||
</tr>
|
||
</table>
|
||
|
||
* 对预测结果进行处理，每个样本的预测结果均为对应的Result对象，且支持打印、保存为`json`文件的操作:
|
||
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>方法</th>
|
||
<th>方法说明</th>
|
||
<th>参数</th>
|
||
<th>参数类型</th>
|
||
<th>参数说明</th>
|
||
<th>默认值</th>
|
||
</tr>
|
||
</thead>
|
||
<tr>
|
||
<td rowspan="3"><code>print()</code></td>
|
||
<td rowspan="3">打印结果到终端</td>
|
||
<td><code>format_json</code></td>
|
||
<td><code>bool</code></td>
|
||
<td>是否对输出内容进行使用 <code>JSON</code> 缩进格式化</td>
|
||
<td><code>True</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>indent</code></td>
|
||
<td><code>int</code></td>
|
||
<td>指定缩进级别，以美化输出的 <code>JSON</code> 数据，使其更具可读性，仅当 <code>format_json</code> 为 <code>True</code> 时有效</td>
|
||
<td>4</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>ensure_ascii</code></td>
|
||
<td><code>bool</code></td>
|
||
<td>控制是否将非 <code>ASCII</code> 字符转义为 <code>Unicode</code>。设置为 <code>True</code> 时，所有非 <code>ASCII</code> 字符将被转义；<code>False</code> 则保留原始字符，仅当<code>format_json</code>为<code>True</code>时有效</td>
|
||
<td><code>False</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td rowspan="3"><code>save_to_json()</code></td>
|
||
<td rowspan="3">将结果保存为json格式的文件</td>
|
||
<td><code>save_path</code></td>
|
||
<td><code>str</code></td>
|
||
<td>保存的文件路径，当为目录时，保存文件命名与输入文件类型命名一致</td>
|
||
<td>无</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>indent</code></td>
|
||
<td><code>int</code></td>
|
||
<td>指定缩进级别，以美化输出的 <code>JSON</code> 数据，使其更具可读性，仅当 <code>format_json</code> 为 <code>True</code> 时有效</td>
|
||
<td>4</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>ensure_ascii</code></td>
|
||
<td><code>bool</code></td>
|
||
<td>控制是否将非 <code>ASCII</code> 字符转义为 <code>Unicode</code>。设置为 <code>True</code> 时，所有非 <code>ASCII</code> 字符将被转义；<code>False</code> 则保留原始字符，仅当<code>format_json</code>为<code>True</code>时有效</td>
|
||
<td><code>False</code></td>
|
||
</tr>
|
||
</table>
|
||
|
||
* 此外，也支持通过属性获取结果，具体如下：
|
||
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>属性</th>
|
||
<th>属性说明</th>
|
||
</tr>
|
||
</thead>
|
||
<tr>
|
||
<td rowspan="1"><code>json</code></td>
|
||
<td rowspan="1">获取预测的<code>json</code>格式的结果</td>
|
||
</tr>
|
||
</table>
|
||
|
||
## 四、二次开发
|
||
|
||
......
|