快速入门
如果遇到任何安装问题,请先查询 FAQ
在线体验
官网在线应用
官网在线版功能与客户端一致,界面美观,功能丰富,需要登录使用
基于Gradio的在线demo
基于gradio开发的webui,界面简洁,仅包含核心解析功能,免登录
本地部署
Warning
安装前必看——软硬件环境支持说明
为了确保项目的稳定性和可靠性,我们在开发过程中仅对特定的软硬件环境进行优化和测试。这样当用户在推荐的系统配置上部署和运行项目时,能够获得最佳的性能表现和最少的兼容性问题。
通过集中资源和精力于主线环境,我们团队能够更高效地解决潜在的BUG,及时开发新功能。
在非主线环境中,由于硬件、软件配置的多样性,以及第三方依赖项的兼容性问题,我们无法100%保证项目的完全可用性。因此,对于希望在非推荐环境中使用本项目的用户,我们建议先仔细阅读文档以及FAQ,大多数问题已经在FAQ中有对应的解决方案,除此之外我们鼓励社区反馈问题,以便我们能够逐步扩大支持范围。
| 解析后端 | pipeline | *-auto-engine | *-http-client | ||
|---|---|---|---|---|---|
| hybrid | vlm | hybrid | vlm | ||
| 后端特性 | 兼容性好 | 硬件配置要求较高 | 适用于OpenAI兼容服务器2 | ||
| 精度指标1 | 82+ | 90+ | |||
| 操作系统 | Linux3 / Windows4 / macOS5 | ||||
| 纯CPU平台支持 | ✅ | ❌ | ✅ | ||
| GPU加速支持 | Volta及以后架构GPU或Apple Silicon | 不需要 | |||
| 显存最低要求 | 6GB | 10GB | 8GB | 3GB | |
| 内存要求 | 最低16GB以上,推荐32GB以上 | 8GB | |||
| 磁盘空间要求 | 20GB以上,推荐使用SSD | 2GB | |||
| python版本 | 3.10-3.13 | ||||
1 精度指标为OmniDocBench (v1.5)的End-to-End Evaluation Overall分数,基于MinerU最新版本测试
2 兼容OpenAI API的服务器,如通过vLLM/SGLang/LMDeploy等推理框架部署的本地模型服务器或远程模型服务
3 Linux仅支持2019年及以后发行版
4 由于关键依赖ray未能在windows平台支持Python 3.13,故仅支持至3.10~3.12版本
5 macOS 需使用14.0以上版本
Tip
除以上主流环境与平台外,我们也收录了一些社区用户反馈的其他平台支持情况,详情请参考其他加速卡适配。
如果您有意将自己的环境适配经验分享给社区,欢迎通过show-and-tell提交或提交PR至其他加速卡适配文档。
安装 MinerU
使用pip或uv安装MinerU
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[all]" -i https://mirrors.aliyun.com/pypi/simple
通过源码安装MinerU
git clone https://github.com/opendatalab/MinerU.git
cd MinerU
uv pip install -e .[all] -i https://mirrors.aliyun.com/pypi/simple
Tip
mineru[all]包含所有核心功能,兼容Windows / Linux / macOS系统,适合绝大多数用户。
如果您需要指定vlm模型的推理框架,或是仅准备在边缘设备安装轻量版client端,可以参考文档扩展模块安装指南。
使用docker部署Mineru
MinerU提供了便捷的docker部署方式,这有助于快速搭建环境并解决一些棘手的环境兼容问题。 您可以在文档中获取Docker部署说明。
使用 MinerU
Tip
默认使用托管在huggingface的模型进行解析,首次使用时会自动下载所需模型文件,后续使用将直接加载本地缓存的模型。如果您无法访问huggingface,可以通过以下命令切换至国内镜像源:
export MINERU_MODEL_SOURCE=modelscope
如果您的设备满足上表中GPU加速的条件,可以使用简单的命令行进行文档解析:
mineru -p <input_path> -o <output_path>
pipeline,以在纯CPU环境下运行:
mineru -p <input_path> -o <output_path> -b pipeline
您可以通过命令行、API、WebUI等多种方式使用MinerU进行PDF解析,具体使用方法请参考使用指南。