Image-Text-to-Text
Transformers
Safetensors
English
qwen2_5_vl
conversational
text-generation-inference
Instructions to use ChatDOC/OCRFlux-3B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use ChatDOC/OCRFlux-3B with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("image-text-to-text", model="ChatDOC/OCRFlux-3B") 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("ChatDOC/OCRFlux-3B") model = AutoModelForMultimodalLM.from_pretrained("ChatDOC/OCRFlux-3B", 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 ChatDOC/OCRFlux-3B with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "ChatDOC/OCRFlux-3B" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "ChatDOC/OCRFlux-3B", "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/ChatDOC/OCRFlux-3B
- SGLang
How to use ChatDOC/OCRFlux-3B 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 "ChatDOC/OCRFlux-3B" \ --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": "ChatDOC/OCRFlux-3B", "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 "ChatDOC/OCRFlux-3B" \ --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": "ChatDOC/OCRFlux-3B", "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 ChatDOC/OCRFlux-3B with Docker Model Runner:
docker model run hf.co/ChatDOC/OCRFlux-3B
|
Download README.md from ChatDOC/OCRFlux-3B: direct link, hf CLI and curl.
- Browser
- Download file 893 Bytes
-
https://huggingface.co/ChatDOC/OCRFlux-3B/resolve/cd448da956807aa4b1f5c334cb29877956e7f1ed/README.md
- Command line
-
hf download hf://ChatDOC/OCRFlux-3B@cd448da956807aa4b1f5c334cb29877956e7f1ed/README.md
-
curl -L -o README.md https://huggingface.co/ChatDOC/OCRFlux-3B/resolve/cd448da956807aa4b1f5c334cb29877956e7f1ed/README.md
893 Bytes
| license_name: qwen-research | |
| license_link: https://huggingface.co/Qwen/Qwen2.5-VL-3B-Instruct/blob/main/LICENSE | |
| language: | |
| - en | |
| benchmarks: | |
| - ChatDoc/OCRFlux-bench-single | |
| - ChatDoc/OCRFlux-bench-cross | |
| - ChatDoc/OCRFlux-pubtabnet-single | |
| - ChatDoc/OCRFlux-pubtabnet-cross | |
| base_model: | |
| - Qwen/Qwen2.5-VL-3B-Instruct | |
| library_name: transformers | |
| # OCRFlux-3B | |
| This is a preview release of the OCRFlux-3B model that's fine tuned from Qwen2.5-VL-3B-Instruct using the our private document datasets and some data from | |
| [olmOCR-mix-0225](https://huggingface.co/datasets/allenai/olmOCR-mix-0225) dataset. | |
| Quick links: | |
| - 🛠️ [Code](https://github.com/chatdoc-com/OCRFlux) | |
| ## Usage | |
| The best way to use this model is via the [OCRFlux toolkit](https://github.com/chatdoc-com/OCRFlux). | |
| The toolkit comes with an efficient inference setup via vllm that can handle millions of documents | |
| at scale. | |