Instructions to use prithivMLmods/ImageShield-MMCF-2B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use prithivMLmods/ImageShield-MMCF-2B with Transformers:

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

pipe = pipeline("image-text-to-text", model="prithivMLmods/ImageShield-MMCF-2B")
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("prithivMLmods/ImageShield-MMCF-2B")
model = AutoModelForMultimodalLM.from_pretrained("prithivMLmods/ImageShield-MMCF-2B", 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 prithivMLmods/ImageShield-MMCF-2B with vLLM:

Install from pip and serve model

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

SGLang

How to use prithivMLmods/ImageShield-MMCF-2B 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 "prithivMLmods/ImageShield-MMCF-2B" \
    --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": "prithivMLmods/ImageShield-MMCF-2B",
		"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 "prithivMLmods/ImageShield-MMCF-2B" \
        --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": "prithivMLmods/ImageShield-MMCF-2B",
		"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 prithivMLmods/ImageShield-MMCF-2B with Docker Model Runner:
```
docker model run hf.co/prithivMLmods/ImageShield-MMCF-2B
```

prithivMLmods commited on 5 days ago

Commit

eeea21b

1 Parent(s): 26c0446

Add files using upload-large-folder tool

Browse files

Files changed (1) hide show

.gitattributes +14 -0

.gitattributes CHANGED Viewed

@@ -34,3 +34,17 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
 tokenizer.json filter=lfs diff=lfs merge=lfs -text

 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
 tokenizer.json filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.mmproj-bf16.gguf filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.mmproj-q8_0.gguf filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.mmproj-f16.gguf filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.Q3_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.Q3_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.Q4_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.Q3_K_L.gguf filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.Q4_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.Q5_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.Q8_0.gguf filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.BF16.gguf filter=lfs diff=lfs merge=lfs -text
+ImageShield-MMCF-2B.F16.gguf filter=lfs diff=lfs merge=lfs -text