Instructions to use HuggingFaceTB/SmolVLM-Base with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use HuggingFaceTB/SmolVLM-Base with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("image-text-to-text", model="HuggingFaceTB/SmolVLM-Base") 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("HuggingFaceTB/SmolVLM-Base") model = AutoModelForMultimodalLM.from_pretrained("HuggingFaceTB/SmolVLM-Base", 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 HuggingFaceTB/SmolVLM-Base with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "HuggingFaceTB/SmolVLM-Base" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "HuggingFaceTB/SmolVLM-Base", "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/HuggingFaceTB/SmolVLM-Base
- SGLang
How to use HuggingFaceTB/SmolVLM-Base 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 "HuggingFaceTB/SmolVLM-Base" \ --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": "HuggingFaceTB/SmolVLM-Base", "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 "HuggingFaceTB/SmolVLM-Base" \ --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": "HuggingFaceTB/SmolVLM-Base", "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 HuggingFaceTB/SmolVLM-Base with Docker Model Runner:
docker model run hf.co/HuggingFaceTB/SmolVLM-Base
Commit History
-
Update generation_config.json
Verified signaturea576ab7 -
Update tokenizer_config.json
Verified signature43c599a -
Update generation_config.json
Verified signature1525666 -
Update generation_config.json
Verified signaturefdbb720 -
Update generation_config.json
Verified signature25cba61
-
add model card (#5)
Verified signature- add model card (37a98d4d50e3cdb1f43c5f8e93fd0cdfcc9d0b95) - Update README.md (ca2aebd256eba3e6b541c90753a5869492a685c3) Co-authored-by: Aritra Roy Gosthipaty <ariG23498@users.noreply.huggingface.co>1052ce8 -
Update README.md (#3)
Verified signature- Update README.md (4970a107ba805e51b2fb8860c473bbbbb5907f84)e9cc507
-
Update chat_template.json
Verified signature6c1094d -
Update generation_config.json
Verified signaturec1f5849 -
Update generation_config.json
Verified signature4afcd01 -
Update generation_config.json
Verified signature7d9e73d -
Update generation_config.json
Verified signature8aba716 -
Add eos token (#2)
Verified signature- Add eos token (e4cfe5625e38b3543a29a5d904730493b4f039a1) Co-authored-by: Merve Noyan <merve@users.noreply.huggingface.co>a1f6b5c
-
Added chat_template (#1)
Verified signature- Added chat_template (bd688f05fabcefdd50b112c08592b7acf6bbe37f) Co-authored-by: Merve Noyan <merve@users.noreply.huggingface.co>fba0982
-
Update preprocessor_config.json
Verified signaturea413d4d -
Update config.json
Verified signature8b5abc7 -
Update processor_config.json
Verified signature2415d77 -
Update config.json
Verified signature11ca5ac -
Upload processor
Verified signature83e502d -
Upload Idefics3ForConditionalGeneration
Verified signatured56e39b -
initial commit
Verified signature30116ce