Instructions to use nintwentydo/Pixtral-Large-Instruct-2411 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use nintwentydo/Pixtral-Large-Instruct-2411 with Transformers:

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

pipe = pipeline("image-text-to-text", model="nintwentydo/Pixtral-Large-Instruct-2411")
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("nintwentydo/Pixtral-Large-Instruct-2411")
model = AutoModelForMultimodalLM.from_pretrained("nintwentydo/Pixtral-Large-Instruct-2411", 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]:]))

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use nintwentydo/Pixtral-Large-Instruct-2411 with vLLM:

Install from pip and serve model

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

SGLang

How to use nintwentydo/Pixtral-Large-Instruct-2411 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 "nintwentydo/Pixtral-Large-Instruct-2411" \
    --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": "nintwentydo/Pixtral-Large-Instruct-2411",
		"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 "nintwentydo/Pixtral-Large-Instruct-2411" \
        --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": "nintwentydo/Pixtral-Large-Instruct-2411",
		"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 nintwentydo/Pixtral-Large-Instruct-2411 with Docker Model Runner:
```
docker model run hf.co/nintwentydo/Pixtral-Large-Instruct-2411
```

nintwentydo commited on Dec 21, 2024

Commit

44ffbf1

verified ·

1 Parent(s): 3d655ac

Update chat_template.json

Browse files

Files changed (1) hide show

chat_template.json +1 -1

chat_template.json CHANGED Viewed

@@ -1,3 +1,3 @@
 {
-    "chat_template": "{{- bos_token }}\n{%- for message in messages %}\n    {%- if message['role'] == 'user' %}\n        {{- '[INST]' + ' ' }}\n        {%- if message['content'] is not string %}\n            {%- for chunk in message['content'] %}\n                {%- if chunk['type'] == 'text' %}\n                    {{- chunk['content'] }}\n                {%- elif chunk['type'] == 'image' %}\n                    {{- '[IMG]' }}\n                {%- else %}\n                    {{- raise_exception('Unrecognized content type!') }}\n                {%- endif %}\n            {%- endfor %}\n        {%- else %}\n            {{- message['content'] }}\n        {%- endif %}\n        {%- if tools is defined and tools is not none and loop.last %}\n            {{- '[AVAILABLE_TOOLS] [' }}\n            {%- for tool in tools %}\n                {%- set tool = tool.function %}\n                {{- '{\"type\": \"function\", \"function\": {' }}\n                {%- for key, val in tool.items() if key != \"return\" %}\n                    {%- if val is string %}\n                        {{- '\"' + key + '\": \"' + val + '\"' }}\n                    {%- else %}\n                        {{- '\"' + key + '\": ' + val|tojson }}\n                    {%- endif %}\n                    {%- if not loop.last %}\n                        {{- ', ' }}\n                    {%- endif %}\n                {%- endfor %}\n                {{- '}}' }}\n                {%- if not loop.last %}\n                    {{- ', ' }}\n                {%- endif %}\n            {%- endfor %}\n            {{- ']' }}\n            {{- '[\/AVAILABLE_TOOLS]' }}\n        {%- endif %}\n        {{- '[\/INST]' }}\n    {%- elif message['role'] == 'system' %}\n        {{- '[SYSTEM_PROMPT] ' + message['content'] + '[\/SYSTEM_PROMPT]' }}\n    {%- elif message['role'] == 'assistant' %}\n        {{- ' ' + message['content'] + eos_token }}\n    {%- elif message['role'] == 'tool_results' or message['role'] == 'tool' %}\n        {%- if message.content is defined and message.content.content is defined %}\n            {%- set content = message.content.content %}\n        {%- else %}\n            {%- set content = message.content %}\n        {%- endif %}\n        {{- '[TOOL_RESULTS] {\"content\": ' + content|string + ', ' }}\n        {%- if message.content is mapping and 'image' in message.content %}\n            {{- '\"image\": \"[IMG]\", ' }}\n        {%- endif %}\n        {%- if not message.tool_call_id is defined or message.tool_call_id|length != 9 %}\n            {{- raise_exception(\"Tool call IDs should be alphanumeric strings with length 9!\") }}\n        {%- endif %}\n        {{- '\"call_id\": \"' + message.tool_call_id + '\"}[\/TOOL_RESULTS]' }}\n    {%- elif message.tool_calls is defined and message.tool_calls is not none %}\n        {{- '[TOOL_CALLS] [' }}\n        {%- for tool_call in message.tool_calls %}\n            {%- set out = tool_call.function|tojson %}\n            {{- out[:-1] }}\n            {%- if not tool_call.id is defined or tool_call.id|length != 9 %}\n                {{- raise_exception(\"Tool call IDs should be alphanumeric strings with length 9!\") }}\n            {%- endif %}\n            {{- ', \"id\": \"' + tool_call.id + '\"}' }}\n            {%- if not loop.last %}\n                {{- ', ' }}\n            {%- endif %}\n        {%- endfor %}\n        {{- ']' + eos_token }}\n    {%- else %}\n        {{- raise_exception('Only user, system, assistant, tool, and tool_results roles are supported!') }}\n    {%- endif %}\n{%- endfor %}"
 }

 {
+  "chat_template": "{{- bos_token }}\n{%- for message in messages %}\n    {%- if message['role'] == 'user' %}\n        {{- '[INST] ' }}\n        {%- if message['content'] is not string %}\n            {%- for chunk in message['content'] %}\n                {%- if chunk['type'] == 'text' %}\n                    {{- chunk['content'] }}\n                {%- elif chunk['type'] == 'image' %}\n                    {{- '[IMG]' }}\n                {%- else %}\n                    {{- raise_exception('Unrecognized content type!') }}\n                {%- endif %}\n            {%- endfor %}\n        {%- else %}\n            {{- message['content'] }}\n        {%- endif %}\n        {%- if tools is defined and tools is not none and loop.last %}\n            {{- '[AVAILABLE_TOOLS] [' }}\n            {%- for tool in tools %}\n                {%- set tool = tool.function %}\n                {{- '{\"type\": \"function\", \"function\": {' }}\n                {%- for key, val in tool.items() if key != \"return\" %}\n                    {%- if val is string %}\n                        {{- '\"' + key + '\": \"' + val + '\"' }}\n                    {%- else %}\n                        {{- '\"' + key + '\": ' + val|tojson }}\n                    {%- endif %}\n                    {%- if not loop.last %}\n                        {{- ', ' }}\n                    {%- endif %}\n                {%- endfor %}\n                {{- '}}' }}\n                {%- if not loop.last %}\n                    {{- ', ' }}\n                {%- endif %}\n            {%- endfor %}\n            {{- ']' }}\n            {{- '[\/AVAILABLE_TOOLS]' }}\n        {%- endif %}\n        {{- '[\/INST]' }}\n    {%- elif message['role'] == 'system' %}\n        {{- '[SYSTEM_PROMPT] ' + message['content'] + '[\/SYSTEM_PROMPT]' }}\n    {%- elif message['role'] == 'assistant' %}\n        {{- ' ' }}\n        {%- if message['content'] is not string %}\n            {%- for chunk in message['content'] %}\n                {%- if chunk['type'] == 'text' %}\n                    {{- chunk['content']|trim }}\n                {%- elif chunk['type'] == 'image' %}\n                    {{- '[IMG]' }}\n                {%- else %}\n                    {{- raise_exception('Unrecognized content type!') }}\n                {%- endif %}\n            {%- endfor %}\n        {%- else %}\n            {{- message['content']|trim }}\n        {%- endif %}\n        {{- eos_token }}\n    {%- elif message['role'] == 'tool_results' or message['role'] == 'tool' %}\n        {%- if message.content is defined and message.content.content is defined %}\n            {%- set content = message.content.content %}\n        {%- else %}\n            {%- set content = message.content %}\n        {%- endif %}\n        {{- '[TOOL_RESULTS] {\"content\": ' + content|string + ', ' }}\n        {%- if message.content is mapping and 'image' in message.content %}\n            {{- '\"image\": \"[IMG]\", ' }}\n        {%- endif %}\n        {%- if not message.tool_call_id is defined or message.tool_call_id|length != 9 %}\n            {{- raise_exception(\"Tool call IDs should be alphanumeric strings with length 9!\") }}\n        {%- endif %}\n        {{- '\"call_id\": \"' + message.tool_call_id + '\"}[\/TOOL_RESULTS]' }}\n    {%- elif message.tool_calls is defined and message.tool_calls is not none %}\n        {{- '[TOOL_CALLS] [' }}\n        {%- for tool_call in message.tool_calls %}\n            {%- set out = tool_call.function|tojson %}\n            {{- out[:-1] }}\n            {%- if not tool_call.id is defined or tool_call.id|length != 9 %}\n                {{- raise_exception(\"Tool call IDs should be alphanumeric strings with length 9!\") }}\n            {%- endif %}\n            {{- ', \"id\": \"' + tool_call.id + '\"}' }}\n            {%- if not loop.last %}\n                {{- ', ' }}\n            {%- endif %}\n        {%- endfor %}\n        {{- ']' + eos_token }}\n    {%- else %}\n        {{- raise_exception('Only user, system, assistant, tool, and tool_results roles are supported!') }}\n    {%- endif %}\n{%- endfor %}"
 }