Hugging Face's logo Hugging Face
  • Models
  • Datasets
  • Spaces
  • Buckets new
  • Docs
  • Enterprise
  • Pricing

  • Log In
  • Sign Up

ChatDOC
/
OCRFlux-3B

Image-Text-to-Text
Transformers
Safetensors
English
qwen2_5_vl
conversational
text-generation-inference
Model card Files Files and versions
xet
Community
14

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)
    # Load model directly
    from transformers import AutoProcessor, AutoModelForImageTextToText
    
    processor = AutoProcessor.from_pretrained("ChatDOC/OCRFlux-3B")
    model = AutoModelForImageTextToText.from_pretrained("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?"}
            ]
        },
    ]
    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
  • 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
OCRFlux-3B
8.15 GB
Ctrl+K
Ctrl+K
  • 1 contributor
History: 10 commits
ChatDOC's picture
ChatDOC
Update README.md
e685922 verified 10 months ago
  • .gitattributes
    1.57 kB
    Upload folder using huggingface_hub 11 months ago
  • LICENSE
    7.39 kB
    Upload LICENSE 10 months ago
  • README.md
    14.4 kB
    Update README.md 10 months ago
  • added_tokens.json
    966 Bytes
    Upload folder using huggingface_hub 11 months ago
  • chat_template.json
    1.05 kB
    Upload folder using huggingface_hub 11 months ago
  • config.json
    1.24 kB
    Upload folder using huggingface_hub 11 months ago
  • generation_config.json
    302 Bytes
    Upload folder using huggingface_hub 11 months ago
  • merges.txt
    1.67 MB
    Upload folder using huggingface_hub 11 months ago
  • model-00001-of-00002.safetensors
    5 GB
    xet
    Upload folder using huggingface_hub 11 months ago
  • model-00002-of-00002.safetensors
    3.13 GB
    xet
    Upload folder using huggingface_hub 11 months ago
  • model.safetensors.index.json
    65.5 kB
    Upload folder using huggingface_hub 11 months ago
  • preprocessor_config.json
    350 Bytes
    Upload folder using huggingface_hub 11 months ago
  • special_tokens_map.json
    613 Bytes
    Upload folder using huggingface_hub 11 months ago
  • tokenizer.json
    11.4 MB
    xet
    Upload folder using huggingface_hub 11 months ago
  • tokenizer_config.json
    9.92 kB
    Upload folder using huggingface_hub 11 months ago
  • vocab.json
    2.78 MB
    Upload folder using huggingface_hub 11 months ago