vlm模式下,某些偶发的无效块内容导致解析中断问题vlm模式下,某些不完整的表结构导致的解析中断问题sglang-client模式下依然需要下载模型的问题sglang-client模式需要依赖torch等实际运行不需要的包的问题sglang-client实例时,只有第一个生效的问题all时,配置文件出现键值更新错误的问题sglang-engine模式下,0.4.7版本sglang的兼容性问题pymupdf 的依赖,推动项目向更开放、合规的开源方向迈进。middle_json 格式,兼容多数基于该格式的二次开发场景,确保生态业务无缝迁移。magic-pdf 更改为 mineru,命令行工具也由 magic-pdf 改为 mineru,请同步更新脚本与调用命令。ch_server模型更新为PP-OCRv5_rec_server,ch_lite模型更新为PP-OCRv5_rec_mobile(需更新模型)
PP-OCRv4_server_rec_doc。lang='ch_server'(python api)或--lang ch_server(命令行)自行选择相应的模型:
ch :PP-OCRv4_rec_server_doc(默认)(中英日繁混合/1.5w字典)ch_server :PP-OCRv5_rec_server(中英日繁混合+手写场景/1.8w字典)ch_lite :PP-OCRv5_rec_mobile(中英日繁混合+手写场景/1.8w字典)ch_server_v4 :PP-OCRv4_rec_server(中英混合/6k字典)ch_lite_v4 :PP-OCRv4_rec_mobile(中英混合/6k字典)huggingface和modelscope的demo已更新为支持手写识别和ppocrv5模型的版本,可自行在线体验magic-pdf.json文件中的latex-delimiter-config项实现。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_server_rec_doc在小部分纯英文场景可能会发生单词粘连问题,PP-OCRv4_server_rec则在此场景下表现更好,因此我们保留了PP-OCRv4_server_rec模型,用户可通过增加参数lang='ch_server'(python api)或--lang ch_server(命令行)调用。cpu模式下ocr和表格解析速度大幅下降的问题layoutlmv3的使用,解决了由detectron2导致的兼容问题unimernet(2503),解决多行公式中换行丢失的问题paddleocr2torch,完全替代paddle框架以及paddleocr在项目中的使用,解决了paddle和torch的冲突问题,和由于paddle框架导致的线程不安全问题MinerU是一款将PDF转化为机器可读格式的工具(如markdown、json),可以很方便地抽取为任意格式。 MinerU诞生于书生-浦语的预训练过程中,我们将会集中精力解决科技文献中的符号转化问题,希望在大模型时代为科技发展做出贡献。 相比国内外知名商用产品MinerU还很年轻,如果遇到问题或者结果不及预期请到issue提交问题,同时附上相关PDF。
https://github.com/user-attachments/assets/4bea02c9-6d54-4cd6-97ed-dff14340982c
如果遇到任何安装问题,请先查询 FAQ
如果遇到解析效果不及预期,参考 Known Issues
有2种不同方式可以体验MinerU的效果:
[!WARNING] 安装前必看——软硬件环境支持说明
为了确保项目的稳定性和可靠性,我们在开发过程中仅对特定的软硬件环境进行优化和测试。这样当用户在推荐的系统配置上部署和运行项目时,能够获得最佳的性能表现和最少的兼容性问题。
通过集中资源和精力于主线环境,我们团队能够更高效地解决潜在的BUG,及时开发新功能。
在非主线环境中,由于硬件、软件配置的多样性,以及第三方依赖项的兼容性问题,我们无法100%保证项目的完全可用性。因此,对于希望在非推荐环境中使用本项目的用户,我们建议先仔细阅读文档以及FAQ,大多数问题已经在FAQ中有对应的解决方案,除此之外我们鼓励社区反馈问题,以便我们能够逐步扩大支持范围。
| 解析后端 | pipeline | vlm-transformers | vlm-sgslang |
| 操作系统 | windows/linux/mac | windows/linux | windows(wsl2)/linux |
| 内存要求 | 最低16G以上,推荐32G以上 | ||
| 磁盘空间要求 | 20G以上,推荐使用SSD | ||
| python版本 | 3.10-3.13 | ||
| CPU推理支持 | ✅ | ❌ | ❌ |
| GPU要求 | Turing及以后架构,6G显存以上或Apple Silicon | Ampere及以后架构,8G显存以上 | Ampere及以后架构,24G显存及以上 |
pip install --upgrade pip -i https://mirrors.aliyun.com/pypi/simple
pip install uv -i https://mirrors.aliyun.com/pypi/simple
uv pip install -U "mineru[core]" -i https://mirrors.aliyun.com/pypi/simple
git clone https://github.com/opendatalab/MinerU.git
cd MinerU
uv pip install -e .[core] -i https://mirrors.aliyun.com/pypi/simple
[!TIP] Linux和macOS系统安装后自动支持cuda/mps加速,Windows用户如需使用cuda加速, 请前往 Pytorch官网 选择合适的cuda版本安装pytorch。
如需使用 sglang 加速 VLM 模型推理,请选择合适的方式安装完整版本:
uv pip install -U "mineru[all]" -i https://mirrors.aliyun.com/pypi/simple
uv pip install -e .[all] -i https://mirrors.aliyun.com/pypi/simple
启动 Docker 容器:wget https://gcore.jsdelivr.net/gh/opendatalab/MinerU@master/docker/china/Dockerfile docker build -t mineru-sglang:latest -f Dockerfile .
或使用 Docker Compose 启动:docker run --gpus all \ --shm-size 32g \ -p 30000:30000 \ --ipc=host \ mineru-sglang:latest \ mineru-sglang-server --host 0.0.0.0 --port 30000
wget https://gcore.jsdelivr.net/gh/opendatalab/MinerU@master/docker/compose.yaml docker compose -f compose.yaml up -d
[!TIP] Dockerfile默认使用
lmsysorg/sglang:v0.4.7-cu124作为基础镜像,如有需要,您可以自行修改为其他平台版本。
uv pip install -U mineru -i https://mirrors.aliyun.com/pypi/simple mineru -p <input_path> -o <output_path> -b vlm-sglang-client -u http://<host_ip>:<port>
最简单的命令行调用方式如下:
mineru -p <input_path> -o <output_path>
<input_path>:本地 PDF 文件或目录(支持 pdf/png/jpg/jpeg)<output_path>:输出目录获取所有可用参数说明:
mineru --help
Usage: mineru [OPTIONS] Options: -v, --version 显示版本并退出 -p, --path PATH 输入文件路径或目录(必填) -o, --output PATH 输出目录(必填) -m, --method [auto|txt|ocr] 解析方法:auto(默认)、txt、ocr(仅用于 pipeline 后端) -b, --backend [pipeline|vlm-transformers|vlm-sglang-engine|vlm-sglang-client] 解析后端(默认为 pipeline) -l, --lang [ch|ch_server|... ] 指定文档语言(可提升 OCR 准确率,仅用于 pipeline 后端) -u, --url TEXT 当使用 sglang-client 时,需指定服务地址 -s, --start INTEGER 开始解析的页码(从 0 开始) -e, --end INTEGER 结束解析的页码(从 0 开始) -f, --formula BOOLEAN 是否启用公式解析(默认开启,仅 pipeline 后端) -t, --table BOOLEAN 是否启用表格解析(默认开启,仅 pipeline 后端) -d, --device TEXT 推理设备(如 cpu/cuda/cuda:0/npu/mps,仅 pipeline 后端) --vram INTEGER 单进程最大 GPU 显存占用(仅 pipeline 后端) --source [huggingface|modelscope|local] 模型来源,默认 huggingface --help 显示帮助信息
MinerU 默认在首次运行时自动从 HuggingFace 下载所需模型。若无法访问 HuggingFace,可通过以下方式切换模型源:
mineru -p <input_path> -o <output_path> --source modelscope
或设置环境变量:
export MINERU_MODEL_SOURCE=modelscope
mineru -p <input_path> -o <output_path>
mineru-models-download --help
或使用交互式命令行工具选择模型下载:
mineru-models-download
下载完成后,模型路径会在当前终端窗口输出,并自动写入用户目录下的 mineru.json。
mineru -p <input_path> -o <output_path> --source local
或通过环境变量启用:
export MINERU_MODEL_SOURCE=local
mineru -p <input_path> -o <output_path>
mineru -p <input_path> -o <output_path> -b vlm-sglang-engine
mineru-sglang-server --port 30000
[!TIP] sglang加速需设备有Ampere及以后架构,24G显存及以上显卡,如您有两张12G或16G显卡,可以通过张量并行(TP)模式使用:
mineru-sglang-server --port 30000 --tp 2如使用两张卡仍出现显存不足错误或需要使用多卡并行增加吞吐量或推理速度,请参考 sglang官方文档
mineru -p <input_path> -o <output_path> -b vlm-sglang-client -u http://127.0.0.1:30000
[!TIP] 更多关于输出文件的信息,请参考 输出文件说明
您也可以通过 Python 代码调用 MinerU,示例代码请参考: 👉 Python 调用示例
社区开发者基于 MinerU 进行了多种二次开发,包括:
这些项目通常提供更好的用户体验和更多功能。
详细部署方式请参阅: 👉 衍生项目说明
本项目目前部分模型基于YOLO训练,但因其遵循AGPL协议,可能对某些使用场景构成限制。未来版本迭代中,我们计划探索并替换为许可条款更为宽松的模型,以提升用户友好度及灵活性。
@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} }
Magic-Doc Fast speed ppt/pptx/doc/docx/pdf extraction tool
Magic-HTML Mixed web page extraction tool