Instructions to use openbmb/MiniCPM-OCR-1.0-AWQ with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use openbmb/MiniCPM-OCR-1.0-AWQ with MiniCPM-OCR:

pip install "minicpm-ocr[all]" huggingface_hub

# Deploy openbmb/MiniCPM-OCR-1.0-AWQ as a recognition service before running the Python example:
# https://github.com/OpenBMB/MiniCPM-OCR/blob/main/docs/vllm_deploy_en.md
# vLLM: load the model above; use --port 8080,
# --served-model-name minicpm-ocr and --max-model-len 40960.
# Layout detection uses cuda:0; recognition runs on the deployed service.

from importlib.resources import files
from pathlib import Path

from minicpmvocr import load_config, pipelined_run
from huggingface_hub import snapshot_download

layout_model = snapshot_download("PaddlePaddle/PP-DocLayoutV3")
cfg = load_config(
    str(files("minicpmvocr").joinpath("configs/minicpmvocr.yaml")),
    overrides={
        "input": {"file_path": str(Path("demo.png").resolve())},
        "engine": {
            "type": "vllm",
            "server_url": "http://127.0.0.1:8080",
            "model_name": "minicpm-ocr",
            "max_model_len": 40960,
        },
        "layout": {"model_dir": layout_model, "device": "cuda:0"},
        # Render PDFs in-process so this example also works without a main guard.
        "pipeline": {"overlap_layout": True, "render_workers": 1},
    },
)
pipelined_run(cfg)

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use openbmb/MiniCPM-OCR-1.0-AWQ with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "openbmb/MiniCPM-OCR-1.0-AWQ"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "openbmb/MiniCPM-OCR-1.0-AWQ",
		"messages": [
			{
				"role": "user",
				"content": [
					{
						"type": "text",
						"text": "Describe this image in one sentence."
					},
					{
						"type": "image_url",
						"image_url": {
							"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
						}
					}
				]
			}
		]
	}'

Use Docker

docker model run hf.co/openbmb/MiniCPM-OCR-1.0-AWQ

SGLang

How to use openbmb/MiniCPM-OCR-1.0-AWQ with SGLang:

Install from pip and serve model

# Install SGLang from pip:
pip install sglang
# Start the SGLang server:
python3 -m sglang.launch_server \
    --model-path "openbmb/MiniCPM-OCR-1.0-AWQ" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "openbmb/MiniCPM-OCR-1.0-AWQ",
		"messages": [
			{
				"role": "user",
				"content": [
					{
						"type": "text",
						"text": "Describe this image in one sentence."
					},
					{
						"type": "image_url",
						"image_url": {
							"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
						}
					}
				]
			}
		]
	}'

Use Docker images

docker run --gpus all \
    --shm-size 32g \
    -p 30000:30000 \
    -v ~/.cache/huggingface:/root/.cache/huggingface \
    --env "HF_TOKEN=<secret>" \
    --ipc=host \
    lmsysorg/sglang:latest \
    python3 -m sglang.launch_server \
        --model-path "openbmb/MiniCPM-OCR-1.0-AWQ" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "openbmb/MiniCPM-OCR-1.0-AWQ",
		"messages": [
			{
				"role": "user",
				"content": [
					{
						"type": "text",
						"text": "Describe this image in one sentence."
					},
					{
						"type": "image_url",
						"image_url": {
							"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
						}
					}
				]
			}
		]
	}'

Docker Model Runner
How to use openbmb/MiniCPM-OCR-1.0-AWQ with Docker Model Runner:
```
docker model run hf.co/openbmb/MiniCPM-OCR-1.0-AWQ
```

Fix Chinese model card link in usage guide banner

by wunu - opened 2 days ago

base: refs/heads/main

←

from: refs/pr/2

Discussion Files changed

-1

wunu

OpenBMB org 2 days ago

The language switch link in the top banner was missing the openbmb/ organization prefix, so clicking 中文 led to a 404 page.
Point it at https://huggingface.co/openbmb//blob/main/README_zh.md instead.

Fix Chinese model card link in usage guide banner6dbcdbaf

wunu changed pull request status to merged 2 days ago

Upload images, audio, and videos by dragging in the text input, pasting, or clicking here.

Tap or paste here to upload images

· Sign up or log in to comment