快速入门
文档解析是困难且复杂的任务，尤其是对于复杂版面、扫描件、手写体等场景，解析结果可能不尽如人意。我们建议您先在线体验评估 MinerU 的解析效果和适用性，再根据实际需求选择合适的部署方式。 如果您有解析效果不佳的文档样例，欢迎提交上传到 issue，我们会持续优化解析能力。 如果遇到任何安装问题，请先查询 FAQ
在线体验
官网在线应用
官网在线版功能与客户端一致，界面美观，功能丰富，需要登录使用
基于Gradio的在线demo
基于gradio开发的webui，界面简洁，仅包含核心解析功能，免登录
本地部署
[!WARNING] 安装前必看——软硬件环境支持说明
为了确保项目的稳定性和可靠性，我们在开发过程中仅对特定的软硬件环境进行优化和测试。这样当用户在推荐的系统配置上部署和运行项目时，能够获得最佳的性能表现和最少的兼容性问题。
通过集中资源和精力于主线环境，我们团队能够更高效地解决潜在的BUG，及时开发新功能。
在非主线环境中，由于硬件、软件配置的多样性，以及第三方依赖项的兼容性问题，我们无法100%保证项目的完全可用性。因此，对于希望在非推荐环境中使用本项目的用户，我们建议先仔细阅读文档以及FAQ，大多数问题已经在FAQ中有对应的解决方案，除此之外我们鼓励社区反馈问题，以便我们能够逐步扩大支持范围。
1 精度指标为OmniDocBench (v1.6)的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系统，适合绝大多数用户。- 如果您在 Windows 上安装后无法使用 CUDA 加速，请参考 Windows CUDA 加速 FAQ。
- 如果您需要指定vlm模型的推理框架，或是仅准备在边缘设备安装轻量版client端，可以参考文档扩展模块安装指南。
使用docker部署Mineru
MinerU提供了便捷的docker部署方式，这有助于快速搭建环境并解决一些棘手的环境兼容问题。
[!TIP]
- Docker 部署仅适用于 Linux，以及支持 WSL2 的 Windows 环境；
- macOS 用户请直接参考前面两种方式部署安装，不要使用 Docker 部署。
您可以在文档中获取Docker部署说明。
使用 MinerU
[!TIP] 默认使用托管在
huggingface的模型进行解析，首次使用时会自动下载所需模型文件，后续使用将直接加载本地缓存的模型。如果您无法访问huggingface，可以通过以下命令切换至国内镜像源:export MINERU_MODEL_SOURCE=modelscope
如果您的设备满足上表中GPU加速的条件，可以使用简单的命令行进行文档解析:
mineru -p <input_path> -o <output_path>
如果您的设备不满足GPU加速条件，可以指定后端为pipeline，以在纯CPU环境下运行:
mineru -p <input_path> -o <output_path> -b pipeline
当前 mineru 支持本地 PDF / 图片 / DOCX / PPTX / XLSX 文件或目录输入。
您可以通过命令行、API、WebUI 等多种方式使用 MinerU 进行文档解析，具体使用方法请参考使用指南。
Source: docs/zh/quick_start/index.md