Skip to content

Latest commit

 

History

History
482 lines (386 loc) · 35 KB

README_zh-CN.md

File metadata and controls

482 lines (386 loc) · 35 KB
Raw

更新记录

  • 2024/11/06 0.9.2发布，为表格识别功能接入了StructTable-InternVL2-1B模型
  • 2024/10/31 0.9.0发布，这是我们进行了大量代码重构的全新版本，解决了众多问题，提升了性能，降低了硬件需求，并提供了更丰富的易用性：
    • 重构排序模块代码，使用 layoutreader 进行阅读顺序排序，确保在各种排版下都能实现极高准确率
    • 重构段落拼接模块，在跨栏、跨页、跨图、跨表情况下均能实现良好的段落拼接效果
    • 重构列表和目录识别功能，极大提升列表块和目录块识别的准确率及对应文本段落的解析效果
    • 重构图、表与描述性文本的匹配逻辑，大幅提升 caption 和 footnote 与图表的匹配准确率，并将描述性文本的丢失率降至接近0
    • 增加 OCR 的多语言支持，支持 84 种语言的检测与识别，语言支持列表详见 OCR 语言支持列表
    • 增加显存回收逻辑及其他显存优化措施，大幅降低显存使用需求。开启除表格加速外的全部加速功能(layout/公式/OCR)的显存需求从16GB降至8GB，开启全部加速功能的显存需求从24GB降至10GB
    • 优化配置文件的功能开关，增加独立的公式检测开关，无需公式检测时可大幅提升速度和解析效果
    • 集成 PDF-Extract-Kit 1.0
      • 加入自研的 doclayout_yolo 模型，在相近解析效果情况下比原方案提速10倍以上，可通过配置文件与 layoutlmv3 自由切换
      • 公式解析升级至 unimernet 0.2.1，在提升公式解析准确率的同时，大幅降低显存需求
      • 因 PDF-Extract-Kit 1.0 更换仓库，需要重新下载模型，步骤详见 如何下载模型
  • 2024/09/27 0.8.1发布，修复了一些bug，同时提供了在线demo的本地化部署版本和前端界面
  • 2024/09/09 0.8.0发布，支持Dockerfile快速部署，同时上线了huggingface、modelscope demo
  • 2024/08/30 0.7.1发布，集成了paddle tablemaster表格识别功能
  • 2024/08/09 0.7.0b1发布，简化安装步骤提升易用性，加入表格识别功能
  • 2024/08/01 0.6.2b1发布，优化了依赖冲突问题和安装文档
  • 2024/07/05 首次开源

文档目录
  1. MinerU
  2. TODO
  3. Known Issues
  4. FAQ
  5. Contributors
  6. License Information
  7. Acknowledgements
  8. Citation
  9. Star History
  10. magic-doc快速提取PPT/DOC/PDF
  11. magic-html提取混合网页内容
  12. Links

MinerU

项目简介

MinerU是一款将PDF转化为机器可读格式的工具（如markdown、json），可以很方便地抽取为任意格式。 MinerU诞生于书生-浦语的预训练过程中，我们将会集中精力解决科技文献中的符号转化问题，希望在大模型时代为科技发展做出贡献。 相比国内外知名商用产品MinerU还很年轻，如果遇到问题或者结果不及预期请到issue提交问题，同时附上相关PDF。

pdf_zh_cn.mp4

主要功能

  • 删除页眉、页脚、脚注、页码等元素，确保语义连贯
  • 输出符合人类阅读顺序的文本，适用于单栏、多栏及复杂排版
  • 保留原文档的结构，包括标题、段落、列表等
  • 提取图像、图片描述、表格、表格标题及脚注
  • 自动识别并转换文档中的公式为LaTeX格式
  • 自动识别并转换文档中的表格为LaTeX或HTML格式
  • 自动检测扫描版PDF和乱码PDF，并启用OCR功能
  • OCR支持84种语言的检测与识别
  • 支持多种输出格式，如多模态与NLP的Markdown、按阅读顺序排序的JSON、含有丰富信息的中间格式等
  • 支持多种可视化结果，包括layout可视化、span可视化等，便于高效确认输出效果与质检
  • 支持CPU和GPU环境
  • 兼容Windows、Linux和Mac平台

快速开始

如果遇到任何安装问题，请先查询 FAQ
如果遇到解析效果不及预期，参考 Known Issues
有3种不同方式可以体验MinerU的效果：

Warning

安装前必看——软硬件环境支持说明

为了确保项目的稳定性和可靠性，我们在开发过程中仅对特定的软硬件环境进行优化和测试。这样当用户在推荐的系统配置上部署和运行项目时，能够获得最佳的性能表现和最少的兼容性问题。

通过集中资源和精力于主线环境，我们团队能够更高效地解决潜在的BUG，及时开发新功能。

在非主线环境中，由于硬件、软件配置的多样性，以及第三方依赖项的兼容性问题，我们无法100%保证项目的完全可用性。因此，对于希望在非推荐环境中使用本项目的用户，我们建议先仔细阅读文档以及FAQ，大多数问题已经在FAQ中有对应的解决方案，除此之外我们鼓励社区反馈问题，以便我们能够逐步扩大支持范围。

操作系统
Ubuntu 22.04 LTS Windows 10 / 11 macOS 11+
CPU x86_64(暂不支持ARM Linux) x86_64(暂不支持ARM Windows) x86_64 / arm64
内存 大于等于16GB，推荐32G以上
python版本 3.10 (请务必通过conda创建3.10虚拟环境)
Nvidia Driver 版本 latest(专有驱动) latest None
CUDA环境 自动安装[12.1(pytorch)+11.8(paddle)] 11.8(手动安装)+cuDNN v8.7.0(手动安装) None
GPU硬件支持列表 最低要求 8G+显存 3060ti/3070/4060
8G显存可开启layout、公式识别和ocr加速		 None
推荐配置 10G+显存 3080/3080ti/3090/3090ti/4070/4070ti/4070tisuper/4080/4090
10G显存及以上可以同时开启layout、公式识别和ocr加速和表格识别加速

在线体验

稳定版(经过QA验证的稳定版本)：

OpenDataLab

测试版(同步dev分支更新，测试新特性)：

HuggingFace ModelScope

使用CPU快速体验

1. 安装magic-pdf

Note

最新版本国内镜像源同步可能会有延迟，请耐心等待

conda create -n MinerU python=3.10
conda activate MinerU
pip install -U magic-pdf[full] --extra-index-url https://wheels.myhloli.com -i https://mirrors.aliyun.com/pypi/simple

2. 下载模型权重文件

详细参考 如何下载模型文件

3. 修改配置文件以进行额外配置

完成2. 下载模型权重文件步骤后，脚本会自动生成用户目录下的magic-pdf.json文件，并自动配置默认模型路径。 您可在【用户目录】下找到magic-pdf.json文件。

Tip

windows的用户目录为 "C:\Users\用户名", linux用户目录为 "/home/用户名", macOS用户目录为 "/Users/用户名"

您可修改该文件中的部分配置实现功能的开关，如表格识别功能：

Note

如json内没有如下项目，请手动添加需要的项目，并删除注释内容（标准json不支持注释）

{
    // other config
    "layout-config": {
        "model": "layoutlmv3" // 使用doclayout_yolo请修改为“doclayout_yolo"
    },
    "formula-config": {
        "mfd_model": "yolo_v8_mfd",
        "mfr_model": "unimernet_small",
        "enable": true  // 公式识别功能默认是开启的，如果需要关闭请修改此处的值为"false"
    },
    "table-config": {
        "model": "tablemaster",  // 使用structEqTable请修改为"struct_eqtable"
        "enable": false, // 表格识别功能默认是关闭的，如果需要开启请修改此处的值为"true"
        "max_time": 400
    }
}

使用GPU

如果您的设备支持CUDA，且满足主线环境中的显卡要求，则可以使用GPU加速，请根据自己的系统选择适合的教程：

Important

Docker 需设备gpu显存大于等于16GB，默认开启所有加速功能

运行本docker前可以通过以下命令检测自己的设备是否支持在docker上使用CUDA加速

docker run --rm --gpus=all nvidia/cuda:12.1.0-base-ubuntu22.04 nvidia-smi
wget https://github.com/opendatalab/MinerU/raw/master/Dockerfile
docker build -t mineru:latest .
docker run --rm -it --gpus=all mineru:latest /bin/bash
magic-pdf --help

使用

命令行

magic-pdf --help
Usage: magic-pdf [OPTIONS]

Options:
  -v, --version                display the version and exit
  -p, --path PATH              local pdf filepath or directory  [required]
  -o, --output-dir PATH        output local directory  [required]
  -m, --method [ocr|txt|auto]  the method for parsing pdf. ocr: using ocr
                               technique to extract information from pdf. txt:
                               suitable for the text-based pdf only and
                               outperform ocr. auto: automatically choose the
                               best method for parsing pdf from ocr and txt.
                               without method specified, auto will be used by
                               default.
  -l, --lang TEXT              Input the languages in the pdf (if known) to
                               improve OCR accuracy.  Optional. You should
                               input "Abbreviation" with language form url: ht
                               tps://paddlepaddle.github.io/PaddleOCR/latest/en
                               /ppocr/blog/multi_languages.html#5-support-languages-
                               and-abbreviations
  -d, --debug BOOLEAN          Enables detailed debugging information during
                               the execution of the CLI commands.
  -s, --start INTEGER          The starting page for PDF parsing, beginning
                               from 0.
  -e, --end INTEGER            The ending page for PDF parsing, beginning from
                               0.
  --help                       Show this message and exit.


## show version
magic-pdf -v

## command line example
magic-pdf -p {some_pdf} -o {some_output_dir} -m auto

其中 {some_pdf} 可以是单个pdf文件，也可以是一个包含多个pdf文件的目录。 运行完命令后输出的结果会保存在{some_output_dir}目录下, 输出的文件列表如下

├── some_pdf.md                          # markdown 文件
├── images                               # 存放图片目录
├── some_pdf_layout.pdf                  # layout 绘图 （包含layout阅读顺序）
├── some_pdf_middle.json                 # minerU 中间处理结果
├── some_pdf_model.json                  # 模型推理结果
├── some_pdf_origin.pdf                  # 原 pdf 文件
├── some_pdf_spans.pdf                   # 最小粒度的bbox位置信息绘图
└── some_pdf_content_list.json           # 按阅读顺序排列的富文本json

Tip

更多有关输出文件的信息，请参考输出文件说明

API

处理本地磁盘上的文件

image_writer = DiskReaderWriter(local_image_dir)
image_dir = str(os.path.basename(local_image_dir))
jso_useful_key = {"_pdf_type": "", "model_list": []}
pipe = UNIPipe(pdf_bytes, jso_useful_key, image_writer)
pipe.pipe_classify()
pipe.pipe_analyze()
pipe.pipe_parse()
md_content = pipe.pipe_mk_markdown(image_dir, drop_mode="none")

处理对象存储上的文件

s3pdf_cli = S3ReaderWriter(pdf_ak, pdf_sk, pdf_endpoint)
image_dir = "s3://img_bucket/"
s3image_cli = S3ReaderWriter(img_ak, img_sk, img_endpoint, parent_path=image_dir)
pdf_bytes = s3pdf_cli.read(s3_pdf_path, mode=s3pdf_cli.MODE_BIN)
jso_useful_key = {"_pdf_type": "", "model_list": []}
pipe = UNIPipe(pdf_bytes, jso_useful_key, s3image_cli)
pipe.pipe_classify()
pipe.pipe_analyze()
pipe.pipe_parse()
md_content = pipe.pipe_mk_markdown(image_dir, drop_mode="none")

详细实现可参考

部署衍生项目

衍生项目包含项目开发者和社群开发者们基于MinerU的二次开发项目， 例如基于Gradio的应用界面、基于llama的RAG、官网同款web demo、轻量级的多卡负载均衡c/s端等， 这些项目可能会提供更多的功能和更好的用户体验。 具体部署方式请参考 衍生项目readme

二次开发

TODO

TODO

  • 基于模型的阅读顺序
  • 正文中目录、列表识别
  • 表格识别
  • 正文中代码块识别
  • 化学式识别
  • 几何图形识别

Known Issues

  • 阅读顺序基于模型对可阅读内容在空间中的分布进行排序，在极端复杂的排版下可能会部分区域乱序
  • 不支持竖排文字
  • 目录和列表通过规则进行识别，少部分不常见的列表形式可能无法识别
  • 标题只有一级，目前不支持标题分级
  • 代码块在layout模型里还没有支持
  • 漫画书、艺术图册、小学教材、习题尚不能很好解析
  • 表格识别在复杂表格上可能会出现行/列识别错误
  • 在小语种PDF上，OCR识别可能会出现字符不准确的情况（如拉丁文的重音符号、阿拉伯文易混淆字符等）
  • 部分公式可能会无法在markdown中渲染

FAQ

常见问题

FAQ

All Thanks To Our Contributors

License Information

LICENSE.md

本项目目前采用PyMuPDF以实现高级功能，但因其遵循AGPL协议，可能对某些使用场景构成限制。未来版本迭代中，我们计划探索并替换为许可条款更为宽松的PDF处理库，以提升用户友好度及灵活性。

Acknowledgments

Citation

@misc{wang2024mineruopensourcesolutionprecise,
      title={MinerU: An Open-Source Solution for Precise Document Content Extraction}, 
      author={Bin Wang and Chao Xu and Xiaomeng Zhao and Linke Ouyang and Fan Wu and Zhiyuan Zhao and Rui Xu and Kaiwen Liu and Yuan Qu and Fukai Shang and Bo Zhang and Liqun Wei and Zhihao Sui and Wei Li and Botian Shi and Yu Qiao and Dahua Lin and Conghui He},
      year={2024},
      eprint={2409.18839},
      archivePrefix={arXiv},
      primaryClass={cs.CV},
      url={https://arxiv.org/abs/2409.18839}, 
}

@article{he2024opendatalab,
  title={Opendatalab: Empowering general artificial intelligence with open datasets},
  author={He, Conghui and Li, Wei and Jin, Zhenjiang and Xu, Chao and Wang, Bin and Lin, Dahua},
  journal={arXiv preprint arXiv:2407.13773},
  year={2024}
}

Star History

Star History Chart

Magic-doc

Magic-Doc Fast speed ppt/pptx/doc/docx/pdf extraction tool

Magic-html

Magic-HTML Mixed web page extraction tool

Links