Image-Text-to-Text
Transformers
Safetensors
qwen3_5
ocr
document-parsing
document-understanding
markdown
latex
table-recognition
multilingual
vllm
conversational
Instructions to use sionic-ai/PepperOCR-VL with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use sionic-ai/PepperOCR-VL with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("image-text-to-text", model="sionic-ai/PepperOCR-VL") messages = [ { "role": "user", "content": [ {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/p-blog/candy.JPG"}, {"type": "text", "text": "What animal is on the candy?"} ] }, ] pipe(text=messages)# pip install -U transformers accelerate # Load model directly from transformers import AutoProcessor, AutoModelForMultimodalLM processor = AutoProcessor.from_pretrained("sionic-ai/PepperOCR-VL") model = AutoModelForMultimodalLM.from_pretrained("sionic-ai/PepperOCR-VL", device_map="auto") messages = [ { "role": "user", "content": [ {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/p-blog/candy.JPG"}, {"type": "text", "text": "What animal is on the candy?"} ] }, ] inputs = processor.apply_chat_template( messages, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt", ).to(model.device) outputs = model.generate(**inputs, max_new_tokens=256) print(processor.decode(outputs[0][inputs["input_ids"].shape[-1]:])) - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use sionic-ai/PepperOCR-VL with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "sionic-ai/PepperOCR-VL" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "sionic-ai/PepperOCR-VL", "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/sionic-ai/PepperOCR-VL
- SGLang
How to use sionic-ai/PepperOCR-VL 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 "sionic-ai/PepperOCR-VL" \ --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": "sionic-ai/PepperOCR-VL", "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 "sionic-ai/PepperOCR-VL" \ --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": "sionic-ai/PepperOCR-VL", "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 sionic-ai/PepperOCR-VL with Docker Model Runner:
docker model run hf.co/sionic-ai/PepperOCR-VL
File size: 7,378 Bytes
7284b34 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 | #!/usr/bin/env python3
"""Apply the fixed PP-LCNet document-orientation policy on CPU."""
from __future__ import annotations
import argparse
import json
import os
import shutil
import time
from collections import Counter
from concurrent.futures import ThreadPoolExecutor
from pathlib import Path
import cv2
import numpy as np
import paddle.inference as paddle_infer
from PIL import Image, ImageOps
CLASSIFIER = "PP-LCNet_x1_0_doc_ori"
THRESHOLD = 0.85
LABELS = (0, 90, 180, 270)
EXTENSIONS = {".jpg", ".jpeg", ".png"}
MEAN = np.asarray((0.485, 0.456, 0.406), dtype=np.float32)
STD = np.asarray((0.229, 0.224, 0.225), dtype=np.float32)
TRANSPOSE = {
90: Image.Transpose.ROTATE_90,
180: Image.Transpose.ROTATE_180,
270: Image.Transpose.ROTATE_270,
}
MODEL_FILES = ("inference.json", "inference.pdiparams")
MATERIALIZE_WORKERS = 8
def verify_model_files(model_dir: Path) -> None:
missing = [name for name in MODEL_FILES if not (model_dir / name).is_file()]
if missing:
raise RuntimeError(f"orientation model files are missing: {missing}")
def preprocess(path: Path) -> np.ndarray:
with Image.open(path) as opened:
image = np.asarray(ImageOps.exif_transpose(opened).convert("RGB"))
height, width = image.shape[:2]
scale = 256.0 / min(height, width)
resized = cv2.resize(
image,
(round(width * scale), round(height * scale)),
interpolation=cv2.INTER_LINEAR,
)
height, width = resized.shape[:2]
top = (height - 224) // 2
left = (width - 224) // 2
crop = resized[top : top + 224, left : left + 224].astype(np.float32)
crop = (crop / 255.0 - MEAN) / STD
return np.transpose(crop, (2, 0, 1))
class Predictor:
def __init__(self, model_dir: Path):
config = paddle_infer.Config(
str(model_dir / "inference.json"),
str(model_dir / "inference.pdiparams"),
)
config.disable_gpu()
config.set_cpu_math_library_num_threads(4)
config.disable_glog_info()
self.predictor = paddle_infer.create_predictor(config)
self.input_name = self.predictor.get_input_names()[0]
self.output_name = self.predictor.get_output_names()[0]
def predict(self, paths: list[Path]) -> list[tuple[Path, int, float]]:
rows: list[tuple[Path, int, float]] = []
with ThreadPoolExecutor(max_workers=4) as pool:
for start in range(0, len(paths), 8):
batch_paths = paths[start : start + 8]
batch = np.stack(list(pool.map(preprocess, batch_paths)))
input_handle = self.predictor.get_input_handle(self.input_name)
input_handle.reshape(batch.shape)
input_handle.copy_from_cpu(batch)
self.predictor.run()
values = self.predictor.get_output_handle(self.output_name).copy_to_cpu()
if values.ndim != 2 or values.shape[1] != len(LABELS):
raise RuntimeError(
f"unexpected classifier output shape: {values.shape}"
)
if np.any(values < 0) or not np.allclose(
values.sum(axis=1), 1.0, atol=1e-3
):
values = np.exp(values - values.max(axis=1, keepdims=True))
values /= values.sum(axis=1, keepdims=True)
for path, probabilities in zip(batch_paths, values, strict=True):
index = int(np.argmax(probabilities))
rows.append((path, LABELS[index], float(probabilities[index])))
return rows
def materialize(
source: Path, angle: int, confidence: float, output_dir: Path
) -> bool:
selected = angle in TRANSPOSE and confidence >= THRESHOLD
if selected:
target = output_dir / f"{source.stem}.png"
with Image.open(source) as opened:
image = ImageOps.exif_transpose(opened).convert("RGB")
image.transpose(TRANSPOSE[angle]).save(
target, format="PNG", optimize=False
)
else:
target = output_dir / source.name
try:
os.link(source, target)
except OSError:
shutil.copy2(source, target)
return selected
def main() -> int:
started = time.perf_counter()
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument("--input-dir", required=True, type=Path)
parser.add_argument("--output-dir", required=True, type=Path)
parser.add_argument("--model-dir", required=True, type=Path)
parser.add_argument(
"--record-path",
type=Path,
default=None,
help="Optional JSONL file recording label/confidence/rotated per image.",
)
args = parser.parse_args()
if not args.input_dir.is_dir():
parser.error(f"input directory not found: {args.input_dir}")
if not args.model_dir.is_dir():
parser.error(f"orientation model directory not found: {args.model_dir}")
if args.input_dir.resolve() == args.output_dir.resolve():
parser.error("input and output directories must differ")
if args.output_dir.is_dir() and any(args.output_dir.iterdir()):
parser.error(f"output directory must be empty: {args.output_dir}")
paths = sorted(
path
for path in args.input_dir.iterdir()
if path.is_file() and path.suffix.lower() in EXTENSIONS
)
if not paths:
parser.error(f"no supported images found in: {args.input_dir}")
duplicate_stems = [
stem for stem, count in Counter(path.stem for path in paths).items() if count > 1
]
if duplicate_stems:
raise RuntimeError(f"duplicate input stems: {sorted(duplicate_stems)}")
verify_model_files(args.model_dir)
args.output_dir.mkdir(parents=True, exist_ok=True)
predictions = Predictor(args.model_dir).predict(paths)
classified = time.perf_counter()
with ThreadPoolExecutor(max_workers=MATERIALIZE_WORKERS) as pool:
futures = [
pool.submit(materialize, source, angle, confidence, args.output_dir)
for source, angle, confidence in predictions
]
results = [future.result() for future in futures]
selected = sum(results)
if args.record_path is not None:
args.record_path.parent.mkdir(parents=True, exist_ok=True)
with args.record_path.open("w", encoding="utf-8") as handle:
for (source, angle, confidence), rotated in zip(predictions, results, strict=True):
handle.write(
json.dumps(
{
"image": source.name,
"label": angle,
"confidence": round(float(confidence), 6),
"rotated": bool(rotated),
}
)
+ "\n"
)
finished = time.perf_counter()
print(
f"[orientation] classifier={CLASSIFIER} images={len(paths)} "
f"corrected={selected} workers={MATERIALIZE_WORKERS} "
f"classify_s={classified - started:.1f} "
f"materialize_s={finished - classified:.1f} "
f"total_s={finished - started:.1f} "
f"images_per_s={len(paths) / (finished - started):.2f}"
)
return 0
if __name__ == "__main__":
raise SystemExit(main())
|