Instructions to use thinkingmachines/Inkling with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use thinkingmachines/Inkling with Transformers:

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

pipe = pipeline("image-text-to-text", model="thinkingmachines/Inkling")
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("thinkingmachines/Inkling")
model = AutoModelForMultimodalLM.from_pretrained("thinkingmachines/Inkling", 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]:]))

Inference
HuggingChat
Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use thinkingmachines/Inkling with vLLM:

Install from pip and serve model

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

SGLang

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

aurick commited on Jul 23

Commit

828496e

verified ·

1 Parent(s): 32b58a6

Update README.md

Browse files

Files changed (1) hide show

README.md +5 -5

README.md CHANGED Viewed

@@ -34,11 +34,11 @@ Try Inkling on the [Tinker Playground](https://tinker.thinkingmachines.ai/playgr
 Inkling supports local deployment using the following open-source libraries:
-* SGLang ([recipe](https://docs.sglang.io/cookbook/autoregressive/ThinkingMachines/Inkling), [PR](https://github.com/sgl-project/sglang/pull/31358))
-* vLLM ([recipe](https://recipes.vllm.ai/thinkingmachines/Inkling), [PR](https://github.com/vllm-project/vllm/pull/48768))
-* TokenSpeed ([recipe](https://lightseek.org/tokenspeed/recipes/models#Inkling), [PR](https://github.com/lightseekorg/tokenspeed/pull/689))
-* Unsloth ([recipe](https://unsloth.ai/docs/models/inkling), [PR](https://github.com/ggml-org/llama.cpp/pull/25731))
-* Huggingface ([recipe](https://hf.co/blog/thinkingmachines-inkling), [PR](https://github.com/huggingface/transformers/pull/47347))
 API access is also available through third party inference providers.

 Inkling supports local deployment using the following open-source libraries:
+* SGLang ([recipe](https://docs.sglang.io/cookbook/autoregressive/ThinkingMachines/Inkling))
+* vLLM ([recipe](https://recipes.vllm.ai/thinkingmachines/Inkling))
+* TokenSpeed ([recipe](https://lightseek.org/tokenspeed/recipes/models#Inkling))
+* Unsloth ([recipe](https://unsloth.ai/docs/models/inkling))
+* Huggingface ([recipe](https://hf.co/blog/thinkingmachines-inkling))
 API access is also available through third party inference providers.