Skip to content

MinerU 是一款基于人工智能的智能文档解析工具,能够将 PDF 文档转化为机器可读的结构化格式(如 Markdown、JSON 等)。本开源镜像项目由 共绩算力 平台开源,旨在为开发者提供高效、准确的文档内容提取解决方案。

License

Notifications You must be signed in to change notification settings

slmnb-lab/minerU-GONGJI

Repository files navigation

MinerU 开源镜像部署方案

项目概述

MinerU 是一款基于人工智能的智能文档解析工具,能够将 PDF 文档转化为机器可读的结构化格式(如 Markdown、JSON 等)。本开源镜像项目由 共绩算力 平台开源,旨在为开发者提供高效、准确的文档内容提取解决方案。

核心特性

  • 多模态文档理解:支持文本、图像、表格、公式等多种元素的智能识别
  • 高精度解析:基于最新的视觉语言模型,提供业界领先的解析精度
  • 多语言支持:支持 84 种语言的 OCR 识别,覆盖全球主要语言
  • 灵活部署:提供 Docker 容器化部署方案,支持云端和本地部署
  • 开放生态:完全开源,支持自定义扩展和二次开发

镜像设计方案

服务架构

MinerU 采用微服务架构设计,通过 Docker Compose 提供三种核心服务:

  1. SGLang 服务器 (mineru-sglang-server)

    • 提供高性能的 VLM 模型推理服务
    • 支持多 GPU 并行处理和显存优化
    • 端口:30000
  2. API 服务 (mineru-api)

    • 提供 RESTful API 接口
    • 支持同步和异步文档解析请求
    • 端口:8000
  3. Web UI 服务 (mineru-gradio)

    • 提供友好的 Web 用户界面
    • 支持拖拽上传和实时预览
    • 端口:7860

技术栈

  • 后端框架:FastAPI + Gradio
  • AI 模型:自研 VLM 模型 + SGLang 加速引擎
  • 容器化:Docker + Docker Compose
  • GPU 支持:NVIDIA CUDA + 多 GPU 并行
  • 存储:本地文件系统 + 可选 S3 云存储

快速部署

环境要求

  • 操作系统:Linux (推荐 Ubuntu 20.04+)
  • GPU:NVIDIA GPU,8GB+ 显存 (Turing 架构及以上)
  • 内存:32GB+ RAM
  • 存储:50GB+ 可用空间
  • Docker:20.10+ 版本
  • NVIDIA Container Toolkit:已安装并配置

一键部署

# 克隆项目
git clone https://github.com/opendatalab/MinerU.git
cd MinerU

# 启动所有服务
docker-compose --profile api --profile gradio up -d

# 或启动单个服务
docker-compose --profile api up -d        # 仅启动 API 服务
docker-compose --profile gradio up -d     # 仅启动 Web UI 服务
docker-compose --profile sglang-server up -d  # 仅启动 SGLang 服务

服务访问

API 使用指南

同步解析请求

curl -X POST "http://localhost:8000/analyze" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@document.pdf" \
  -F "output_format=markdown"

异步解析请求

# 提交任务
curl -X POST "http://localhost:8000/analyze_async" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@document.pdf" \
  -F "output_format=json"

# 查询任务状态
curl -X GET "http://localhost:8000/status/{task_id}"

支持的输出格式

  • markdown:Markdown 格式,适合文档阅读
  • json:结构化 JSON 格式,适合程序处理
  • middle_json:中间格式,包含丰富的元数据信息

配置优化

GPU 配置

# 多 GPU 并行处理
--dp-size 2  # 数据并行,提升吞吐量
--tp-size 2  # 张量并行,扩展可用显存

# 显存优化
--mem-fraction-static 0.5  # 调整 KV 缓存大小
--enable-torch-compile     # 启用 torch.compile 加速

性能调优

  • 单 GPU 模式:适合显存充足的场景
  • 多 GPU 模式:适合高并发处理场景
  • 显存优化:根据实际显存大小调整参数

监控与维护

健康检查

# 检查服务状态
docker-compose ps

# 查看服务日志
docker-compose logs mineru-api
docker-compose logs mineru-gradio
docker-compose logs mineru-sglang-server

资源监控

  • GPU 使用率:通过 nvidia-smi 监控
  • 内存使用:通过 Docker stats 监控
  • 存储空间:定期清理临时文件

故障排除

常见问题

  1. GPU 显存不足

    • 降低 --mem-fraction-static 参数值
    • 使用更小的批处理大小
  2. 服务启动失败

    • 检查 Docker 和 NVIDIA Container Toolkit 安装
    • 验证 GPU 驱动版本兼容性
  3. 解析速度慢

    • 启用 --enable-torch-compile 加速
    • 使用多 GPU 并行处理

日志分析

# 查看详细错误日志
docker-compose logs --tail=100 mineru-api

# 实时监控日志
docker-compose logs -f mineru-gradio

扩展开发

自定义模型

MinerU 支持自定义模型扩展:

from mineru import MinerU

# 加载自定义模型
mineru = MinerU(
    model_path="/path/to/custom/model",
    device="cuda:0"
)

插件开发

支持开发自定义解析插件:

from mineru.plugins import BasePlugin

class CustomPlugin(BasePlugin):
    def process(self, document):
        # 自定义处理逻辑
        return processed_document

社区支持

许可证

本项目采用 AGPL-3.0 许可证,详情请参考许可证文件。


更新记录

  • 2025/07/28 2.1.8 发布
    • sglang 0.4.9.post5 版本适配
  • 2025/07/27 2.1.7 发布
    • transformers 4.54.0 版本适配
  • 2025/07/26 2.1.6 发布
    • 修复vlm后端解析部分手写文档时的表格异常问题
    • 修复文档旋转时可视化框位置漂移问题 #3175
  • 2025/07/24 2.1.5 发布
    • sglang 0.4.9 版本适配,同步升级dockerfile基础镜像为sglang 0.4.9.post3
  • 2025/07/23 2.1.4 发布
    • bug修复
      • 修复pipeline后端中MFR步骤在某些情况下显存消耗过大的问题 #2771
      • 修复某些情况下image/tablecaption/footnote匹配不准确的问题 #3129
  • 2025/07/16 2.1.1 发布
    • bug修复
      • 修复pipeline在某些情况可能发生的文本块内容丢失问题 #3005
      • 修复sglang-client需要安装torch等不必要的包的问题 #2968
      • 更新dockerfile以修复linux字体缺失导致的解析文本内容不完整问题 #2915
    • 易用性更新
      • 更新compose.yaml,便于用户直接启动sglang-servermineru-apimineru-gradio服务
      • 启用全新的在线文档站点,简化readme,提供更好的文档体验
  • 2025/07/05 2.1.0 发布
    • 这是 MinerU 2 的第一个大版本更新,包含了大量新功能和改进,包含众多性能优化、体验优化和bug修复,具体更新内容如下:
    • 性能优化:
      • 大幅提升某些特定分辨率(长边2000像素左右)文档的预处理速度
      • 大幅提升pipeline后端批量处理大量页数较少(<10)文档时的后处理速度
      • pipeline后端的layout分析速度提升约20%
    • 体验优化:
      • 内置开箱即用的fastapi服务gradio webui,详细使用方法请参考文档
      • sglang适配0.4.8版本,大幅降低vlm-sglang后端的显存要求,最低可在8G显存(Turing及以后架构)的显卡上运行
      • 对所有命令增加sglang的参数透传,使得sglang-engine后端可以与sglang-server一致,接收sglang的所有参数
      • 支持基于配置文件的功能扩展,包含自定义公式标识符开启标题分级功能自定义本地模型目录,详细使用方法请参考文档
    • 新特性:
      • pipeline后端更新 PP-OCRv5 多语种文本识别模型,支持法语、西班牙语、葡萄牙语、俄语、韩语等 37 种语言的文字识别,平均精度涨幅超30%。详情
      • pipeline后端增加对竖排文本的有限支持
历史日志
2025/06/20 2.0.6发布
  • 修复vlm模式下,某些偶发的无效块内容导致解析中断问题
  • 修复vlm模式下,某些不完整的表结构导致的解析中断问题
2025/06/17 2.0.5发布
  • 修复了sglang-client模式下依然需要下载模型的问题
  • 修复了sglang-client模式需要依赖torch等实际运行不需要的包的问题
  • 修复了同一进程内尝试通过多个url启动多个sglang-client实例时,只有第一个生效的问题
2025/06/15 2.0.3发布
  • 修复了当下载模型类型设置为all时,配置文件出现键值更新错误的问题
  • 修复了命令行模式下公式和表格功能开关不生效导致功能无法关闭的问题
  • 修复了sglang-engine模式下,0.4.7版本sglang的兼容性问题
  • 更新了sglang环境下部署完整版MinerU的Dockerfile和相关安装文档
2025/06/13 2.0.0发布
  • 全新架构:MinerU 2.0 在代码结构和交互方式上进行了深度重构,显著提升了系统的易用性、可维护性与扩展能力。
    • 去除第三方依赖限制:彻底移除对 pymupdf 的依赖,推动项目向更开放、合规的开源方向迈进。
    • 开箱即用,配置便捷:无需手动编辑 JSON 配置文件,绝大多数参数已支持命令行或 API 直接设置。
    • 模型自动管理:新增模型自动下载与更新机制,用户无需手动干预即可完成模型部署。
    • 离线部署友好:提供内置模型下载命令,支持完全断网环境下的部署需求。
    • 代码结构精简:移除数千行冗余代码,简化类继承逻辑,显著提升代码可读性与开发效率。
    • 统一中间格式输出:采用标准化的 middle_json 格式,兼容多数基于该格式的二次开发场景,确保生态业务无缝迁移。
  • 全新模型:MinerU 2.0 集成了我们最新研发的小参数量、高性能多模态文档解析模型,实现端到端的高速、高精度文档理解。
    • 小模型,大能力:模型参数不足 1B,却在解析精度上超越传统 72B 级别的视觉语言模型(VLM)。
    • 多功能合一:单模型覆盖多语言识别、手写识别、版面分析、表格解析、公式识别、阅读顺序排序等核心任务。
    • 极致推理速度:在单卡 NVIDIA 4090 上通过 sglang 加速,达到峰值吞吐量超过 10,000 token/s,轻松应对大规模文档处理需求。
    • 在线体验:您可以在MinerU.netHugging Face, 以及ModelScope体验我们的全新VLM模型
  • 不兼容变更说明:为提升整体架构合理性与长期可维护性,本版本包含部分不兼容的变更:
    • Python 包名从 magic-pdf 更改为 mineru,命令行工具也由 magic-pdf 改为 mineru,请同步更新脚本与调用命令。
    • 出于对系统模块化设计与生态一致性的考虑,MinerU 2.0 已不再内置 LibreOffice 文档转换模块。如需处理 Office 文档,建议通过独立部署的 LibreOffice 服务先行转换为 PDF 格式,再进行后续解析操作。
2025/05/24 1.3.12 发布
  • 增加ppocrv5模型的支持,将ch_server模型更新为PP-OCRv5_rec_serverch_lite模型更新为PP-OCRv5_rec_mobile(需更新模型)
    • 在测试中,发现ppocrv5(server)对手写文档效果有一定提升,但在其余类别文档的精度略差于v4_server_doc,因此默认的ch模型保持不变,仍为PP-OCRv4_server_rec_doc
    • 由于ppocrv5强化了手写场景和特殊字符的识别能力,因此您可以在日繁混合场景以及手写文档场景下手动选择使用ppocrv5模型
    • 您可通过lang参数lang='ch_server'(python api)或--lang ch_server(命令行)自行选择相应的模型:
      • chPP-OCRv4_rec_server_doc(默认)(中英日繁混合/1.5w字典)
      • ch_serverPP-OCRv5_rec_server(中英日繁混合+手写场景/1.8w字典)
      • ch_litePP-OCRv5_rec_mobile(中英日繁混合+手写场景/1.8w字典)
      • ch_server_v4PP-OCRv4_rec_server(中英混合/6k字典)
      • ch_lite_v4PP-OCRv4_rec_mobile(中英混合/6k字典)
  • 增加手写文档的支持,通过优化layout对手写文本区域的识别,现已支持手写文档的解析
    • 默认支持此功能,无需额外配置
    • 可以参考上述说明,手动选择ppocrv5模型以获得更好的手写文档解析效果
  • huggingfacemodelscope的demo已更新为支持手写识别和ppocrv5模型的版本,可自行在线体验
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在项目中的使用,解决了paddletorch的冲突问题,和由于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

pdf_zh_cn.mp4

主要功能

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

快速开始

如果安装或使用中遇到任何问题,请先查询 FAQ
如果遇到解析效果不及预期,参考 Known Issues

在线体验

官网在线应用

官网在线版功能与客户端一致,界面美观,功能丰富,需要登录使用

  • OpenDataLab

基于Gradio的在线demo

基于gradio开发的webui,界面简洁,仅包含核心解析功能,免登录

  • ModelScope
  • HuggingFace

本地部署

Warning

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

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

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

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

解析后端 pipeline vlm-transformers vlm-sglang
操作系统 Linux / Windows / macOS Linux / Windows Linux / Windows (via WSL2)
CPU推理支持
GPU要求 Turing及以后架构,6G显存以上或Apple Silicon Turing及以后架构,8G显存以上
内存要求 最低16G以上,推荐32G以上
磁盘空间要求 20G以上,推荐使用SSD
python版本 3.10-3.13

安装 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[core]" -i https://mirrors.aliyun.com/pypi/simple 

通过源码安装MinerU

git clone https://github.com/opendatalab/MinerU.git
cd MinerU
uv pip install -e .[core] -i https://mirrors.aliyun.com/pypi/simple

Tip

mineru[core]包含除sglang加速外的所有核心功能,兼容Windows / Linux / macOS系统,适合绝大多数用户。 如果您有使用sglang加速VLM模型推理,或是在边缘设备安装轻量版client端等需求,可以参考文档扩展模块安装指南


使用docker部署Mineru

MinerU提供了便捷的docker部署方式,这有助于快速搭建环境并解决一些棘手的环境兼容问题。 您可以在文档中获取Docker部署说明


使用 MinerU

最简单的命令行调用方式:

mineru -p <input_path> -o <output_path>

您可以通过命令行、API、WebUI等多种方式使用MinerU进行PDF解析,具体使用方法请参考使用指南

TODO

  • 基于模型的阅读顺序
  • 正文中目录、列表识别
  • 表格识别
  • 标题分级
  • 手写文本识别
  • 竖排文本识别
  • 拉丁字母重音符号识别
  • 正文中代码块识别
  • 化学式识别
  • 图表内容识别

Known Issues

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

FAQ

  • 如果您在使用过程中遇到问题,可以先查看常见问题是否有解答。
  • 如果未能解决您的问题,您也可以使用DeepWiki与AI助手交流,这可以解决大部分常见问题。
  • 如果您仍然无法解决问题,您可通过DiscordWeChat加入社区,与其他用户和开发者交流。

All Thanks To Our Contributors

License Information

LICENSE.md

本项目目前部分模型基于YOLO训练,但因其遵循AGPL协议,可能对某些使用场景构成限制。未来版本迭代中,我们计划探索并替换为许可条款更为宽松的模型,以提升用户友好度及灵活性。

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

Links

About

MinerU 是一款基于人工智能的智能文档解析工具,能够将 PDF 文档转化为机器可读的结构化格式(如 Markdown、JSON 等)。本开源镜像项目由 共绩算力 平台开源,旨在为开发者提供高效、准确的文档内容提取解决方案。

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 53