# RapidTable
**Repository Path**: liu-eric/RapidTable
## Basic Information
- **Project Name**: RapidTable
- **Description**: No description available
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: adapt_unitable_decode
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-16
- **Last Updated**: 2025-07-16
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
### 简介
RapidTable库是专门用来文档类图像的表格结构还原，表格结构模型均属于序列预测方法，结合RapidOCR，将给定图像中的表格转化对应的HTML格式。
slanet_plus是paddlex内置的SLANet升级版模型，准确率有大幅提升
unitable是来源unitable的transformer模型，精度最高，暂仅支持pytorch推理，支持gpu推理加速,训练权重来源于 [OhMyTable项目](https://github.com/Sanster/OhMyTable)
### 效果展示
### 模型列表
| `model_type` | 模型名称 | 推理框架 |模型大小 |推理耗时(单图 60KB)|
|:--------------|:--------------------------------------| :------: |:------ |:------ |
| `ppstructure_en` | `en_ppstructure_mobile_v2_SLANet.onnx` | onnxruntime |7.3M |0.15s |
| `ppstructure_zh` | `ch_ppstructure_mobile_v2_SLANet.onnx` | onnxruntime |7.4M |0.15s |
| `slanet_plus` | `slanet-plus.onnx` | onnxruntime |6.8M |0.15s |
| `unitable` | `unitable(encoder.pth,decoder.pth)` | pytorch |500M |cpu(6s) gpu-4090(1.5s)|
模型来源\
[PaddleOCR 表格识别](https://github.com/PaddlePaddle/PaddleOCR/blob/133d67f27dc8a241d6b2e30a9f047a0fb75bebbe/ppstructure/table/README_ch.md)\
[PaddleX-SlaNetPlus 表格识别](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/module_usage/tutorials/ocr_modules/table_structure_recognition.md)\
[Unitable](https://github.com/poloclub/unitable?tab=readme-ov-file)
模型托管在modelscope上，具体下载地址为：[link](https://www.modelscope.cn/models/RapidAI/RapidTable/files)
### 安装
由于模型较小，预先将slanet-plus表格识别模型(`slanet-plus.onnx`)打包进了whl包内。
> ⚠️注意：`rapid_table>=v0.1.0`之后，不再将`rapidocr_onnxruntime`依赖强制打包到`rapid_table`中。使用前，需要自行安装`rapidocr_onnxruntime`包。
```bash
pip install rapidocr_onnxruntime
pip install rapid_table
# 基于torch来推理unitable模型
pip install rapid_table[torch] # for unitable inference
# onnxruntime-gpu推理
pip uninstall onnxruntime
pip install onnxruntime-gpu # for onnx gpu inference
```
### 使用方式
#### python脚本运行
> ⚠️注意：在`rapid_table>=1.0.0`之后，模型输入均采用dataclasses封装，简化和兼容参数传递。输入和输出定义如下：
```python
# 输入
@dataclass
class RapidTableInput:
model_type: Optional[str] = ModelType.SLANETPLUS.value
model_path: Union[str, Path, None, Dict[str, str]] = None
use_cuda: bool = False
device: str = "cpu"
# 输出
@dataclass
class RapidTableOutput:
pred_html: Optional[str] = None
cell_bboxes: Optional[np.ndarray] = None
logic_points: Optional[np.ndarray] = None
elapse: Optional[float] = None
# 使用示例
input_args = RapidTableInput(model_type="unitable")
table_engine = RapidTable(input_args)
img_path = 'test_images/table.jpg'
table_results = table_engine(img_path)
print(table_results.pred_html)
```
完整示例：
```python
from pathlib import Path
from rapid_table import RapidTable, VisTable
from rapidocr_onnxruntime import RapidOCR
from rapid_table.table_structure.utils import trans_char_ocr_res
table_engine = RapidTable()
# 开启onnx-gpu推理
# input_args = RapidTableInput(use_cuda=True)
# table_engine = RapidTable(input_args)
# 使用torch推理版本的unitable模型
# input_args = RapidTableInput(model_type="unitable", use_cuda=True, device="cuda:0")
# table_engine = RapidTable(input_args)
ocr_engine = RapidOCR()
viser = VisTable()
img_path = 'test_images/table.jpg'
ocr_result, _ = ocr_engine(img_path)
# 单字匹配
# ocr_result, _ = ocr_engine(img_path, return_word_box=True)
# ocr_result = trans_char_ocr_res(ocr_result)
table_results = table_engine(img_path, ocr_result)
save_dir = Path("./inference_results/")
save_dir.mkdir(parents=True, exist_ok=True)
save_html_path = save_dir / f"{Path(img_path).stem}.html"
save_drawed_path = save_dir / f"vis_{Path(img_path).name}"
viser(
img_path,
table_results.pred_html,
save_html_path,
table_results.cell_bboxes,
save_drawed_path,
table_results.logic_points,
save_logic_path,
)
print(table_html_str)
```
#### 终端运行
```bash
rapid_table -v -img test_images/table.jpg
```
### 结果
#### 返回结果
```html
| Methods |
|
|
|
FPS |
| SegLink [26] |
70.0 |
86d>
| 77.0 |
8.9 |
|
| PixelLink [4] |
73.2 |
83.0 |
77.8 |
|
| TextSnake [18] |
73.9 |
83.2 |
78.3 |
1.1 |
| TextField [37] |
75.9 |
87.4 |
81.3 |
5.2 |
| MSR[38] |
76.7 |
87.87.4 |
81.7 |
|
| FTSN [3] |
77.1 |
87.6 |
82.0 |
|
| LSE[30] |
81.7 |
84.2 |
82.9 |
<>
| CRAFT [2] |
78.2 |
88.2 |
82.9 |
8.6 |
| MCN[16] |
79 |
88 |
83 |
|
| ATRR[35] |
82.1 |
85.2 |
83.6 |
|
| PAN [34] |
83.8 |
84.4 |
84.1 |
30.2 |
| DB[12] |
79.2
| 91.5 |
84.9 |
32.0 |
| DRRG[41] |
82.30 |
88.05 |
85.08 |
|
| Ours (SynText) |
80.68 |
85
| 82.97 |
12.68 |
|
| Ours (MLT-17) |
84.54 |
86.62 |
85.57 |
12.31 |
```
#### 可视化结果
| Methods | | | | FPS |
| SegLink [26] | 70.0 | 86d>| 77.0 | 8.9 | |
| PixelLink [4] | 73.2 | 83.0 | 77.8 | |
| TextSnake [18] | 73.9 | 83.2 | 78.3 | 1.1 |
| TextField [37] | 75.9 | 87.4 | 81.3 | 5.2 |
| MSR[38] | 76.7 | 87.87.4 | 81.7 | |
| FTSN [3] | 77.1 | 87.6 | 82.0 | |
| LSE[30] | 81.7 | 84.2 | 82.9 | <>
| CRAFT [2] | 78.2 | 88.2 | 82.9 | 8.6 |
| MCN[16] | 79 | 88 | 83 | |
| ATRR[35] | 82.1 | 85.2 | 83.6 | |
| PAN [34] | 83.8 | 84.4 | 84.1 | 30.2 |
| DB[12] | 79.2 | 91.5 | 84.9 | 32.0 |
| DRRG[41] | 82.30 | 88.05 | 85.08 | |
| Ours (SynText) | 80.68 | 85| 82.97 | 12.68 | |
| Ours (MLT-17) | 84.54 | 86.62 | 85.57 | 12.31 |
### 与[TableStructureRec](https://github.com/RapidAI/TableStructureRec)关系
TableStructureRec库是一个表格识别算法的集合库，当前有`wired_table_rec`有线表格识别算法和`lineless_table_rec`无线表格识别算法的推理包。
RapidTable是整理自PP-Structure中表格识别部分而来。由于PP-Structure较早，这个库命名就成了`rapid_table`。
总之，RapidTable和TabelStructureRec都是表格识别的仓库。大家可以都试试，哪个好用用哪个。由于每个算法都不太同，暂时不打算做统一处理。
关于表格识别算法的比较，可参见[TableStructureRec测评](https://github.com/RapidAI/TableStructureRec#指标结果)
### 更新日志
#### 2024.12.30 update
- 支持Unitable模型的表格识别，使用pytorch框架
#### 2024.11.24 update
- 支持gpu推理，适配 rapidOCR 单字识别匹配,支持逻辑坐标返回及可视化
#### 2024.10.13 update
- 补充最新paddlex-SLANet-plus 模型(paddle2onnx原因暂不能支持onnx)
#### 2023-12-29 v0.1.3 update
- 优化可视化结果部分
#### 2023-12-27 v0.1.2 update
- 添加返回cell坐标框参数
- 完善可视化函数
#### 2023-07-17 v0.1.0 update
- 将`rapidocr_onnxruntime`部分从`rapid_table`中解耦合出来，给出选项是否依赖，更加灵活。
- 增加接口输入参数`ocr_result`：
- 如果在调用函数时，事先指定了`ocr_result`参数值，则不会再走OCR。其中`ocr_result`格式需要和`rapidocr_onnxruntime`返回值一致。
- 如果未指定`ocr_result`参数值，但是事先安装了`rapidocr_onnxruntime`库，则会自动调用该库，进行识别。
- 如果`ocr_result`未指定，且`rapidocr_onnxruntime`未安装，则会报错。必须满足两个条件中一个。
#### 2023-07-10 v0.0.13 updata
- 更改传入表格还原中OCR的实例接口，可以传入其他OCR实例，前提要与`rapidocr_onnxruntime`接口一致
#### 2023-07-06 v0.0.12 update
- 去掉返回表格的html字符串中的``元素，便于后续统一。
- 采用Black工具优化代码
