Update README.md

README.md

@@ -1,207 +0,0 @@
----
-license: apache-2.0
-base_model:
-- Qwen/Qwen3.5-4B
----
-
-<div style="font-family: 'Ubuntu', 'Segoe UI', Roboto, Helvetica, Arial, sans-serif; background-color: #000000; color: #FFFFFF; padding: 25px; border-radius: 8px; max-width: 900px; margin: 0 auto; line-height: 1.6;">
-  <style>
-    .vg-link { color: #FF4500; text-decoration: none; font-weight: bold; }
-    .vg-link:hover { text-decoration: underline; }
-    .vg-bullet { list-style-type: none; padding-left: 20px; }
-    .vg-bullet li { margin-bottom: 10px; position: relative; padding-left: 20px; }
-    .vg-bullet li::before { content: "+"; position: absolute; left: 0; color: #FFFFFF; font-weight: bold; }
-    .vg-code-container { position: relative; background-color: #111111; border: 1px solid #333333; border-radius: 4px; margin-bottom: 15px; }
-    .vg-copy-btn { position: absolute; top: 8px; right: 8px; background-color: #333333; color: #FFFFFF; border: 1px solid #555555; padding: 4px 10px; cursor: pointer; border-radius: 4px; font-family: 'Ubuntu', sans-serif; font-size: 12px; transition: background 0.2s; z-index: 10; }
-    .vg-copy-btn:hover { background-color: #555555; }
-    .vg-code { padding: 40px 15px 15px 15px; overflow-x: auto; color: #FFFFFF; font-family: 'Ubuntu Mono', 'Courier New', monospace; font-size: 14px; white-space: pre; }
-    .vg-boxquote { border: 1px solid #FFFFFF; padding: 15px; margin: 20px 0; border-radius: 4px; background-color: #000000; color: #FFFFFF; }
-    .vg-table { width: 100%; border-collapse: collapse; margin: 20px 0; }
-    .vg-table th, .vg-table td { border: 1px solid #444444; padding: 10px; text-align: left; color: #FFFFFF; }
-    .vg-table th { background-color: #111111; font-weight: bold; }
-  </style>
-
-  <h1 style="color: #FFFFFF; font-weight: bold; font-size: 28px; border-bottom: 2px solid #444444; padding-bottom: 10px; margin-top: 0;">VisionGuardrail-4B</h1>
-
-  <p style="font-size: 16px; color: #FFFFFF;">
-    <b>VisionGuardrail-4B</b> is a multimodal content-safety classifier based on <b>Qwen/Qwen3.5-4B</b> and trained on the <a href="https://huggingface.co/datasets/prithivMLmods/ImageShield-Guardrail-Pro" class="vg-link">prithivMLmods/ImageShield-Guardrail-Pro</a> content-safety guardrail dataset. The model is designed to classify visual content as <b>Safe</b> or <b>Unsafe</b>, with a particular focus on detecting <b>Not Safe for Work (NSFW) sensual content</b> and other potentially sensitive visual content. VisionGuardrail-4B excels at detecting <b>explicit and sensitive visual content</b>, with detailed analysis of <b>dress codes, clothing exposure, poses, framing, and different visual settings</b> to support conservative content-safety classification.
-  </p>
-
-  <div class="vg-boxquote">
-    This model is an experimental release and may generate unexpected behaviors or reasoning artifacts in certain scenarios. <b>This model is intended for research and content-safety classification only.</b> Any outputs generated by this model are the sole responsibility of the user. The authors and hosting platform disclaim all liability for generated content. Users must ensure safe, ethical, and lawful usage.
-  </div>
-
-  <h2 style="color: #FFFFFF; font-size: 22px; font-weight: bold; border-bottom: 1px solid #444444; padding-bottom: 5px;">Key Highlights</h2>
-  <ul class="vg-bullet">
-    <li><b>Qwen 3.5 Foundation</b>: Built on <b>Qwen/Qwen3.5-4B</b>.</li>
-    <li><b>Multimodal Content Filter</b>: Designed for visual content-safety classification.</li>
-    <li><b>ImageShield-Guardrail-Pro Training</b>: Fine-tuned on the <b>prithivMLmods/ImageShield-Guardrail-Pro</b> content-safety guardrail dataset.</li>
-    <li><b>Safe / Unsafe Classification</b>: Classifies visual content as either <b>Safe</b> or <b>Unsafe</b>.</li>
-    <li><b>NSFW Sensual Content Detection</b>: Focused on identifying potentially <b>Not Safe for Work (NSFW) sensual content</b> and related sensitive visual material.</li>
-    <li><b>Explicit & Sensitive Content Detection</b>: Excels at identifying explicit, revealing, provocative, and otherwise potentially sensitive visual content.</li>
-    <li><b>Dress-Code Analysis</b>: Performs detailed analysis of clothing, dress codes, exposure, and revealing garments.</li>
-    <li><b>Pose Analysis</b>: Analyzes body poses, positioning, framing, and potentially suggestive presentation.</li>
-    <li><b>Context & Setting Analysis</b>: Considers different visual settings and contextual cues when determining content safety.</li>
-    <li><b>Zero-Tolerance Safety Classification</b>: Uses a conservative classification policy that favors safety when the content is ambiguous.</li>
-    <li><b>Structured Output</b>: Produces a machine-readable JSON response containing a caption, classification, and reasoning.</li>
-  </ul>
-
-  <h2 style="color: #FFFFFF; font-size: 22px; font-weight: bold; border-bottom: 1px solid #444444; padding-bottom: 5px;">Standard Instruction</h2>
-  
-  <div class="vg-code-container">
-    <button class="vg-copy-btn" onclick="copyCode(this)">Copy</button>
-    <pre class="vg-code"><code>You are a strict, zero-tolerance parental control content-safety guardrail classifier for visual media.
-
-Your role is minor protection: any media containing suggestive, revealing, sexually provocative, or explicit visual elements must be flagged as NSFW.
-
-STRICT ZERO-TOLERANCE CLASSIFICATION RULES:
-
-1. Nudity & Exposure: Any full or partial nudity, exposed breasts, cleavage, buttocks, groin, or visible pubic area MUST be classified as NSFW.
-
-2. Underwear & Swimwear: Thongs, G-strings, micro-bikinis, skimpy or revealing swimwear, bras, panties, lingerie, see-through clothing, or unbuttoned tops revealing undergarments or bare torsos MUST be classified as NSFW.
-
-3. Dress-Code Analysis: Carefully analyze clothing, coverage, transparency, exposure, and the overall dress code. Revealing or sexually provocative clothing MUST be classified as NSFW.
-
-4. Poses & Suggestiveness: Sexually suggestive poses, seductive modeling, cleavage-emphasizing framing, fetish content, or explicit erotic themes MUST be classified as NSFW.
-
-5. Context & Setting: Consider the visual setting, composition, framing, and contextual cues when evaluating potentially sensitive content.
-
-6. Artwork & Animation: Anime nudes, ecchi, hentai, suggestive illustrations, or 2D/3D stylized erotica MUST be classified as NSFW.
-
-7. Sensitive Visual Content: Explicit or highly suggestive visual content MUST be classified as NSFW even when presented in non-photorealistic or artistic formats.
-
-8. Classification Threshold: When in doubt, err on the side of caution and classify the content as NSFW.
-
-Output strictly valid JSON with no extra conversational text, commentary, or markdown formatting outside the JSON object:
-
-{
-  "caption": "<Detailed, objective visual description of the subject, clothing, exposure, pose, and setting>",
-  "is_nsfw": true | false,
-  "reason": "<Precise reason for classification based on clothing, exposure, pose, context, or other visual cues>",
-  "nsfw": 1 | 0,
-  "safe": 1 | 0
-}</code></pre>
-  </div>
-
-  <h2 style="color: #FFFFFF; font-size: 22px; font-weight: bold; border-bottom: 1px solid #444444; padding-bottom: 5px;">Quick Start with Transformers</h2>
-
-  <div class="vg-code-container">
-    <button class="vg-copy-btn" onclick="copyCode(this)">Copy</button>
-    <pre class="vg-code"><code>pip install transformers
-pip install accelerate</code></pre>
-  </div>
-
-  <div class="vg-code-container">
-    <button class="vg-copy-btn" onclick="copyCode(this)">Copy</button>
-    <pre class="vg-code"><code>from transformers import Qwen3_5ForConditionalGeneration, AutoProcessor
-import torch
-
-model = Qwen3_5ForConditionalGeneration.from_pretrained(
-    "prithivMLmods/VisionGuardrail-4B",
-    torch_dtype="auto",
-    device_map="auto"
-)
-
-processor = AutoProcessor.from_pretrained(
-    "prithivMLmods/VisionGuardrail-4B"
-)
-
-messages = [
-    {
-        "role": "user",
-        "content": [
-            {
-                "type": "text",
-                "text": "Classify this image using the provided content-safety guardrail."
-            }
-        ],
-    }
-]
-
-text = processor.apply_chat_template(
-    messages,
-    tokenize=False,
-    add_generation_prompt=True
-)
-
-inputs = processor(
-    text=[text],
-    padding=True,
-    return_tensors="pt"
-).to("cuda")
-
-generated_ids = model.generate(
-    **inputs,
-    max_new_tokens=256
-)
-
-output_text = processor.batch_decode(
-    [
-        out[len(inp):]
-        for inp, out in zip(inputs.input_ids, generated_ids)
-    ],
-    skip_special_tokens=True,
-    clean_up_tokenization_spaces=False
-)
-
-print(output_text[0])</code></pre>
-  </div>
-
-  <h2 style="color: #FFFFFF; font-size: 22px; font-weight: bold; border-bottom: 1px solid #444444; padding-bottom: 5px;">Training Details</h2>
-  <table class="vg-table">
-    <tr><th>Setting</th><th>Value</th></tr>
-    <tr><td><b>Base Model</b></td><td><b>Qwen/Qwen3.5-4B</b></td></tr>
-    <tr><td><b>Model</b></td><td><b>VisionGuardrail-4B</b></td></tr>
-    <tr><td><b>Model Type</b></td><td><b>Multimodal Content-Safety Classifier</b></td></tr>
-    <tr><td><b>Training Dataset</b></td><td><b>prithivMLmods/ImageShield-Guardrail-Pro</b></td></tr>
-    <tr><td><b>Training Objective</b></td><td><b>Content-safety guardrail classification</b></td></tr>
-    <tr><td><b>Primary Classification</b></td><td><b>Safe / Unsafe</b></td></tr>
-    <tr><td><b>Safety Focus</b></td><td><b>Not Safe for Work (NSFW) Sensual Content</b></td></tr>
-    <tr><td><b>Visual Analysis</b></td><td><b>Dress Codes, Poses, Exposure & Settings</b></td></tr>
-    <tr><td><b>Training Framework</b></td><td><b>TRL</b></td></tr>
-  </table>
-
-  <h2 style="color: #FFFFFF; font-size: 22px; font-weight: bold; border-bottom: 1px solid #444444; padding-bottom: 5px;">Intended Use</h2>
-  <ul class="vg-bullet">
-    <li><b>Content Safety Classification</b>: Classifying visual media as safe or unsafe.</li>
-    <li><b>NSFW Sensual Content Detection</b>: Supporting research into automated detection of potentially sensitive and sexually suggestive visual content.</li>
-    <li><b>Parental Controls</b>: Building conservative visual content-safety filtering systems.</li>
-    <li><b>Content Moderation</b>: Supporting automated safety classification pipelines.</li>
-    <li><b>Multimodal Safety Research</b>: Evaluating content-safety behavior in multimodal language models.</li>
-    <li><b>Guardrail Development</b>: Researching structured safety classification and filtering workflows.</li>
-    <li><b>Visual Safety Analysis</b>: Analyzing clothing, dress codes, poses, framing, and visual settings for content-safety signals.</li>
-  </ul>
-
-  <h2 style="color: #FFFFFF; font-size: 22px; font-weight: bold; border-bottom: 1px solid #444444; padding-bottom: 5px;">Limitations</h2>
-  <ul class="vg-bullet">
-    <li><b>Experimental Model</b>: The model may produce incorrect or inconsistent classifications.</li>
-    <li><b>False Positives</b>: Benign content may occasionally be classified as unsafe due to the conservative classification threshold.</li>
-    <li><b>False Negatives</b>: Unsafe content may occasionally be missed.</li>
-    <li><b>Context Sensitivity</b>: Classification performance depends on image quality, visual context, and the provided instruction.</li>
-    <li><b>Conservative Policy</b>: The model intentionally uses a strict classification threshold and may flag content that would not be considered NSFW under less restrictive moderation policies.</li>
-    <li><b>Visual Ambiguity</b>: Clothing, poses, artistic styles, and contextual cues may sometimes be difficult to interpret accurately.</li>
-    <li><b>Automated Classification</b>: The model should not be treated as a definitive legal or safety determination.</li>
-  </ul>
-
-  <h2 style="color: #FFFFFF; font-size: 22px; font-weight: bold; border-bottom: 1px solid #444444; padding-bottom: 5px;">Acknowledgements</h2>
-  <ul class="vg-bullet">
-    <li><a href="https://huggingface.co/Qwen/Qwen3.5-4B" class="vg-link">Qwen/Qwen3.5-4B</a>: Base multimodal model used for this project.</li>
-    <li><a href="https://huggingface.co/datasets/prithivMLmods/ImageShield-Guardrail-Pro" class="vg-link">ImageShield-Guardrail-Pro</a>: Content-safety guardrail dataset used for training VisionGuardrail-4B.</li>
-    <li><b>TRL</b> – <a href="https://huggingface.co/docs/trl/en/index" class="vg-link">Transformers Reinforcement Learning</a>: TRL is a full-stack library providing tools to train transformer language models with methods including Supervised Fine-Tuning (SFT), Group Relative Policy Optimization (GRPO), Direct Preference Optimization (DPO), Reward Modeling, and more.</li>
-    <li><a href="https://huggingface.co/docs/transformers/en/index" class="vg-link">Transformers</a>: Transformers provides state-of-the-art machine learning models for text, computer vision, audio, video, and multimodal tasks, supporting both inference and training.</li>
-  </ul>
-</div>
-
-<script>
-  function copyCode(btn) {
-    const codeBlock = btn.nextElementSibling.querySelector('code');
-    const textArea = document.createElement('textarea');
-    textArea.value = codeBlock.innerText;
-    document.body.appendChild(textArea);
-    textArea.select();
-    document.execCommand('copy');
-    document.body.removeChild(textArea);
-    btn.innerText = 'Copied!';
-    setTimeout(() => { btn.innerText = 'Copy'; }, 2000);
-  }
-</script>