extension_modules.md 2.6 KB

MinerU Extension Modules Installation Guide

MinerU supports installing extension modules on demand based on different needs to enhance functionality or support specific model backends.

Common Scenarios

Core Functionality Installation

The core module is the core dependency of MinerU, containing all functional modules except vllm/lmdeploy. Installing this module ensures the basic functionality of MinerU works properly.

uv pip install "mineru[core]"

Using vllm to Accelerate VLM Model Inference

[!NOTE] vllm and lmdeploy have nearly identical VLM inference acceleration effects and usage methods. You can choose one of them to install and use based on your actual needs, but it is not recommended to install both modules simultaneously to avoid potential dependency conflicts.

The vllm module provides acceleration support for VLM model inference, suitable for graphics cards with Volta architecture and later (8GB+ VRAM). Installing this module can significantly improve model inference speed.

uv pip install "mineru[core,vllm]"

[!TIP] If exceptions occur during installation of the extra package including vllm, please refer to the vllm official documentation to try to resolve the issue, or directly use the Docker deployment method.


Using lmdeploy to Accelerate VLM Model Inference

[!NOTE] vllm and lmdeploy have nearly identical VLM inference acceleration effects and usage methods. You can choose one of them to install and use based on your actual needs, but it is not recommended to install both modules simultaneously to avoid potential dependency conflicts.

The lmdeploy module provides acceleration support for VLM model inference, suitable for graphics cards with Volta architecture and later (8GB+ VRAM). Installing this module can significantly improve model inference speed.

uv pip install "mineru[core,lmdeploy]"

[!TIP] If exceptions occur during installation of the extra package including lmdeploy, please refer to the lmdeploy official documentation to try to resolve the issue.


Installing Lightweight Client to Connect to OpenAI-compatible servers

If you need to install a lightweight client on edge devices to connect to an OpenAI-compatible server for using VLM mode, you can install the basic mineru package, which is very lightweight and suitable for devices with only CPU and network connectivity.

uv pip install mineru