Instructions to use docling-project/SmolDocling-256M-preview with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use docling-project/SmolDocling-256M-preview with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("image-text-to-text", model="docling-project/SmolDocling-256M-preview") 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("docling-project/SmolDocling-256M-preview") model = AutoModelForMultimodalLM.from_pretrained("docling-project/SmolDocling-256M-preview") 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 docling-project/SmolDocling-256M-preview with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "docling-project/SmolDocling-256M-preview" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "docling-project/SmolDocling-256M-preview", "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/docling-project/SmolDocling-256M-preview
- SGLang
How to use docling-project/SmolDocling-256M-preview 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 "docling-project/SmolDocling-256M-preview" \ --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": "docling-project/SmolDocling-256M-preview", "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 "docling-project/SmolDocling-256M-preview" \ --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": "docling-project/SmolDocling-256M-preview", "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 docling-project/SmolDocling-256M-preview with Docker Model Runner:
docker model run hf.co/docling-project/SmolDocling-256M-preview
Add link to paper and project page
#3
by nielsr HF Staff - opened
README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
| 1 |
---
|
| 2 |
-
library_name: transformers
|
| 3 |
-
license: apache-2.0
|
| 4 |
-
language:
|
| 5 |
-
- en
|
| 6 |
base_model:
|
| 7 |
- HuggingFaceTB/SmolVLM-256M-Instruct
|
|
|
|
|
|
|
|
|
|
|
|
|
| 8 |
pipeline_tag: image-text-to-text
|
| 9 |
---
|
| 10 |
|
|
@@ -16,6 +16,8 @@ pipeline_tag: image-text-to-text
|
|
| 16 |
</div>
|
| 17 |
</div>
|
| 18 |
|
|
|
|
|
|
|
| 19 |
### π Features:
|
| 20 |
- π·οΈ **DocTags for Efficient Tokenization** β Introduces DocTags an efficient and minimal representation for documents that is fully compatible with **DoclingDocuments**.
|
| 21 |
- π **OCR (Optical Character Recognition)** β Extracts text accurately from images.
|
|
@@ -39,7 +41,6 @@ pipeline_tag: image-text-to-text
|
|
| 39 |
- π§ͺ **Chemical Recognition**
|
| 40 |
- π **Datasets**
|
| 41 |
|
| 42 |
-
|
| 43 |
## β¨οΈ Get started (code examples)
|
| 44 |
|
| 45 |
You can use **transformers** or **vllm** to perform inference, and [Docling](https://github.com/docling-project/docling) to convert results to variety of ourput formats (md, html, etc.):
|
|
@@ -145,7 +146,8 @@ sampling_params = SamplingParams(
|
|
| 145 |
temperature=0.0,
|
| 146 |
max_tokens=8192)
|
| 147 |
|
| 148 |
-
chat_template = f"<|im_start|>User:<image>{PROMPT_TEXT}<end_of_utterance>
|
|
|
|
| 149 |
|
| 150 |
image_files = sorted([f for f in os.listdir(IMAGE_DIR) if f.lower().endswith((".png", ".jpg", ".jpeg"))])
|
| 151 |
|
|
@@ -253,6 +255,8 @@ DocTags are integrated with Docling, which allows export to HTML, Markdown, and
|
|
| 253 |
|
| 254 |
**Paper:** [arXiv](https://arxiv.org/abs/2503.11576)
|
| 255 |
|
|
|
|
|
|
|
| 256 |
**Citation:**
|
| 257 |
```
|
| 258 |
@misc{nassar2025smoldoclingultracompactvisionlanguagemodel,
|
|
@@ -265,4 +269,4 @@ DocTags are integrated with Docling, which allows export to HTML, Markdown, and
|
|
| 265 |
url={https://arxiv.org/abs/2503.11576},
|
| 266 |
}
|
| 267 |
```
|
| 268 |
-
**Demo:** [Coming soon]
|
|
|
|
| 1 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2 |
base_model:
|
| 3 |
- HuggingFaceTB/SmolVLM-256M-Instruct
|
| 4 |
+
language:
|
| 5 |
+
- en
|
| 6 |
+
library_name: transformers
|
| 7 |
+
license: apache-2.0
|
| 8 |
pipeline_tag: image-text-to-text
|
| 9 |
---
|
| 10 |
|
|
|
|
| 16 |
</div>
|
| 17 |
</div>
|
| 18 |
|
| 19 |
+
This model was presented in the paper [SmolDocling: An ultra-compact vision-language model for end-to-end multi-modal document conversion](https://huggingface.co/papers/2503.11576).
|
| 20 |
+
|
| 21 |
### π Features:
|
| 22 |
- π·οΈ **DocTags for Efficient Tokenization** β Introduces DocTags an efficient and minimal representation for documents that is fully compatible with **DoclingDocuments**.
|
| 23 |
- π **OCR (Optical Character Recognition)** β Extracts text accurately from images.
|
|
|
|
| 41 |
- π§ͺ **Chemical Recognition**
|
| 42 |
- π **Datasets**
|
| 43 |
|
|
|
|
| 44 |
## β¨οΈ Get started (code examples)
|
| 45 |
|
| 46 |
You can use **transformers** or **vllm** to perform inference, and [Docling](https://github.com/docling-project/docling) to convert results to variety of ourput formats (md, html, etc.):
|
|
|
|
| 146 |
temperature=0.0,
|
| 147 |
max_tokens=8192)
|
| 148 |
|
| 149 |
+
chat_template = f"<|im_start|>User:<image>{PROMPT_TEXT}<end_of_utterance>
|
| 150 |
+
Assistant:"
|
| 151 |
|
| 152 |
image_files = sorted([f for f in os.listdir(IMAGE_DIR) if f.lower().endswith((".png", ".jpg", ".jpeg"))])
|
| 153 |
|
|
|
|
| 255 |
|
| 256 |
**Paper:** [arXiv](https://arxiv.org/abs/2503.11576)
|
| 257 |
|
| 258 |
+
**Project Page:** [Hugging Face](https://huggingface.co/ds4sd/SmolDocling-256M-preview)
|
| 259 |
+
|
| 260 |
**Citation:**
|
| 261 |
```
|
| 262 |
@misc{nassar2025smoldoclingultracompactvisionlanguagemodel,
|
|
|
|
| 269 |
url={https://arxiv.org/abs/2503.11576},
|
| 270 |
}
|
| 271 |
```
|
| 272 |
+
**Demo:** [Coming soon]
|