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 20

Commit

32b58a6

verified ·

1 Parent(s): e9ad070

Update README.md

Browse files

Files changed (1) hide show

README.md +2 -2

README.md CHANGED Viewed

@@ -17,8 +17,8 @@ library_name: transformers
 <p align="center">
   <a href="https://huggingface.co/thinkingmachines/Inkling">BF16</a> |
   <a href="https://huggingface.co/thinkingmachines/Inkling-NVFP4">NVFP4</a> |
   <a href="https://github.com/thinking-machines-lab/tinker-cookbook">Tinker Cookbook</a> |
-  <a href="https://tinker-docs.thinkingmachines.ai/cookbook/inkling/">Documentation</a> |
   <a href="https://thinkingmachines.ai/model-acceptable-use-policy">Acceptable Use</a>
 </p>
@@ -30,7 +30,7 @@ Inkling is a general-purpose multimodal model that accepts text, image and audio
 ## 2. Getting Started
-For accessing Inkling via Tinker: You can get started by referring to the Tinker Cookbook [here](https://github.com/thinking-machines-lab/tinker-cookbook) and associated documentation [here](https://tinker-docs.thinkingmachines.ai/cookbook/inkling/).
 Inkling supports local deployment using the following open-source libraries:

 <p align="center">
   <a href="https://huggingface.co/thinkingmachines/Inkling">BF16</a> |
   <a href="https://huggingface.co/thinkingmachines/Inkling-NVFP4">NVFP4</a> |
+  <a href="https://tinker.thinkingmachines.ai/playground">Playground</a> |
   <a href="https://github.com/thinking-machines-lab/tinker-cookbook">Tinker Cookbook</a> |
   <a href="https://thinkingmachines.ai/model-acceptable-use-policy">Acceptable Use</a>
 </p>
 ## 2. Getting Started
+Try Inkling on the [Tinker Playground](https://tinker.thinkingmachines.ai/playground) or access via API using the [Tinker Cookbook](https://github.com/thinking-machines-lab/tinker-cookbook).
 Inkling supports local deployment using the following open-source libraries: