Instructions to use AudioVisual-Caption/ASID-Captioner-3B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use AudioVisual-Caption/ASID-Captioner-3B with Transformers:

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

pipe = pipeline("image-text-to-text", model="AudioVisual-Caption/ASID-Captioner-3B")
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, AutoModel

processor = AutoProcessor.from_pretrained("AudioVisual-Caption/ASID-Captioner-3B")
model = AutoModel.from_pretrained("AudioVisual-Caption/ASID-Captioner-3B")
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 AudioVisual-Caption/ASID-Captioner-3B with vLLM:

Install from pip and serve model

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

SGLang

How to use AudioVisual-Caption/ASID-Captioner-3B 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 "AudioVisual-Caption/ASID-Captioner-3B" \
    --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": "AudioVisual-Caption/ASID-Captioner-3B",
		"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 "AudioVisual-Caption/ASID-Captioner-3B" \
        --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": "AudioVisual-Caption/ASID-Captioner-3B",
		"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 AudioVisual-Caption/ASID-Captioner-3B with Docker Model Runner:
```
docker model run hf.co/AudioVisual-Caption/ASID-Captioner-3B
```

lyhisme commited on Feb 26

Commit

9b6ed46

verified ·

1 Parent(s): 59a00fb

Update README.md

Browse files

Files changed (1) hide show

README.md +13 -10

README.md CHANGED Viewed

@@ -1,18 +1,21 @@
 ---
 language:
-  - en
 library_name: transformers
 tags:
-  - video-captioning
-  - audiovisual
-  - qwen2.5-omni
-  - instruction-tuning
-  - attribute-structured
-  - quality-verified
 pipeline_tag: image-text-to-text
 model-index:
-  - name: ASID-Captioner-3B
-    results: []
 ---
 # ASID-Captioner-3B
@@ -192,4 +195,4 @@ If you use our model in your research, please cite our paper:
 ## Contact
 Please open a Discussion on the Hugging Face page for usage questions or issues.
-```

 ---
 language:
+- en
 library_name: transformers
 tags:
+- video-captioning
+- audiovisual
+- qwen2.5-omni
+- instruction-tuning
+- attribute-structured
+- quality-verified
 pipeline_tag: image-text-to-text
 model-index:
+- name: ASID-Captioner-3B
+  results: []
+license: apache-2.0
+base_model:
+- Qwen/Qwen2.5-Omni-3B
 ---
 # ASID-Captioner-3B
 ## Contact
 Please open a Discussion on the Hugging Face page for usage questions or issues.
+```