Skip to content

Quick Start

If you encounter any installation issues, please check the FAQ first.

Online Experience

Official online web application

The official online version has the same functionality as the client, with a beautiful interface and rich features, requires login to use

  • OpenDataLab

Gradio-based online demo

A WebUI developed based on Gradio, with a simple interface and only core parsing functionality, no login required

  • ModelScope
  • HuggingFace

Local Deployment

Warning

Prerequisites - Hardware and Software Environment Support

To ensure the stability and reliability of the project, we have optimized and tested only specific hardware and software environments during development. This ensures that users can achieve optimal performance and encounter the fewest compatibility issues when deploying and running the project on recommended system configurations.

By concentrating our resources and efforts on mainstream environments, our team can more efficiently resolve potential bugs and timely develop new features.

In non-mainstream environments, due to the diversity of hardware and software configurations, as well as compatibility issues with third-party dependencies, we cannot guarantee 100% usability of the project. Therefore, for users who wish to use this project in non-recommended environments, we suggest carefully reading the documentation and FAQ first, as most issues have corresponding solutions in the FAQ. Additionally, we encourage community feedback on issues so that we can gradually expand our support range.

Parsing Backend pipeline vlm-transformers vlm-sglang
Operating System Linux / Windows / macOS Linux / Windows Linux / Windows (via WSL2)
CPU Inference Support ✅ ❌
GPU Requirements Turing architecture and later, 6GB+ VRAM or Apple Silicon Turing architecture and later, 8GB+ VRAM
Memory Requirements Minimum 16GB+, recommended 32GB+
Disk Space Requirements 20GB+, SSD recommended
Python Version 3.10-3.13

Install MinerU

Install MinerU using pip or uv

pip install --upgrade pip
pip install uv
uv pip install -U "mineru[core]"

Install MinerU from source code

git clone https://github.com/opendatalab/MinerU.git
cd MinerU
uv pip install -e .[core]

Tip

mineru[core] includes all core features except sglang acceleration, compatible with Windows / Linux / macOS systems, suitable for most users. If you need to use sglang acceleration for VLM model inference or install a lightweight client on edge devices, please refer to the documentation Extension Modules Installation Guide.

Deploy MinerU using Docker

MinerU provides a convenient Docker deployment method, which helps quickly set up the environment and solve some tricky environment compatibility issues. You can get the Docker Deployment Instructions in the documentation.

Using MinerU

The simplest command line invocation is: 

mineru -p <input_path> -o <output_path>

You can use MinerU for PDF parsing through various methods such as command line, API, and WebUI. For detailed instructions, please refer to the Usage Guide.