Instructions to use StarDoc-AI/TeleOCR with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use StarDoc-AI/TeleOCR with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("image-text-to-text", model="StarDoc-AI/TeleOCR", trust_remote_code=True)
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)

# Load model directly
from transformers import AutoProcessor, AutoModelForMultimodalLM

processor = AutoProcessor.from_pretrained("StarDoc-AI/TeleOCR", trust_remote_code=True)
model = AutoModelForMultimodalLM.from_pretrained("StarDoc-AI/TeleOCR", trust_remote_code=True, 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=40)
print(processor.decode(outputs[0][inputs["input_ids"].shape[-1]:]))

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use StarDoc-AI/TeleOCR with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "StarDoc-AI/TeleOCR"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "StarDoc-AI/TeleOCR",
		"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/StarDoc-AI/TeleOCR

SGLang

How to use StarDoc-AI/TeleOCR 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 "StarDoc-AI/TeleOCR" \
    --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": "StarDoc-AI/TeleOCR",
		"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 "StarDoc-AI/TeleOCR" \
        --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": "StarDoc-AI/TeleOCR",
		"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 StarDoc-AI/TeleOCR with Docker Model Runner:
```
docker model run hf.co/StarDoc-AI/TeleOCR
```

changdazhou commited on 15 days ago

Commit

c173173

verified ·

1 Parent(s): c21590c

Add Real5-OmniDocBench evaluation results for NaviDC-OCR

Browse files

# Real5-OmniDocBench evaluation results for NaviDC-OCR

This PR adds the evaluation file for NaviDC-OCR under the Hugging Face
evaluation-results workflow.

This is based on the new evaluation results feature: https://huggingface.co/docs/hub/eval-results.

## Dataset
- [PaddlePaddle/Real5-OmniDocBench](https://huggingface.co/datasets/PaddlePaddle/Real5-OmniDocBench)

## File
- `.eval_results/real5_omnidocbench.yaml`

## Tasks
- overall
- scanning
- warping
- screen_photography
- illumination
- skew

Files changed (1) hide show

.eval_results/real5_omnidocbench.yaml +48 -0

.eval_results/real5_omnidocbench.yaml ADDED Viewed

	@@ -0,0 +1,48 @@

+- dataset:
+    id: PaddlePaddle/Real5-OmniDocBench
+    task_id: overall
+  value: 90.72
+  source:
+    url: https://huggingface.co/datasets/PaddlePaddle/Real5-OmniDocBench
+    name: Real5-OmniDocBench Leaderboard
+    user: PaddlePaddle
+- dataset:
+    id: PaddlePaddle/Real5-OmniDocBench
+    task_id: scanning
+  value: 92.33
+  source:
+    url: https://huggingface.co/datasets/PaddlePaddle/Real5-OmniDocBench
+    name: Real5-OmniDocBench Leaderboard
+    user: PaddlePaddle
+- dataset:
+    id: PaddlePaddle/Real5-OmniDocBench
+    task_id: warping
+  value: 90.63
+  source:
+    url: https://huggingface.co/datasets/PaddlePaddle/Real5-OmniDocBench
+    name: Real5-OmniDocBench Leaderboard
+    user: PaddlePaddle
+- dataset:
+    id: PaddlePaddle/Real5-OmniDocBench
+    task_id: screen_photography
+  value: 89.09
+  source:
+    url: https://huggingface.co/datasets/PaddlePaddle/Real5-OmniDocBench
+    name: Real5-OmniDocBench Leaderboard
+    user: PaddlePaddle
+- dataset:
+    id: PaddlePaddle/Real5-OmniDocBench
+    task_id: illumination
+  value: 90.9
+  source:
+    url: https://huggingface.co/datasets/PaddlePaddle/Real5-OmniDocBench
+    name: Real5-OmniDocBench Leaderboard
+    user: PaddlePaddle
+- dataset:
+    id: PaddlePaddle/Real5-OmniDocBench
+    task_id: skew
+  value: 90.63
+  source:
+    url: https://huggingface.co/datasets/PaddlePaddle/Real5-OmniDocBench
+    name: Real5-OmniDocBench Leaderboard
+    user: PaddlePaddle