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

d587be7

verified ·

1 Parent(s): 650c010

Update README.md

Browse files

Files changed (1) hide show

README.md +33 -24

README.md CHANGED Viewed

@@ -139,47 +139,56 @@ print(output_text[0])
 ## **Example Cards**
-<div style="font-family: 'Courier New', Courier, monospace; background-color: #000000; border: 1px solid #333333; border-radius: 12px; padding: 24px; color: #FFFFFF; max-width: 800px; margin: 0 auto;">
   <!-- Card 1 -->
-  <div style="margin-bottom: 20px;">
-    <img src="https://cdn-uploads.huggingface.co/production/uploads/65bb837dbfb878f46c77de4c/UnSXkoCSNmeiGF0OAGMO5.jpeg" alt="Safe Example 1" style="width: 100%; border-radius: 8px; margin-bottom: 16px; border: 1px solid #333333; display: block;">
-    <pre style="background: #111111; padding: 16px; border-radius: 8px; border: 1px solid #333333; color: #FFFFFF; white-space: pre-wrap; word-wrap: break-word; font-size: 13px; line-height: 1.6; margin: 0;">{
   "caption": "Two female tennis players in white athletic wear are shaking hands on a tennis court, with a net between them. In the background, a woman in a blue uniform stands near a green wall, and a man in a navy blazer and white trousers observes.",
-  "is_nsfw": <span style="color: #00FF00; font-weight: bold;">false</span>,
   "reason": "The image depicts a standard sports scene featuring two female tennis players in professional attire (white skirts and tops) engaging in a handshake. The setting includes a tennis court, a net, and a line judge or official in the background. There is no evidence of nudity, revealing swimwear, suggestive poses, or any elements that would indicate an NSFW classification.",
-  "nsfw": <span style="color: #00FF00; font-weight: bold;">0</span>,
-  "safe": <span style="color: #00FF00; font-weight: bold;">1</span>
 }</pre>
   </div>
-  <!-- Separator -->
-  <div style="border-bottom: 1px solid #333333; margin: 30px 0;"></div>
-  <!-- Card 2 -->
-  <div style="margin-bottom: 20px;">
-    <img src="https://cdn-uploads.huggingface.co/production/uploads/65bb837dbfb878f46c77de4c/FxCT2p4ZPucdVcPZT4c41.png" alt="NSFW Example 2" style="width: 100%; border-radius: 8px; margin-bottom: 16px; border: 1px solid #333333; display: block; filter: blur(30px); -webkit-filter: blur(30px);">
-    <pre style="background: #111111; padding: 16px; border-radius: 8px; border: 1px solid #333333; color: #FFFFFF; white-space: pre-wrap; word-wrap: break-word; font-size: 13px; line-height: 1.6; margin: 0;">{
   "caption": "A close-up profile shot of a woman with tanned skin, wearing a yellow and white patterned fabric draped over her lower body. She is holding the fabric up to reveal her bare buttocks and hip area. Her upper body is largely exposed, showing cleavage and a bare chest, while her dark hair is styled loosely.",
-  "is_nsfw": <span style="color: #00FF00; font-weight: bold;">true</span>,
   "reason": "The image features significant nudity and exposure. The subject's buttocks and hip are fully visible, and her upper body is largely unclothed, exposing cleavage and a bare chest. The use of a patterned fabric draped over the body creates a suggestive, revealing aesthetic that aligns with the 'exposed' and 'suggestive' classification criteria.",
-  "nsfw": <span style="color: #00FF00; font-weight: bold;">1</span>,
-  "safe": <span style="color: #00FF00; font-weight: bold;">0</span>
 }</pre>
   </div>
-  <!-- Separator -->
-  <div style="border-bottom: 1px solid #333333; margin: 30px 0;"></div>
   <!-- Card 3 -->
-  <div style="margin-bottom: 20px;">
-    <img src="https://cdn-uploads.huggingface.co/production/uploads/65bb837dbfb878f46c77de4c/ZwuWL28H1PlGcv70X4Dbt.jpeg" alt="Safe Example 3" style="width: 100%; border-radius: 8px; margin-bottom: 16px; border: 1px solid #333333; display: block;">
-    <pre style="background: #111111; padding: 16px; border-radius: 8px; border: 1px solid #333333; color: #FFFFFF; white-space: pre-wrap; word-wrap: break-word; font-size: 13px; line-height: 1.6; margin: 0;">{
   "caption": "A young girl with blonde hair, wearing a blue soccer jersey and black shorts, is captured mid-air kicking a white soccer ball on a grassy hill. She is wearing white socks and cleats. The background is a clear, solid blue sky.",
-  "is_nsfw": <span style="color: #00FF00; font-weight: bold;">false</span>,
   "reason": "The image depicts an active sports scene featuring a child playing soccer. The subject is fully clothed in standard athletic gear (jersey, shorts, socks, cleats) and is engaged in a dynamic action pose. There is no evidence of nudity, revealing swimwear, suggestive poses, or any elements that would indicate NSFW content.",
-  "nsfw": <span style="color: #00FF00; font-weight: bold;">0</span>,
-  "safe": <span style="color: #00FF00; font-weight: bold;">1</span>
 }</pre>
   </div>

 ## **Example Cards**
+<div style="background-color: #000000; font-family: 'Courier New', Courier, monospace; color: #FFFFFF; padding: 24px; border-radius: 12px; border: 1px solid #333333; max-width: 800px; margin: 0 auto;">
   <!-- Card 1 -->
+  <div style="margin-bottom: 32px;">
+    <div style="border-radius: 8px; overflow: hidden; margin-bottom: 16px; border: 1px solid #222;">
+      <img src="https://cdn-uploads.huggingface.co/production/uploads/65bb837dbfb878f46c77de4c/UnSXkoCSNmeiGF0OAGMO5.jpeg" alt="Safe Image 1" style="width: 100%; height: auto; display: block;">
+    </div>
+    <pre style="background-color: #0a0a0a; padding: 16px; border-radius: 8px; border: 1px solid #222; color: #e0e0e0; font-size: 13px; line-height: 1.6; white-space: pre-wrap; word-wrap: break-word; margin: 0;">
+{
   "caption": "Two female tennis players in white athletic wear are shaking hands on a tennis court, with a net between them. In the background, a woman in a blue uniform stands near a green wall, and a man in a navy blazer and white trousers observes.",
+  "is_nsfw": <span style="color: #4ade80;">false</span>,
   "reason": "The image depicts a standard sports scene featuring two female tennis players in professional attire (white skirts and tops) engaging in a handshake. The setting includes a tennis court, a net, and a line judge or official in the background. There is no evidence of nudity, revealing swimwear, suggestive poses, or any elements that would indicate an NSFW classification.",
+  "nsfw": <span style="color: #4ade80;">0</span>,
+  "safe": <span style="color: #4ade80;">1</span>
 }</pre>
   </div>
+  <!-- Thin Line Bar -->
+  <hr style="border: 0; border-top: 1px solid #333333; margin: 0 0 32px 0;">
+  <!-- Card 2 (NSFW - Blurred) -->
+  <div style="margin-bottom: 32px;">
+    <div style="border-radius: 8px; overflow: hidden; margin-bottom: 16px; border: 1px solid #222; position: relative;">
+      <img src="https://cdn-uploads.huggingface.co/production/uploads/65bb837dbfb878f46c77de4c/FxCT2p4ZPucdVcPZT4c41.png" alt="NSFW Image 2" style="width: 100%; height: auto; display: block; filter: blur(30px) saturate(0.8); transform: scale(1.1);">
+    </div>
+    <pre style="background-color: #0a0a0a; padding: 16px; border-radius: 8px; border: 1px solid #222; color: #e0e0e0; font-size: 13px; line-height: 1.6; white-space: pre-wrap; word-wrap: break-word; margin: 0;">
+{
   "caption": "A close-up profile shot of a woman with tanned skin, wearing a yellow and white patterned fabric draped over her lower body. She is holding the fabric up to reveal her bare buttocks and hip area. Her upper body is largely exposed, showing cleavage and a bare chest, while her dark hair is styled loosely.",
+  "is_nsfw": <span style="color: #4ade80;">true</span>,
   "reason": "The image features significant nudity and exposure. The subject's buttocks and hip are fully visible, and her upper body is largely unclothed, exposing cleavage and a bare chest. The use of a patterned fabric draped over the body creates a suggestive, revealing aesthetic that aligns with the 'exposed' and 'suggestive' classification criteria.",
+  "nsfw": <span style="color: #4ade80;">1</span>,
+  "safe": <span style="color: #4ade80;">0</span>
 }</pre>
   </div>
+  <!-- Thin Line Bar -->
+  <hr style="border: 0; border-top: 1px solid #333333; margin: 0 0 32px 0;">
   <!-- Card 3 -->
+  <div>
+    <div style="border-radius: 8px; overflow: hidden; margin-bottom: 16px; border: 1px solid #222;">
+      <img src="https://cdn-uploads.huggingface.co/production/uploads/65bb837dbfb878f46c77de4c/ZwuWL28H1PlGcv70X4Dbt.jpeg" alt="Safe Image 3" style="width: 100%; height: auto; display: block;">
+    </div>
+    <pre style="background-color: #0a0a0a; padding: 16px; border-radius: 8px; border: 1px solid #222; color: #e0e0e0; font-size: 13px; line-height: 1.6; white-space: pre-wrap; word-wrap: break-word; margin: 0;">
+{
   "caption": "A young girl with blonde hair, wearing a blue soccer jersey and black shorts, is captured mid-air kicking a white soccer ball on a grassy hill. She is wearing white socks and cleats. The background is a clear, solid blue sky.",
+  "is_nsfw": <span style="color: #4ade80;">false</span>,
   "reason": "The image depicts an active sports scene featuring a child playing soccer. The subject is fully clothed in standard athletic gear (jersey, shorts, socks, cleats) and is engaged in a dynamic action pose. There is no evidence of nudity, revealing swimwear, suggestive poses, or any elements that would indicate NSFW content.",
+  "nsfw": <span style="color: #4ade80;">0</span>,
+  "safe": <span style="color: #4ade80;">1</span>
 }</pre>
   </div>