YogeLiu/TexTeller

Fork 0

Files

三洋三洋 8fdaef43f9 update README.md

2024-04-06 11:57:50 +00:00

7.9 KiB

Raw Blame History

📄 English | 中文

𝚃𝚎𝚡𝚃𝚎𝚕𝚕𝚎𝚛

🤗 Hugging Face

https://github.com/OleehyO/TexTeller/assets/56267907/fb17af43-f2a5-47ce-ad1d-101db5fd7fbb

TexTeller是一个基于ViT的端到端公式识别模型，可以把图片转换为对应的latex公式

TexTeller用了~~550K~~7.5M的图片-公式对进行训练(数据集可以在这里获取)，相比于LaTeX-OCR(使用了一个100K的数据集)，TexTeller具有更强的泛化能力以及更高的准确率，可以覆盖大部分的使用场景(扫描图片，手写公式除外)。

~~我们马上就会发布一个使用7.5M数据集进行训练的TexTeller checkpoint~~

🔄 变更信息

📮[2024-03-25] TexTeller2.0发布！TexTeller2.0的训练数据增大到了7.5M(相较于TexTeller1.0增加了~15倍并且数据质量也有所改善)。训练后的TexTeller2.0在测试集中展现出了更加优越的性能，尤其在生僻符号、复杂多行、矩阵的识别场景中。

在这里有更多的测试图片以及各家识别模型的横向对比。

🔑 前置条件

python=3.10

pytorch

Warning

只有CUDA版本>= 12.0被完全测试过，所以最好使用>= 12.0的CUDA版本

🚀 开搞

克隆本仓库:

git clone https://github.com/OleehyO/TexTeller

安装pytorch
安装本项目的依赖包:
```
pip install -r requirements.txt
```

进入TexTeller/src目录，在终端运行以下命令进行推理:

python inference.py -img "/path/to/image.{jpg,png}" 
# use -cuda option to enable GPU inference
#+e.g. python inference.py -img "./img.jpg" -cuda

Note

第一次运行时会在hugging face上下载所需要的checkpoints

❓ 常见问题：无法连接到Hugging Face

默认情况下，会在Hugging Face中下载模型权重，如果你的远端服务器无法连接到Hugging Face，你可以通过以下命令进行加载：

安装huggingface hub包
```
pip install -U "huggingface_hub[cli]"
```

在能连接Hugging Face的机器上下载模型权重:

huggingface-cli download OleehyO/TexTeller --include "*.json" "*.bin" "*.txt" --repo-type model --local-dir "your/dir/path"

把包含权重的目录上传远端服务器，然后把TexTeller/src/models/ocr_model/model/TexTeller.py中的REPO_NAME = 'OleehyO/TexTeller'修改为REPO_NAME = 'your/dir/path'

如果你还想在训练模型时开启evaluate，你需要提前下载metric脚本并上传远端服务器：

在能连接Hugging Face的机器上下载metric脚本

huggingface-cli download evaluate-metric/google_bleu --repo-type space --local-dir "your/dir/path"

把这个目录上传远端服务器，并在TexTeller/src/models/ocr_model/utils/metrics.py中把evaluate.load('google_bleu')改为evaluate.load('your/dir/path/google_bleu.py')

🌐 网页演示

进入 TexTeller/src 目录，运行以下命令

./start_web.sh

在浏览器里输入http://localhost:8501就可以看到web demo

Tip

你可以改变start_web.sh的默认配置，例如使用GPU进行推理(e.g. USE_CUDA=True) 或者增加beams的数量(e.g. NUM_BEAM=3)来获得更高的精确度

Note

对于Windows用户, 请运行 start_web.bat文件.

📡 API调用

我们使用ray serve来对外提供一个TexTeller的API接口，通过使用这个接口，你可以把TexTeller整合到自己的项目里。要想启动server，你需要先进入TexTeller/src目录然后运行以下命令:

python server.py  # default settings

你可以给server.py传递以下参数来改变server的推理设置(e.g. python server.py --use_gpu 来启动GPU推理):

参数	描述
`-ckpt`	权重文件的路径，默认为TexTeller的预训练权重。
`-tknz`	分词器的路径，默认为TexTeller的分词器。
`-port`	服务器的服务端口，默认是8000。
`--use_gpu`	是否使用GPU推理，默认为CPU。
`--num_beams`	beam search的beam数量，默认是1。
`--num_replicas`	在服务器上运行的服务副本数量，默认1个副本。你可以使用更多的副本来获取更大的吞吐量。
`--ncpu_per_replica`	每个服务副本所用的CPU核心数，默认为1。
`--ngpu_per_replica`	每个服务副本所用的GPU数量，默认为1。你可以把这个值设置成 0~1之间的数，这样会在一个GPU上运行多个服务副本来共享GPU，从而提高GPU的利用率。(注意，如果 --num_replicas 2, --ngpu_per_replica 0.7, 那么就必须要有2个GPU可用)

Note

一个客户端demo可以在TexTeller/client/demo.py找到，你可以参考demo.py来给server发送请求

🏋️‍♂️ 训练

数据集

我们在TexTeller/src/models/ocr_model/train/dataset目录中提供了一个数据集的例子，你可以把自己的图片放在images目录然后在formulas.jsonl中为每张图片标注对应的公式。

准备好数据集后，你需要在.../dataset/loader.py中把 DIR_URL变量改成你自己数据集的路径

重新训练分词器

如果你使用了不一样的数据集，你可能需要重新训练tokenizer来得到一个不一样的字典。配置好数据集后，可以通过以下命令来训练自己的tokenizer：

在TexTeller/src/models/tokenizer/train.py中，修改new_tokenizer.save_pretrained('./your_dir_name')为你自定义的输出目录

注意：如果要用一个不一样大小的字典(默认1W个token)，你需要在 TexTeller/src/models/globals.py中修改VOCAB_SIZE变量
在 TexTeller/src 目录下运行以下命令:
```
python -m models.tokenizer.train
```

训练模型

要想训练模型, 你需要在TexTeller/src目录下运行以下命令：

python -m models.ocr_model.train.train

你可以在TexTeller/src/models/ocr_model/train/train.py中设置自己的tokenizer和checkpoint路径（请参考train.py）。如果你使用了与TexTeller一样的架构和相同的字典，你还可以用自己的数据集来微调TexTeller的默认权重。

在TexTeller/src/globals.py和TexTeller/src/models/ocr_model/train/train_args.py中，你可以改变模型的架构以及训练的超参数。

Note

我们的训练脚本使用了Hugging Face Transformers库, 所以你可以参考他们提供的文档来获取更多训练参数的细节以及配置。

🚧 不足

不支持扫描图片以及PDF文档识别
不支持手写体公式

📅 计划

~~使用更大的数据集来训练模型(7.5M样本，即将发布)~~
扫描图片识别
PDF文档识别 + 中英文场景支持
推理加速
...

💖 感谢

Thanks to LaTeX-OCR which has brought me a lot of inspiration, and im2latex-100K which enriches our dataset.

7.9 KiB Raw Blame History Unescape Escape