You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

40 KiB

Raw Blame History Unescape Escape

English | 简体中文

PDF-Extract-Kit: 高质量PDF解析工具箱🔥🔥🔥

更便捷的使用方式：MinerU桌面端。无需编程，无需登录，图形界面，简单交互，畅用无忧。🚀🚀🚀

👋 join us on Discord and WeChat

更新记录

2025/04/29 1.3.10 发布
- 支持使用自定义公式标识符，可通过修改用户目录下的magic-pdf.json文件中的latex-delimiter-config项实现。
2025/04/27 1.3.9 发布
- 优化公式解析功能，提升公式渲染的成功率
2025/04/23 1.3.8 发布
- ocr默认模型(ch)更新为PP-OCRv4_server_rec_doc（需更新模型）
  - PP-OCRv4_server_rec_doc是在PP-OCRv4_server_rec的基础上，在更多中文文档数据和PP-OCR训练数据的混合数据训练而成，增加了部分繁体字、日文、特殊字符的识别能力，可支持识别的字符为1.5万+，除文档相关的文字识别能力提升外，也同时提升了通用文字的识别能力。
  - PP-OCRv4_server_rec_doc/PP-OCRv4_server_rec/PP-OCRv4_mobile_rec 性能对比
  - 经验证，PP-OCRv4_server_rec_doc模型在中英日繁单种语言或多种语言混合场景均有明显精度提升，且速度与PP-OCRv4_server_rec相当，适合绝大部分场景使用。
  - PP-OCRv4_server_rec_doc在小部分纯英文场景可能会发生单词粘连问题，PP-OCRv4_server_rec则在此场景下表现更好，因此我们保留了PP-OCRv4_server_rec模型，用户可通过增加参数lang='ch_server'(python api)或--lang ch_server(命令行)调用。
2025/04/22 1.3.7 发布
- 修复表格解析模型初始化时lang参数失效的问题
- 修复在cpu模式下ocr和表格解析速度大幅下降的问题
2025/04/16 1.3.4 发布
- 通过移除一些无用的块，小幅提升了ocr-det的速度
- 修复部分情况下由footnote导致的页面内排序错误
2025/04/12 1.3.2 发布
- 修复了windows系统下，在python3.13环境安装时一些依赖包版本不兼容的问题
- 优化批量推理时的内存占用
- 优化旋转90度表格的解析效果
- 优化财报样本中超大表格的解析效果
- 修复了在未指定OCR语言时，英文文本区域偶尔出现的单词黏连问题（需要更新模型）
2025/04/08 1.3.1 发布，修复了一些兼容问题
- 支持python 3.13
- 为部分过时的linux系统（如centos7）做出最后适配，并不再保证后续版本的继续支持，安装说明
2025/04/03 1.3.0 发布，在这个版本我们做出了许多优化和改进：
- 安装与兼容性优化
  - 通过移除layout中layoutlmv3的使用，解决了由detectron2导致的兼容问题
  - torch版本兼容扩展到2.2~2.6(2.5除外)
  - cuda兼容支持11.8/12.4/12.6/12.8（cuda版本由torch决定），解决部分用户50系显卡与H系显卡的兼容问题
  - python兼容版本扩展到3.10~3.12，解决了在非3.10环境下安装时自动降级到0.6.1的问题
  - 优化离线部署流程，部署成功后不需要联网下载任何模型文件
- 性能优化
  - 通过支持多个pdf文件的batch处理（脚本样例），提升了批量小文件的解析速度 (与1.0.1版本相比，公式解析速度最高提升超过1400%，整体解析速度最高提升超过500%)
  - 通过优化mfr模型的加载和使用，降低了显存占用并提升了解析速度(需重新执行模型下载流程以获得模型文件的增量更新)
  - 优化显存占用，最低仅需6GB即可运行本项目
  - 优化了在mps设备上的运行速度
- 解析效果优化
  - mfr模型更新到unimernet(2503)，解决多行公式中换行丢失的问题
- 易用性优化
  - 通过使用paddleocr2torch，完全替代paddle框架以及paddleocr在项目中的使用，解决了paddle和torch的冲突问题，和由于paddle框架导致的线程不安全问题
  - 解析过程增加实时进度条显示，精准把握解析进度，让等待不再痛苦

2025/03/03 1.2.1 发布，修复了一些问题

修复在字母与数字的全角转半角操作时对标点符号的影响
修复在某些情况下caption的匹配不准确问题
修复在某些情况下的公式span丢失问题

2025/02/24 1.2.0 发布，这个版本我们修复了一些问题，提升了解析的效率与精度：

性能优化
- auto模式下pdf文档的分类速度提升
解析优化
- 优化对包含水印文档的解析逻辑，显著提升包含水印文档的解析效果
- 改进了单页内多个图像/表格与caption的匹配逻辑，提升了复杂布局下图文匹配的准确性
问题修复
- 修复在某些情况下图片/表格span被填充进textblock导致的异常
- 修复在某些情况下标题block为空的问题

2025/01/22 1.1.0 发布，在这个版本我们重点提升了解析的精度与效率：

模型能力升级（需重新执行模型下载流程以获得模型文件的增量更新）
- 布局识别模型升级到最新的 `doclayout_yolo(2501)` 模型，提升了layout识别精度
- 公式解析模型升级到最新的 `unimernet(2501)` 模型，提升了公式识别精度
性能优化
- 在配置满足一定条件（显存16GB+）的设备上，通过优化资源占用和重构处理流水线，整体解析速度提升50%以上
解析效果优化
- 在线demo（mineru.net / huggingface / modelscope）上新增标题分级功能（测试版本，默认开启），支持对标题进行分级，提升文档结构化程度

2025/01/10 1.0.1 发布这是我们的第一个正式版本在这个版本中我们通过大量重构带来了全新的API接口和更广泛的兼容性以及全新的自动语言识别功能

全新API接口
- 对于数据侧API，我们引入了Dataset类，旨在提供一个强大而灵活的数据处理框架。该框架当前支持包括图像（.jpg及.png）、PDF、Word（.doc及.docx）、以及PowerPoint（.ppt及.pptx）在内的多种文档格式，确保了从简单到复杂的数据处理任务都能得到有效的支持。
- 针对用户侧API，我们将MinerU的处理流程精心设计为一系列可组合的Stage阶段。每个Stage代表了一个特定的处理步骤，用户可以根据自身需求自由地定义新的Stage，并通过创造性地组合这些阶段来定制专属的数据处理流程。
更广泛的兼容性适配
- 通过优化依赖环境和配置项，确保在ARM架构的Linux系统上能够稳定高效运行。
- 深度适配华为昇腾NPU加速，积极响应信创要求，提供自主可控的高性能计算能力，助力人工智能应用平台的国产化应用与发展。 NPU加速教程
自动语言识别
- 通过引入全新的语言识别模型，在文档解析中将 `lang` 配置为 `auto`，即可自动选择合适的OCR语言模型，提升扫描类文档解析的准确性。

2024/11/22 0.10.0发布通过引入混合OCR文本提取能力

在公式密集、span区域不规范、部分文本使用图像表现等复杂文本分布场景下获得解析效果的显著提升
同时具备文本模式内容提取准确、速度更快与OCR模式span/line区域识别更准的双重优势

2024/11/15 0.9.3发布，为表格识别功能接入了RapidTable,单表解析速度提升10倍以上准确率更高显存占用更低

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 首次开源

MinerU

项目简介

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

https://github.com/user-attachments/assets/4bea02c9-6d54-4cd6-97ed-dff14340982c

主要功能

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

快速开始

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

在线体验(无需任何安装)
使用CPU快速体验（Windows，Linux，Mac）
使用 CUDA/CANN/MPS 加速推理

[!WARNING] 安装前必看——软硬件环境支持说明

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

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

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

操作系统
		Linux after 2019	Windows 10 / 11	macOS 11+
CPU		x86_64 / arm64	x86_64(暂不支持ARM Windows)	x86_64 / arm64
内存		大于等于16GB，推荐32G以上
存储空间		大于等于20GB，推荐使用SSD以获得最佳性能
python版本		3.10~3.13
Nvidia Driver 版本		latest(专有驱动)	latest	None
CUDA环境		Refer to the PyTorch official website		None
CANN环境(NPU支持)		8.0+(Ascend 910b)	None	None
GPU/MPS 硬件支持列表	显存6G以上	Volta(2017)及之后生产的全部带Tensor Core的GPU 6G显存及以上		Apple silicon

在线体验

同步dev分支更新：

使用CPU快速体验

1. 安装magic-pdf

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

conda create -n mineru 'python=3.12' -y
conda activate mineru
pip install -U "magic-pdf[full]" -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": "doclayout_yolo" 
    },
    "formula-config": {
        "mfd_model": "yolo_v8_mfd",
        "mfr_model": "unimernet_small",
        "enable": true  // 公式识别功能默认是开启的，如果需要关闭请修改此处的值为"false"
    },
    "table-config": {
        "model": "rapid_table",
        "sub_model": "slanet_plus",
        "enable": true, // 表格识别功能默认是开启的，如果需要关闭请修改此处的值为"false"
        "max_time": 400
    }
}

使用GPU

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

Ubuntu22.04LTS + GPU
Windows10/11 + GPU
使用Docker快速部署

[!IMPORTANT] Docker 需设备gpu显存大于等于6GB，默认开启所有加速功能

运行本docker前可以通过以下命令检测自己的设备是否支持在docker上使用CUDA加速
docker run --rm --gpus=all nvidia/cuda:12.1.0-base-ubuntu22.04 nvidia-smi

wget https://gcore.jsdelivr.net/gh/opendatalab/MinerU@master/docker/china/Dockerfile -O Dockerfile
docker build -t mineru:latest .
docker run -it --name mineru --gpus=all mineru:latest /bin/bash -c "echo 'source /opt/mineru_venv/bin/activate' >> ~/.bashrc && exec bash"
magic-pdf --help

使用NPU

如果您的设备存在NPU加速硬件，则可以通过以下教程使用NPU加速：

NPU加速教程

使用MPS

如果您的设备使用Apple silicon 芯片，您可以开启mps加速：

您可以通过在 magic-pdf.json 配置文件中将 device-mode 参数设置为 mps 来启用 MPS 加速。

{
    // other config
    "device-mode": "mps"
}

使用

命令行

通过命令行使用MinerU

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

API

通过Python代码调用MinerU

部署衍生项目

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

二次开发

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

Magic-doc

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

Magic-html

Magic-HTML Mixed web page extraction tool

40 KiB Raw Blame History Unescape Escape