Skip to content

Latest commit

 

History

History
242 lines (164 loc) · 10.2 KB

README-zh_CN.md

File metadata and controls

242 lines (164 loc) · 10.2 KB
Raw

English | 简体中文

DocLayout-YOLO: Enhancing Document Layout Analysis through Diverse Synthetic Data and Global-to-Local Adaptive Perception

欢迎来到DocLayout-YOLO官方仓库，针对多样性文档提供高质量布局检测能力。

arXiv Online Demo Hugging Face Spaces

摘要

我们提出DocLayout-YOLO的基于YOLO-v10，通过提供多样性文档预训练及适配文档检测的模型结构优化，可针对多样性文档进行实时鲁棒的检测。在文档预训练阶段，我们提出Mesh-candidate BestFit，将文档合成视为二维装箱问题，合成类型多样性的大规模合文档数据集DocSynth-300K。在模型结构优化方面，我们提出了全局到局部可控的感知模块，确保在尺度变化不一的文档元素上得到精准检测结果。


新闻 🚀🚀🚀

2024.10.25 🎉🎉 基于Mesh-candidate Bestfit的数据合成代码开源，可以合成类型多样、真实感强的高质量布局检测数据集，使用教程以及样例数据请见详情。

2024.10.23 🎉🎉 DocSynth300K数据集 现在已经上线 🤗Huggingface, DocSynth300K是一个多样性大规模文档布局检测预训练合成数据集，和from scratch训练相比可以大幅提升下游微调性能。

2024.10.21 🎉🎉 在线演示上线🤗Huggingface。

2024.10.18 🎉🎉 DocLayout-YOLO接入文档内容提取工具包**PDF-Extract-Kit**。

2024.10.16 🎉🎉 论文上线ArXiv。

快速使用

在线演示目前已经上线。 对于本地开发部署，参考以下步骤:

1. 环境配置

参考以下步骤配置环境:

conda create -n doclayout_yolo python=3.10
conda activate doclayout_yolo
pip install -e .

注意: 如果只想使用DocLayout-YOLO的推理功能，直接通过pip进行安装:

pip install doclayout-yolo

2. 模型推理

可以通过脚本的方式或者SDK的方式进行推理:

  • 脚本推理

    通过以下命令运行推理脚本demo.py来进行推理:

    python demo.py --model path/to/model --image-path path/to/image

  • SDK推理

    直接通过SDK进行模型推理:

    import cv2
from doclayout_yolo import YOLOv10

# Load the pre-trained model
model = YOLOv10("path/to/provided/model")

# Perform prediction
det_res = model.predict(
    "path/to/image",   # Image to predict
    imgsz=1024,        # Prediction image size
    conf=0.2,          # Confidence threshold
    device="cuda:0"    # Device to use (e.g., 'cuda:0' or 'cpu')
)

# Annotate and save the result
annotated_frame = det_res[0].plot(pil=True, line_width=5, font_size=20)
cv2.imwrite("result.jpg", annotated_frame)

请使用在 DocStructBench 上微调的模型来进行推理, 可以适用于实际场景中多种类型文档。模型下载地址在链接， 示例图像路径为 assets/example。


注意: 对于PDF或者文档内容提取，请参考PDF-Extract-Kit和MinerU。

注意: 感谢NielsRogge，DocLayout-YOLO 现在支持直接从 🤗Huggingface 进行调用, 加载模型示例如下:

filepath = hf_hub_download(repo_id="juliozhao/DocLayout-YOLO-DocStructBench", filename="doclayout_yolo_docstructbench_imgsz1024.pt")
model = YOLOv10(filepath)

或者直接通过 from_pretrained 进行加载:

model = YOLOv10.from_pretrained("juliozhao/DocLayout-YOLO-DocStructBench")

更多相关细节可以在这个PR进行查看。

注意: 感谢luciaganlulu，DocLayout-YOLO可以进行batch推理。具体来说，在model.predict的demo.py函数中传入图像路径的列表，而不是单张图像，除此之外由于YOLOv11之前版本不支持batch推理，需要手动修改此处的batch_size值。

DocSynth300K数据集

数据下载

使用以下指令下载数据集（约113G）:

from huggingface_hub import snapshot_download
# Download DocSynth300K
snapshot_download(repo_id="juliozhao/DocSynth300K", local_dir="./docsynth300k-hf", repo_type="dataset")
# If the download was disrupted and the file is not complete, you can resume the download
snapshot_download(repo_id="juliozhao/DocSynth300K", local_dir="./docsynth300k-hf", repo_type="dataset", resume_download=True)

数据准备 & 预训练

如果想要进行DocSynth300K预训练, 首先使用 format_docsynth300k.py 将原始数据集的 .parquet 格式转换成 YOLO 格式. 格式转换后的数据存储在 ./layout_data/docsynth300k。

python format_docsynth300k.py

使用此处 命令 来进行DocSynth300K预训练。 默认使用8张GPU进行训练。 为了达到最好的性能, 可以通过调整预训练超参数例如 imgsz 以及 lr， 根据下游微调数据集的分布或者训练设置来调整。

注意: 由于YOLO代码库数据加载存在内存泄漏问题，大数据集训练有可能会出现不明原因中断，可以通过 --pretrain 上一个检查点.pt --resume 来接续预训练

公开文档版面分析（DLA）数据集训练验证

数据准备

  1. 指定数据根目录

找到ultralytics配置文件 (对于Linux用户配置文件在 $HOME/.config/Ultralytics/settings.yaml)， 将datasets_dir改成项目根目录。

  1. 下载整理好的YOLO格式D4LA以及DocLayNet数据， 放置在路径./layout_data并且解压缩:
数据集 下载
D4LA 链接
DocLayNet 链接

准备好的文件结构如下所示:

./layout_data
├── D4LA
│   ├── images
│   ├── labels
│   ├── test.txt
│   └── train.txt
└── doclaynet
    ├── images
    ├── labels
    ├── val.txt
    └── train.txt

模型训练验证

模型训练使用8张GPU，全局batch size大小为64（8张图片每个GPU）。其他详细的配置、命令、以及模型权重如下:

数据集 模型 是否DocSynth300K预训练？ 图像尺寸 学习率 训练 验证 AP50 mAP 模型权重
D4LA DocLayout-YOLO ✗ 1600 0.04 命令 命令 81.7 69.8 权重
D4LA DocLayout-YOLO ✓ 1600 0.04 命令 命令 82.4 70.3 权重
DocLayNet DocLayout-YOLO ✗ 1120 0.02 命令 命令 93.0 77.7 权重
DocLayNet DocLayout-YOLO ✓ 1120 0.02 命令 命令 93.4 79.7 权重

使用DocSynth300K预训练过的预训练模型可以从这里进行下载。 验证时，将命令中的 checkpoint.pt 改成需要验证的模型。

Star History

如果我们的项目有帮助到您，请给本项目点赞！您的点赞是我们继续探索优化的动力。

Star History Chart

致谢

代码基于ultralytics 以及 YOLO-v10进行开发。

引用

@misc{zhao2024doclayoutyoloenhancingdocumentlayout,
      title={DocLayout-YOLO: Enhancing Document Layout Analysis through Diverse Synthetic Data and Global-to-Local Adaptive Perception}, 
      author={Zhiyuan Zhao and Hengrui Kang and Bin Wang and Conghui He},
      year={2024},
      eprint={2410.12628},
      archivePrefix={arXiv},
      primaryClass={cs.CV},
      url={https://arxiv.org/abs/2410.12628}, 
}

@article{wang2024mineru,
  title={MinerU: An Open-Source Solution for Precise Document Content Extraction},
  author={Wang, Bin and Xu, Chao and Zhao, Xiaomeng and Ouyang, Linke and Wu, Fan and Zhao, Zhiyuan and Xu, Rui and Liu, Kaiwen and Qu, Yuan and Shang, Fukai and others},
  journal={arXiv preprint arXiv:2409.18839},
  year={2024}
}