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

Libraries

How to use codeShare/joycaption_beta_one_SDNQ with Transformers:

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

pipe = pipeline("image-text-to-text", model="codeShare/joycaption_beta_one_SDNQ")
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, AutoModelForImageTextToText

processor = AutoProcessor.from_pretrained("codeShare/joycaption_beta_one_SDNQ")
model = AutoModelForImageTextToText.from_pretrained("codeShare/joycaption_beta_one_SDNQ")
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

vLLM

How to use codeShare/joycaption_beta_one_SDNQ with vLLM:

Install from pip and serve model

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

SGLang

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

joycaption_beta_one_SDNQ / config.json

codeShare

SDNQ uint4 JoyCaption — complete single-file safetensors (in-place CPU quant, 5.85 GB)

23339b5 verified 15 days ago

raw

history blame contribute delete

2.13 kB

	{
	"architectures": [
	"LlavaForConditionalGeneration"
	],
	"image_seq_length": 729,
	"image_token_index": 128077,
	"model_type": "llava",
	"multimodal_projector_bias": true,
	"projector_hidden_act": "gelu",
	"text_config": {
	"_name_or_path": "meta-llama/Llama-3.1-8B-Instruct",
	"architectures": [
	"LlamaForCausalLM"
	],
	"attention_bias": false,
	"attention_dropout": 0.0,
	"bos_token_id": 128000,
	"eos_token_id": [
	128001,
	128008,
	128009
	],
	"head_dim": 128,
	"hidden_act": "silu",
	"hidden_size": 4096,
	"initializer_range": 0.02,
	"intermediate_size": 14336,
	"max_position_embeddings": 131072,
	"mlp_bias": false,
	"model_type": "llama",
	"num_attention_heads": 32,
	"num_hidden_layers": 32,
	"num_key_value_heads": 8,
	"pretraining_tp": 1,
	"rms_norm_eps": 1e-05,
	"rope_scaling": {
	"factor": 8.0,
	"high_freq_factor": 4.0,
	"low_freq_factor": 1.0,
	"original_max_position_embeddings": 8192,
	"rope_type": "llama3"
	},
	"rope_theta": 500000.0,
	"torch_dtype": "bfloat16",
	"use_cache": true,
	"vocab_size": 128256
	},
	"torch_dtype": "bfloat16",
	"transformers_version": "4.51.0.dev0",
	"vision_config": {
	"_name_or_path": "google/siglip2-so400m-patch14-384",
	"architectures": [
	"SiglipVisionModel"
	],
	"attention_dropout": 0.0,
	"hidden_act": "gelu_pytorch_tanh",
	"hidden_size": 1152,
	"image_size": 384,
	"intermediate_size": 4304,
	"layer_norm_eps": 1e-06,
	"model_type": "siglip_vision_model",
	"num_attention_heads": 16,
	"num_channels": 3,
	"num_hidden_layers": 27,
	"patch_size": 14,
	"torch_dtype": "bfloat16"
	},
	"vision_feature_layer": -2,
	"vision_feature_select_strategy": "full",
	"quantization_config": {
	"quant_method": "sdnq",
	"weights_dtype": "uint4",
	"group_size": 128,
	"quantization_device": "cuda",
	"return_device": "cuda",
	"use_svd": false,
	"quant_conv": false,
	"quant_embedding": false,
	"use_quantized_matmul": false,
	"dequantize_fp32": true
	}
	}