-
-
- 
-
-
-
-
-[](https://github.com/opendatalab/MinerU)
-[](https://github.com/opendatalab/MinerU)
-[](https://github.com/opendatalab/MinerU/issues)
-[](https://github.com/opendatalab/MinerU/issues)
-[](https://pypi.org/project/mineru/)
-[](https://pypi.org/project/mineru/)
-[](https://pepy.tech/project/mineru)
-[](https://pepy.tech/project/mineru)
-[](https://mineru.net/OpenSourceTools/Extractor?source=github)
-[](https://huggingface.co/spaces/opendatalab/MinerU)
-[](https://www.modelscope.cn/studios/OpenDataLab/MinerU)
-[](https://colab.research.google.com/gist/myhloli/3b3a00a4a0a61577b6c30f989092d20d/mineru_demo.ipynb)
-[](https://arxiv.org/abs/2409.18839)
-[](https://deepwiki.com/opendatalab/MinerU)
-
-
-
-
-
-
-[English](README.md) | [简体中文](README_zh-CN.md)
-
-
-
-
-🚀Access MinerU Now→✅ Zero-Install Web Version ✅ Full-Featured Desktop Client ✅ Instant API Access; Skip deployment headaches – get all product formats in one click. Developers, dive in!
-
-
-
-
-
- 👋 join us on Discord and WeChat
-
-
-
- History Log
-
- 2025/06/20 2.0.6 Released
-
- - Fixed occasional parsing interruptions caused by invalid block content in
vlm mode
- - Fixed parsing interruptions caused by incomplete table structures in
vlm mode
-
-
-
-
- 2025/06/17 2.0.5 Released
-
- - Fixed the issue where models were still required to be downloaded in the
sglang-client mode
- - Fixed the issue where the
sglang-client mode unnecessarily depended on packages like torch during runtime.
- - Fixed the issue where only the first instance would take effect when attempting to launch multiple
sglang-client instances via multiple URLs within the same process
-
-
-
-
- 2025/06/15 2.0.3 released
-
- - Fixed a configuration file key-value update error that occurred when downloading model type was set to
all
- - Fixed the issue where the formula and table feature toggle switches were not working in
command line mode, causing the features to remain enabled.
- - Fixed compatibility issues with sglang version 0.4.7 in the
sglang-engine mode.
- - Updated Dockerfile and installation documentation for deploying the full version of MinerU in sglang environment
-
-
-
-
- 2025/06/13 2.0.0 Released
-
- - New Architecture: MinerU 2.0 has been deeply restructured in code organization and interaction methods, significantly improving system usability, maintainability, and extensibility.
-
- - Removal of Third-party Dependency Limitations: Completely eliminated the dependency on
pymupdf, moving the project toward a more open and compliant open-source direction.
- - Ready-to-use, Easy Configuration: No need to manually edit JSON configuration files; most parameters can now be set directly via command line or API.
- - Automatic Model Management: Added automatic model download and update mechanisms, allowing users to complete model deployment without manual intervention.
- - Offline Deployment Friendly: Provides built-in model download commands, supporting deployment requirements in completely offline environments.
- - Streamlined Code Structure: Removed thousands of lines of redundant code, simplified class inheritance logic, significantly improving code readability and development efficiency.
- - Unified Intermediate Format Output: Adopted standardized
middle_json format, compatible with most secondary development scenarios based on this format, ensuring seamless ecosystem business migration.
-
-
- - New Model: MinerU 2.0 integrates our latest small-parameter, high-performance multimodal document parsing model, achieving end-to-end high-speed, high-precision document understanding.
-
- - Small Model, Big Capabilities: With parameters under 1B, yet surpassing traditional 72B-level vision-language models (VLMs) in parsing accuracy.
- - Multiple Functions in One: A single model covers multilingual recognition, handwriting recognition, layout analysis, table parsing, formula recognition, reading order sorting, and other core tasks.
- - Ultimate Inference Speed: Achieves peak throughput exceeding 10,000 tokens/s through
sglang acceleration on a single NVIDIA 4090 card, easily handling large-scale document processing requirements.
- - Online Experience: You can experience our brand-new VLM model on MinerU.net, Hugging Face, and ModelScope.
-
-
- - Incompatible Changes Notice: To improve overall architectural rationality and long-term maintainability, this version contains some incompatible changes:
-
- - Python package name changed from
magic-pdf to mineru, and the command-line tool changed from magic-pdf to mineru. Please update your scripts and command calls accordingly.
- - For modular system design and ecosystem consistency considerations, MinerU 2.0 no longer includes the LibreOffice document conversion module. If you need to process Office documents, we recommend converting them to PDF format through an independently deployed LibreOffice service before proceeding with subsequent parsing operations.
-
-
-
-
-
- 2025/05/24 Release 1.3.12
-
- - Added support for PPOCRv5 models, updated
ch_server model to PP-OCRv5_rec_server, and ch_lite model to PP-OCRv5_rec_mobile (model update required)
-
- - In testing, we found that PPOCRv5(server) has some improvement for handwritten documents, but has slightly lower accuracy than v4_server_doc for other document types, so the default ch model remains unchanged as
PP-OCRv4_server_rec_doc.
- - Since PPOCRv5 has enhanced recognition capabilities for handwriting and special characters, you can manually choose the PPOCRv5 model for Japanese-Traditional Chinese mixed scenarios and handwritten documents
- - You can select the appropriate model through the lang parameter
lang='ch_server' (Python API) or --lang ch_server (command line):
-
- ch: PP-OCRv4_server_rec_doc (default) (Chinese/English/Japanese/Traditional Chinese mixed/15K dictionary)ch_server: PP-OCRv5_rec_server (Chinese/English/Japanese/Traditional Chinese mixed + handwriting/18K dictionary)ch_lite: PP-OCRv5_rec_mobile (Chinese/English/Japanese/Traditional Chinese mixed + handwriting/18K dictionary)ch_server_v4: PP-OCRv4_rec_server (Chinese/English mixed/6K dictionary)ch_lite_v4: PP-OCRv4_rec_mobile (Chinese/English mixed/6K dictionary)
-
-
-
- - Added support for handwritten documents through optimized layout recognition of handwritten text areas
-
- - This feature is supported by default, no additional configuration required
- - You can refer to the instructions above to manually select the PPOCRv5 model for better handwritten document parsing results
-
-
- - The
huggingface and modelscope demos have been updated to versions that support handwriting recognition and PPOCRv5 models, which you can experience online
-
-
-
-
- 2025/04/29 Release 1.3.10
-
- - Added support for custom formula delimiters, which can be configured by modifying the
latex-delimiter-config section in the magic-pdf.json file in your user directory.
-
-
-
-
- 2025/04/27 Release 1.3.9
-
- - Optimized formula parsing functionality, improved formula rendering success rate
-
-
-
-
- 2025/04/23 Release 1.3.8
-
- - The default
ocr model (ch) has been updated to PP-OCRv4_server_rec_doc (model update required)
-
- PP-OCRv4_server_rec_doc is trained on a mixture of more Chinese document data and PP-OCR training data based on PP-OCRv4_server_rec, adding recognition capabilities for some traditional Chinese characters, Japanese, and special characters. It can recognize over 15,000 characters and improves both document-specific and general text recognition abilities.- Performance comparison of PP-OCRv4_server_rec_doc/PP-OCRv4_server_rec/PP-OCRv4_mobile_rec
- - After verification, the
PP-OCRv4_server_rec_doc model shows significant accuracy improvements in Chinese/English/Japanese/Traditional Chinese in both single language and mixed language scenarios, with comparable speed to PP-OCRv4_server_rec, making it suitable for most use cases.
- - In some pure English scenarios,
PP-OCRv4_server_rec_doc may have word adhesion issues, while PP-OCRv4_server_rec performs better in these cases. Therefore, we've kept the PP-OCRv4_server_rec model, which users can access by adding the parameter lang='ch_server' (Python API) or --lang ch_server (command line).
-
-
-
-
-
-
- 2025/04/22 Release 1.3.7
-
- - Fixed the issue where the lang parameter was ineffective during table parsing model initialization
- - Fixed the significant speed reduction of OCR and table parsing in
cpu mode
-
-
-
-
- 2025/04/16 Release 1.3.4
-
- - Slightly improved OCR-det speed by removing some unnecessary blocks
- - Fixed page-internal sorting errors caused by footnotes in certain cases
-
-
-
-
- 2025/04/12 Release 1.3.2
-
- - Fixed dependency version incompatibility issues when installing on Windows with Python 3.13
- - Optimized memory usage during batch inference
- - Improved parsing of tables rotated 90 degrees
- - Enhanced parsing of oversized tables in financial report samples
- - Fixed the occasional word adhesion issue in English text areas when OCR language is not specified (model update required)
-
-
-
-
- 2025/04/08 Release 1.3.1
-
- - Fixed several compatibility issues
-
- - Added support for Python 3.13
- - Made final adaptations for outdated Linux systems (such as CentOS 7) with no guarantee of continued support in future versions, installation instructions
-
-
-
-
-
-
- 2025/04/03 Release 1.3.0
-
- - Installation and compatibility optimizations
-
- - Resolved compatibility issues caused by
detectron2 by removing layoutlmv3 usage in layout
- - Extended torch version compatibility to 2.2~2.6 (excluding 2.5)
- - Added CUDA compatibility for versions 11.8/12.4/12.6/12.8 (CUDA version determined by torch), solving compatibility issues for users with 50-series and H-series GPUs
- - Extended Python compatibility to versions 3.10~3.12, fixing the issue of automatic downgrade to version 0.6.1 when installing in non-3.10 environments
- - Optimized offline deployment process, eliminating the need to download any model files after successful deployment
-
-
- - Performance optimizations
-
- - Enhanced parsing speed for batches of small files by supporting batch processing of multiple PDF files (script example), with formula parsing speed improved by up to 1400% and overall parsing speed improved by up to 500% compared to version 1.0.1
- - Reduced memory usage and improved parsing speed by optimizing MFR model loading and usage (requires re-running the model download process to get incremental updates to model files)
- - Optimized GPU memory usage, requiring only 6GB minimum to run this project
- - Improved running speed on MPS devices
-
-
- - Parsing effect optimizations
-
- - Updated MFR model to
unimernet(2503), fixing line break loss issues in multi-line formulas
-
-
- - Usability optimizations
-
- - Completely replaced the
paddle framework and paddleocr in the project by using paddleocr2torch, resolving conflicts between paddle and torch, as well as thread safety issues caused by the paddle framework
- - Added real-time progress bar display during parsing, allowing precise tracking of parsing progress and making the waiting process more bearable
-
-
-
-
-
- 2025/03/03 1.2.1 released
-
- - Fixed the impact on punctuation marks during full-width to half-width conversion of letters and numbers
- - Fixed caption matching inaccuracies in certain scenarios
- - Fixed formula span loss issues in certain scenarios
-
-
-
-
- 2025/02/24 1.2.0 released
- This version includes several fixes and improvements to enhance parsing efficiency and accuracy:
-
- - Performance Optimization
-
- - Increased classification speed for PDF documents in auto mode.
-
-
- - Parsing Optimization
-
- - Improved parsing logic for documents containing watermarks, significantly enhancing the parsing results for such documents.
- - Enhanced the matching logic for multiple images/tables and captions within a single page, improving the accuracy of image-text matching in complex layouts.
-
-
- - Bug Fixes
-
- - Fixed an issue where image/table spans were incorrectly filled into text blocks under certain conditions.
- - Resolved an issue where title blocks were empty in some cases.
-
-
-
-
-
-
- 2025/01/22 1.1.0 released
- In this version we have focused on improving parsing accuracy and efficiency:
-
- - Model capability upgrade (requires re-executing the model download process to obtain incremental updates of model files)
-
- - The layout recognition model has been upgraded to the latest
doclayout_yolo(2501) model, improving layout recognition accuracy.
- - The formula parsing model has been upgraded to the latest
unimernet(2501) model, improving formula recognition accuracy.
-
-
- - Performance optimization
-
- - On devices that meet certain configuration requirements (16GB+ VRAM), by optimizing resource usage and restructuring the processing pipeline, overall parsing speed has been increased by more than 50%.
-
-
- - Parsing effect optimization
-
- - Added a new heading classification feature (testing version, enabled by default) to the online demo (mineru.net/huggingface/modelscope), which supports hierarchical classification of headings, thereby enhancing document structuring.
-
-
-
-
-
-
- 2025/01/10 1.0.1 released
- This is our first official release, where we have introduced a completely new API interface and enhanced compatibility through extensive refactoring, as well as a brand new automatic language identification feature:
-
- - New API Interface
-
- - For the data-side API, we have introduced the Dataset class, designed to provide a robust and flexible data processing framework. This framework currently supports a variety of document formats, including images (.jpg and .png), PDFs, Word documents (.doc and .docx), and PowerPoint presentations (.ppt and .pptx). It ensures effective support for data processing tasks ranging from simple to complex.
- - For the user-side API, we have meticulously designed the MinerU processing workflow as a series of composable Stages. Each Stage represents a specific processing step, allowing users to define new Stages according to their needs and creatively combine these stages to customize their data processing workflows.
-
-
- - Enhanced Compatibility
-
- - By optimizing the dependency environment and configuration items, we ensure stable and efficient operation on ARM architecture Linux systems.
- - We have deeply integrated with Huawei Ascend NPU acceleration, providing autonomous and controllable high-performance computing capabilities. This supports the localization and development of AI application platforms in China. Ascend NPU Acceleration
-
-
- - Automatic Language Identification
-
- - By introducing a new language recognition model, setting the
lang configuration to auto during document parsing will automatically select the appropriate OCR language model, improving the accuracy of scanned document parsing.
-
-
-
-
-
-
- 2024/11/22 0.10.0 released
- Introducing hybrid OCR text extraction capabilities:
-
- - Significantly improved parsing performance in complex text distribution scenarios such as dense formulas, irregular span regions, and text represented by images.
- - Combines the dual advantages of accurate content extraction and faster speed in text mode, and more precise span/line region recognition in OCR mode.
-
-
-
-
- 2024/11/15 0.9.3 released
- Integrated RapidTable for table recognition, improving single-table parsing speed by more than 10 times, with higher accuracy and lower GPU memory usage.
-
-
-
- 2024/11/06 0.9.2 released
- Integrated the StructTable-InternVL2-1B model for table recognition functionality.
-
-
-
- 2024/10/31 0.9.0 released
- This is a major new version with extensive code refactoring, addressing numerous issues, improving performance, reducing hardware requirements, and enhancing usability:
-
- - Refactored the sorting module code to use layoutreader for reading order sorting, ensuring high accuracy in various layouts.
- - Refactored the paragraph concatenation module to achieve good results in cross-column, cross-page, cross-figure, and cross-table scenarios.
- - Refactored the list and table of contents recognition functions, significantly improving the accuracy of list blocks and table of contents blocks, as well as the parsing of corresponding text paragraphs.
- - Refactored the matching logic for figures, tables, and descriptive text, greatly enhancing the accuracy of matching captions and footnotes to figures and tables, and reducing the loss rate of descriptive text to near zero.
- - Added multi-language support for OCR, supporting detection and recognition of 84 languages. For the list of supported languages, see OCR Language Support List.
- - Added memory recycling logic and other memory optimization measures, significantly reducing memory usage. The memory requirement for enabling all acceleration features except table acceleration (layout/formula/OCR) has been reduced from 16GB to 8GB, and the memory requirement for enabling all acceleration features has been reduced from 24GB to 10GB.
- - Optimized configuration file feature switches, adding an independent formula detection switch to significantly improve speed and parsing results when formula detection is not needed.
- - Integrated PDF-Extract-Kit 1.0:
-
- - Added the self-developed
doclayout_yolo model, which speeds up processing by more than 10 times compared to the original solution while maintaining similar parsing effects, and can be freely switched with layoutlmv3 via the configuration file.
- - Upgraded formula parsing to
unimernet 0.2.1, improving formula parsing accuracy while significantly reducing memory usage.
- - Due to the repository change for
PDF-Extract-Kit 1.0, you need to re-download the model. Please refer to How to Download Models for detailed steps.
-
-
-
-
-
-
- 2024/09/27 Version 0.8.1 released
- Fixed some bugs, and providing a localized deployment version of the online demo and the front-end interface.
-
-
-
- 2024/09/09 Version 0.8.0 released
- Supporting fast deployment with Dockerfile, and launching demos on Huggingface and Modelscope.
-
-
-
- 2024/08/30 Version 0.7.1 released
- Add paddle tablemaster table recognition option
-
-
-
- 2024/08/09 Version 0.7.0b1 released
- Simplified installation process, added table recognition functionality
-
-
-
- 2024/08/01 Version 0.6.2b1 released
- Optimized dependency conflict issues and installation documentation
-
-
-
- 2024/07/05 Initial open-source release
-
-
+
# MinerU
-## Project Introduction
-
-MinerU is a tool that converts PDFs into machine-readable formats (e.g., markdown, JSON), allowing for easy extraction into any format.
-MinerU was born during the pre-training process of [InternLM](https://github.com/InternLM/InternLM). We focus on solving symbol conversion issues in scientific literature and hope to contribute to technological development in the era of large models.
-Compared to well-known commercial products, MinerU is still young. If you encounter any issues or if the results are not as expected, please submit an issue on [issue](https://github.com/opendatalab/MinerU/issues) and **attach the relevant PDF**.
-
-https://github.com/user-attachments/assets/4bea02c9-6d54-4cd6-97ed-dff14340982c
-
-## Key Features
-
-- Remove headers, footers, footnotes, page numbers, etc., to ensure semantic coherence.
-- Output text in human-readable order, suitable for single-column, multi-column, and complex layouts.
-- Preserve the structure of the original document, including headings, paragraphs, lists, etc.
-- Extract images, image descriptions, tables, table titles, and footnotes.
-- Automatically recognize and convert formulas in the document to LaTeX format.
-- Automatically recognize and convert tables in the document to HTML format.
-- Automatically detect scanned PDFs and garbled PDFs and enable OCR functionality.
-- OCR supports detection and recognition of 84 languages.
-- Supports multiple output formats, such as multimodal and NLP Markdown, JSON sorted by reading order, and rich intermediate formats.
-- Supports various visualization results, including layout visualization and span visualization, for efficient confirmation of output quality.
-- Supports running in a pure CPU environment, and also supports GPU(CUDA)/NPU(CANN)/MPS acceleration
-- Compatible with Windows, Linux, and Mac platforms.
-
-# Quick Start
-
-If you encounter any installation issues, please first consult the