---
comments: true
---
# 公式识别模块使用教程
## 一、概述
公式识别模块是OCR（光学字符识别）系统中的关键组成部分，负责将图像中的数学公式转换为可编辑的文本或计算机可识别的格式。该模块的性能直接影响到整个OCR系统的准确性和效率。公式识别模块通常会输出数学公式的 LaTeX 或 MathML 代码，这些代码将作为输入传递给文本理解模块进行后续处理。
## 二、支持模型列表
| 模型 | 模型下载链接 |
normed edit distance |
BLEU score |
ExpRate （%） |
模型存储大小 (M) |
介绍 |
| LaTeX_OCR_rec | 推理模型/训练模型 |
0.8821 |
0.0823 |
40.01 |
89.7 M |
LaTeX-OCR是一种基于自回归大模型的公式识别算法，通过采用 Hybrid ViT 作为骨干网络，transformer作为解码器，显著提升了公式识别的准确性 |
注：以上精度指标测量自 LaTeX-OCR公式识别测试集。
## 三、快速集成
> ❗ 在快速集成前，请先安装 PaddleX 的 wheel 包，详细请参考 [PaddleX本地安装教程](../../../installation/installation.md)
wheel 包的安装后，几行代码即可完成公式识别模块的推理，可以任意切换该模块下的模型，您也可以将公式识别的模块中的模型推理集成到您的项目中。运行以下代码前，请您下载[示例图片](https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_formula_rec_001.png)到本地。
```bash
from paddlex import create_model
model = create_model("LaTeX_OCR_rec")
output = model.predict("general_formula_rec_001.png", batch_size=1)
for res in output:
res.print(json_format=False)
res.save_to_json("./output/res.json")
```
关于更多 PaddleX 的单模型推理的 API 的使用方法，可以参考的使用方法，可以参考[PaddleX单模型Python脚本使用说明](../../instructions/model_python_API.md)。
## 四、二次开发
如果你追求更高精度的现有模型，可以使用 PaddleX 的二次开发能力，开发更好的公式识别模型。在使用 PaddleX 开发公式识别模型之前，请务必安装 PaddleX 的 PaddleOCR 相关模型训练插件，安装过程可以参考 [PaddleX本地安装教程](../../../installation/installation.md)
### 4.1 数据准备
在进行模型训练前，需要准备相应任务模块的数据集。PaddleX 针对每一个模块提供了数据校验功能，只有通过数据校验的数据才可以进行模型训练。此外，PaddleX 为每一个模块都提供了 Demo 数据集，您可以基于官方提供的 Demo 数据完成后续的开发。若您希望用私有数据集进行后续的模型训练，可以参考[LaTeX-OCR 公式识别项目](https://github.com/lukas-blecher/LaTeX-OCR)
#### 4.1.1 Demo 数据下载
您可以参考下面的命令将 Demo 数据集下载到指定文件夹：
```bash
wget https://paddle-model-ecology.bj.bcebos.com/paddlex/data/ocr_rec_latexocr_dataset_example.tar -P ./dataset
tar -xf ./dataset/ocr_rec_latexocr_dataset_example.tar -C ./dataset/
```
#### 4.1.2 数据校验
一行命令即可完成数据校验：
```bash
python main.py -c paddlex/configs/formula_recognition/LaTeX_OCR_rec.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/ocr_rec_latexocr_dataset_example
```
执行上述命令后，PaddleX 会对数据集进行校验，并统计数据集的基本信息，命令运行成功后会在 log 中打印出`Check dataset passed !`信息。校验结果文件保存在`./output/check_dataset_result.json`，同时相关产出会保存在当前目录的`./output/check_dataset`目录下，产出目录中包括可视化的示例样本图片和样本分布直方图。
👉 校验结果详情（点击展开）
校验结果文件具体内容为：
{
"done_flag": true,
"check_pass": true,
"attributes": {
"train_samples": 9452,
"train_sample_paths": [
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0109284.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0217434.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0166758.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0022294.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/val_0071799.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0017043.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0026204.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0209202.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/val_0157332.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0232582.png"
],
"val_samples": 1050,
"val_sample_paths": [
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0070221.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0157901.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0085392.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0196480.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0096180.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0136149.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0143310.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0004560.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0115191.png",
"../dataset/ocr_rec_latexocr_dataset_example/images/train_0015323.png"
]
},
"analysis": {
"histogram": "check_dataset/histogram.png"
},
"dataset_path": "./dataset/ocr_rec_latexocr_dataset_example",
"show_type": "image",
"dataset_type": "LaTeXOCRDataset"
}
上述校验结果中，check_pass 为 True 表示数据集格式符合要求，其他部分指标的说明如下：
attributes.train_samples：该数据集训练集样本数量为 9452；attributes.val_samples：该数据集验证集样本数量为 1050；attributes.train_sample_paths：该数据集训练集样本可视化图片相对路径列表；attributes.val_sample_paths：该数据集验证集样本可视化图片相对路径列表；
另外，数据集校验还对数据集中所有类别的样本数量分布情况进行了分析，并绘制了分布直方图（histogram.png）：
👉 格式转换/数据集划分详情（点击展开）
（1）数据集格式转换
公式识别支持 MSTextRecDataset格式的数据集转换为 LaTeXOCRDataset格式(PKL格式)，数据集格式转换的参数可以通过修改配置文件中 CheckDataset 下的字段进行设置，配置文件中部分参数的示例说明如下：
CheckDataset:convert:enable: 是否进行数据集格式转换，公式识别支持 MSTextRecDataset格式的数据集转换为 LaTeXOCRDataset格式，默认为 True;src_dataset_type: 如果进行数据集格式转换，则需设置源数据集格式，默认为 MSTextRecDataset；
例如，您想将 MSTextRecDataset格式的数据集转换为 LaTeXOCRDataset格式，则需将配置文件修改为：
......
CheckDataset:
......
convert:
enable: True
src_dataset_type: MSTextRecDataset
......
随后执行命令：
python main.py -c paddlex/configs/formula_recognition/LaTeX_OCR_rec.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/ocr_rec_latexocr_dataset_example
数据转换执行之后，原有标注文件会被在原路径下重命名为 xxx.bak。
以上参数同样支持通过追加命令行参数的方式进行设置：
python main.py -c paddlex/configs/formula_recognition/LaTeX_OCR_rec.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/ocr_rec_latexocr_dataset_example \
-o CheckDataset.convert.enable=True \
-o CheckDataset.convert.src_dataset_type=MSTextRecDataset
（2）数据集划分
数据集划分的参数可以通过修改配置文件中 CheckDataset 下的字段进行设置，配置文件中部分参数的示例说明如下：
CheckDataset:split:enable: 是否进行重新划分数据集，为 True 时进行数据集格式转换，默认为 False；train_percent: 如果重新划分数据集，则需要设置训练集的百分比，类型为 0-100 之间的任意整数，需要保证和 val_percent 值加和为100；
例如，您想重新划分数据集为 训练集占比90%、验证集占比10%，则需将配置文件修改为：
......
CheckDataset:
......
split:
enable: True
train_percent: 90
val_percent: 10
......
随后执行命令：
python main.py -c paddlex/configs/formula_recognition/LaTeX_OCR_rec.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/ocr_rec_latexocr_dataset_example
数据划分执行之后，原有标注文件会被在原路径下重命名为 xxx.bak。
以上参数同样支持通过追加命令行参数的方式进行设置：
python main.py -c paddlex/configs/formula_recognition/LaTeX_OCR_rec.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/ocr_rec_latexocr_dataset_example \
-o CheckDataset.split.enable=True \
-o CheckDataset.split.train_percent=90 \
-o CheckDataset.split.val_percent=10
👉 更多说明（点击展开）
👉 更多说明（点击展开）
在模型评估时，需要指定模型权重文件路径，每个配置文件中都内置了默认的权重保存路径，如需要改变，只需要通过追加命令行参数的形式进行设置即可，如-o Evaluate.weight_path=./output/best_accuracy/best_accuracy.pdparams。
在完成模型评估后，会产出evaluate_result.json，其记录了评估的结果，具体来说，记录了评估任务是否正常完成，以及模型的评估指标，包括 exp_rate ；