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

Libraries

How to use FirstPrinciplesLabs/quark with Transformers:

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

pipe = pipeline("image-text-to-text", model="FirstPrinciplesLabs/quark")
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("FirstPrinciplesLabs/quark")
model = AutoModelForMultimodalLM.from_pretrained("FirstPrinciplesLabs/quark", 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 FirstPrinciplesLabs/quark with vLLM:

Install from pip and serve model

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

SGLang

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

chengfp-eng commited on 3 days ago

Commit

725cb1d

verified ·

1 Parent(s): edb8ddd

Add Ollama usage for the Q8_0 model

Browse files

Adds instructions for running FirstPrinciples/quark-q8 on Ollama.

Files changed (1) hide show

README.md +11 -1

README.md CHANGED Viewed

@@ -68,7 +68,8 @@ All were measured by us with the same setup.
 A Q8_0 version (model weights quantized to 8 bits) for llama.cpp (in GGUF format) is available at
 [FirstPrinciplesLabs/quark_quantized_weight_only-Q8_0](https://huggingface.co/FirstPrinciplesLabs/quark_quantized_weight_only-Q8_0). Its accuracy is
-in the [Results](#results) table: it matches Quark on all benchmarks.
 ## Throughput
@@ -109,6 +110,15 @@ Or run it locally with [Ollama](https://ollama.com/FirstPrinciples/quark) (BF16
 ollama run firstprinciples/quark
 ```
 For the [Q8_0 version](#q8_0-version) with llama.cpp:
 ```bash

 A Q8_0 version (model weights quantized to 8 bits) for llama.cpp (in GGUF format) is available at
 [FirstPrinciplesLabs/quark_quantized_weight_only-Q8_0](https://huggingface.co/FirstPrinciplesLabs/quark_quantized_weight_only-Q8_0). Its accuracy is
+in the [Results](#results) table: it matches Quark on all benchmarks. It is also on Ollama as
+[FirstPrinciples/quark-q8](https://ollama.com/FirstPrinciples/quark-q8) (see [Usage](#usage)).
 ## Throughput
 ollama run firstprinciples/quark
 ```
+For the [Q8_0 version](#q8_0-version) with [Ollama](https://ollama.com/FirstPrinciples/quark-q8) (about 10 GB; the same sampling settings and 131,072-token context built in):
+```bash
+ollama run FirstPrinciples/quark-q8
+```
+A 131,072-token context needs about 15 GB of GPU memory. On a 16 GB Mac, lower it inside the chat with
+`/set parameter num_ctx 32768` (longer answers are then cut off).
 For the [Q8_0 version](#q8_0-version) with llama.cpp:
 ```bash