Update README.md

README.md

@@ -8,35 +8,196 @@ language:
 pipeline_tag: image-text-to-text
 tags:
 - gguf
+- llama.cpp
 - text-generation
+- imatrix
+- heretic
+- qwen3.5
+- mtp
+- uncensored
 - multimodal
 - vision
-- reasoning
-- thinking
-- agentic
-- tool-use
 - abliterated
-- uncensored
-- qwen3
-- imatrix
 - conversational
+- iq4_nl
+- q4_k_m
+- q5_k_m
+quantized_by: FadedRedStar
 ---
 
-# Qwen3.5-4B-heretic-imatrix — GGUF
+# 🤖 Qwen3.5-4B-heretic — Importance Matrix GGUF
+
+This repository hosts importance-matrix (imatrix) optimized GGUF weights, available in multiple quantization formats, and the associated vision projection matrix for **Qwen3.5-4B-heretic**, quantized from the source floating-point tensors provided by [coder3101/Qwen3.5-4B-heretic](https://huggingface.co/coder3101/Qwen3.5-4B-heretic).
+
+**🔄 Sister Repository:** Check out the [Standard GGUF Sister Repository](https://huggingface.co/FadedRedStar/Qwen3.5-4B-heretic-GGUF) for uncalibrated and full 8-bit precision options.
+
+## 🎯 Matrix-Weighted Calibration (Imatrix)
+
+An **Importance Matrix (imatrix)** calculation tracks activations across network layers using a calibration sequence, then weights the quantization process to preserve the parameters that matter most for output quality — improving fidelity at low bit depths.
+
+➡️ **Calibration dataset:** Bartowski's `calibration_datav5.txt`.
 
 > [!NOTE]
-> This card is a work in progress. Full architecture details, abliteration parameters, and inference instructions will be added shortly.
+> * **`IQ4_NL` is included** because the matrix enables a non-linear 4-bit format that outperforms standard linear 4-bit quantization.
+> * **`Q8_0` is absent** because 8-bit quantization already introduces near-zero degradation, making calibration unnecessary — see the standard sister repository for that variant.
+
+## ℹ️ Model Profile & Core Features
+
+**Qwen3.5-4B** is a dense multimodal transformer in the Qwen3.5 lineup by the Qwen Team (Alibaba), offering a strong balance of reasoning quality and inference cost. It carries forward the family's native vision encoder, 262,144-token context window, tool-calling support, and coverage of 201 languages and dialects.
+
+The **heretic** suffix denotes post-processing via **[Heretic v1.2.0](https://github.com/p-e-w/heretic)** with the **Multi-directional refusal suppression** method performed by [coder3101](https://huggingface.co/coder3101), which simultaneously targets multiple refusal directions across model layers to achieve a thorough and stable abliteration.
 
-This repository hosts importance-matrix (imatrix) calibrated GGUF weights and the associated vision projection matrix for **Qwen3.5-4B-heretic**, quantized from the source floating-point tensors provided by [coder3101/Qwen3.5-4B-heretic](https://huggingface.co/coder3101/Qwen3.5-4B-heretic).
+## 📋 Technical Specifications
 
-## Repository Files
+| Property | Value |
+|---|---|
+| **Base Architecture** | Qwen3.5 dense transformer (4B dense transformer) |
+| **Developed by** | Qwen Team (Alibaba) |
+| **Primary Use** | Multimodal reasoning, coding, tool use, agentic tasks |
+| **Context Window** | 262,144 tokens (extensible to ~1M) |
+| **Vision Encoder** | Integrated (early-fusion) |
+| **Languages** | 201 languages and dialects |
+| **Abliteration Tool** | Heretic v1.2.0 |
+| **Abliteration Method** | Multi-directional refusal suppression |
+| **Prompt Format** | ChatML |
 
-| Filename | Format | Size | llama.cpp Build | Description |
+## 🛠️ Heretic Overrides (ARA)
+
+| Property | Value |
+|---|---|
+| **direction_index** | 19.68 |
+| **attn.o_proj.max_weights** | [0: 0.84, 1: 1.26, 2: 1.00, 3: 1.01] |
+| **attn.o_proj.max_weight_position** | 19.26 |
+| **attn.o_proj.min_weights** | [0: 0.24, 1: 0.97, 2: 0.42, 3: 0.85] |
+| **attn.o_proj.min_weight_distance** | 5.26 |
+| **mlp.down_proj.max_weights** | [0: 1.09, 1: 0.95, 2: 1.02, 3: 1.04] |
+| **mlp.down_proj.max_weight_position** | 23.76 |
+| **mlp.down_proj.min_weights** | [0: 0.26, 1: 0.16, 2: 0.91, 3: 0.86] |
+| **mlp.down_proj.min_weight_distance** | 10.58 |
+
+## 📊 Refusal Bypass Metrics
+
+> [!NOTE]
+> The metrics below are self-reported by the original model author ([coder3101](https://huggingface.co/coder3101)) and have not been independently reproduced.
+
+| Metric | This model | Original ([Qwen/Qwen3.5-4B](https://huggingface.co/Qwen/Qwen3.5-4B)) |
+|---|---|---|
+| **KL divergence** | 0.0406 | 0 *(by definition)* |
+| **Refusals** | 4/100 | 94/100 |
+
+## 🧮 Numerical & Tensor Formats
+
+| Property | Value |
+|---|---|
+| **Text Tensor Types** | IQ4_NL, Q4_K_M, Q5_K_M (all with imatrix calibration) |
+| **Importance Matrix** | Bartowski's `calibration_datav5.txt` |
+| **Vision Tensors** | Q8_0, BF16 |
+
+## 📦 Available Model Files
+
+**Main model weights**
+| Filename | Quantization | llama.cpp Build | Size | Download |
 |---|---|---|---|---|
-| `Qwen3.5-4B-heretic-IQ4_NL-imatrix.gguf` | IQ4_NL | 2.61 GB | b9870 | Main model weights, imatrix-calibrated, smaller non-linear 4-bit quant |
-| `Qwen3.5-4B-heretic-Q4_K_M-imatrix.gguf` | Q4_K_M | 2.71 GB | b9870 | Main model weights, imatrix-calibrated |
-| `Qwen3.5-4B-heretic-Q5_K_M-imatrix.gguf` | Q5_K_M | 3.07 GB | b9870 | Main model weights, imatrix-calibrated, higher fidelity |
-| `mmproj-Qwen3.5-4B-heretic-BF16.gguf` | BF16 | 676 MB | b9870 | Vision projector (full precision) |
-| `mmproj-Qwen3.5-4B-heretic-Q8_0.gguf` | Q8_0 | 367 MB | b9870 | Vision projector (compact) |
-| `mtp-Qwen3.5-4B-heretic-BF16.gguf` | BF16 | 1.28 GB | b9870 | Multi-token prediction head (full precision) |
-| `mtp-Qwen3.5-4B-heretic-Q8_0.gguf` | Q8_0 | 686 MB | b9870 | Multi-token prediction head (compact) |
+| `Qwen3.5-4B-heretic-IQ4_NL-imatrix.gguf` | `IQ4_NL` | `b9870` | 2.43 GB | [📥 Download](https://huggingface.co/FadedRedStar/Qwen3.5-4B-heretic-imatrix-GGUF/resolve/main/Qwen3.5-4B-heretic-IQ4_NL-imatrix.gguf) |
+| `Qwen3.5-4B-heretic-Q4_K_M-imatrix.gguf` | `Q4_K_M` | `b9870` | 2.52 GB | [📥 Download](https://huggingface.co/FadedRedStar/Qwen3.5-4B-heretic-imatrix-GGUF/resolve/main/Qwen3.5-4B-heretic-Q4_K_M-imatrix.gguf) |
+| `Qwen3.5-4B-heretic-Q5_K_M-imatrix.gguf` | `Q5_K_M` | `b9870` | 2.86 GB | [📥 Download](https://huggingface.co/FadedRedStar/Qwen3.5-4B-heretic-imatrix-GGUF/resolve/main/Qwen3.5-4B-heretic-Q5_K_M-imatrix.gguf) |
+
+**mmproj — vision projector files**
+| Filename | Quantization | Size | Download |
+|---|---|---|---|
+| `mmproj-Qwen3.5-4B-heretic-Q8_0.gguf` | `Q8_0` | 350 MB | [📥 Download](https://huggingface.co/FadedRedStar/Qwen3.5-4B-heretic-imatrix-GGUF/resolve/main/mmproj-Qwen3.5-4B-heretic-Q8_0.gguf) |
+| `mmproj-Qwen3.5-4B-heretic-BF16.gguf` | `BF16` | 644 MB | [📥 Download](https://huggingface.co/FadedRedStar/Qwen3.5-4B-heretic-imatrix-GGUF/resolve/main/mmproj-Qwen3.5-4B-heretic-BF16.gguf) |
+
+**mtp — speculative decoding draft files**
+| Filename | Quantization | Size | Download |
+|---|---|---|---|
+| `mtp-Qwen3.5-4B-heretic-Q8_0.gguf` | `Q8_0` | 655 MB | [📥 Download](https://huggingface.co/FadedRedStar/Qwen3.5-4B-heretic-imatrix-GGUF/resolve/main/mtp-Qwen3.5-4B-heretic-Q8_0.gguf) |
+| `mtp-Qwen3.5-4B-heretic-BF16.gguf` | `BF16` | 1.19 GB | [📥 Download](https://huggingface.co/FadedRedStar/Qwen3.5-4B-heretic-imatrix-GGUF/resolve/main/mtp-Qwen3.5-4B-heretic-BF16.gguf) |
+
+## 🎛️ Component Pairing Guide
+
+Download exactly **one** main weights file:
+
+* **`IQ4_NL`**: Non-linear 4-bit format, best choice for constrained memory when imatrix calibration is present.
+* **`Q4_K_M`**: Balanced 4-bit format suitable for most everyday use.
+* **`Q5_K_M`**: Higher-fidelity mid-range format recommended as a general default.
+
+**mmproj files** (optional): multimodal vision projectors. Pass one via the `--mmproj` flag in llama.cpp to enable image input.
+* **`BF16` (Recommended)**: Highest possible image processing accuracy. While older projectors were small, modern vision towers can hover around **1GB**. If you are tight on VRAM, it is completely viable to run this on system RAM (CPU) with a minimal performance penalty, saving your precious GPU space for the main model layers.
+* **`Q8_0`**: Cuts the projector file size and memory footprint in half (~500MB for larger 1GB files). Use this if you prefer to keep the vision tower hosted entirely on your GPU but need to claw back some VRAM to avoid Out-Of-Memory (OOM) crashes.
+
+**mtp files** (optional): multi-token-prediction draft models for speculative decoding. Pass one via the `--draft` flag in llama.cpp to speed up generation.
+* **`BF16` (Best Speed)**: Maximizes draft accuracy. The more accurate the draft model's predictions are, the higher your token acceptance rate, which translates directly into faster text generation. Use this if you have the VRAM headroom.
+* **`Q8_0` (Best VRAM Efficiency)**: Cuts the draft model size in half. Choose this if loading a heavy `BF16` draft model would force you to drop layers of your *main* model to system RAM, which would heavily tank your total performance.
+
+## ⚡ Deployment & Execution Commands
+
+> [!IMPORTANT]
+> The vision projector (`--mmproj`) must be supplied at runtime whenever image inputs are used. Omitting it disables multimodal capability entirely.
+
+> [!NOTE]
+> Qwen recommends the following sampling configuration for best results:
+> * Thinking mode for general tasks: `temperature=1.0`, `top_p=0.95`, `top_k=20`, `min_p=0.0`, `presence_penalty=1.5`, `repetition_penalty=1.0`
+> * Thinking mode for precise coding tasks (e.g., WebDev): `temperature=0.6`, `top_p=0.95`, `top_k=20`, `min_p=0.0`, `presence_penalty=0.0`, `repetition_penalty=1.0`
+> * Instruct (or non-thinking) mode for general tasks: `temperature=0.7`, `top_p=0.8`, `top_k=20`, `min_p=0.0`, `presence_penalty=1.5`, `repetition_penalty=1.0`
+> * Instruct (or non-thinking) mode for reasoning tasks: `temperature=1.0`, `top_p=0.95`, `top_k=20`, `min_p=0.0`, `presence_penalty=1.5`, `repetition_penalty=1.0`
+
+> [!NOTE]
+> This model thinks by default and will emit reasoning content before its final answer. To disable this, set `enable_thinking: False` if your inference stack supports it; standard llama.cpp does not expose this toggle directly, so expect reasoning output unless you strip it client-side.
+
+> [!TIP]
+> Swap the `-m` filename below for either quantized file depending on your size/quality trade-off preference.
+
+### llama.cpp CLI (with image)
+
+```bash
+./llama-cli \
+  -m Qwen3.5-4B-heretic-IQ4_NL-imatrix.gguf \
+  --mmproj mmproj-Qwen3.5-4B-heretic-Q8_0.gguf \
+  -c 8192 \
+  -ngl 99 \
+  --image "path/to/image.jpg" \
+  -p "<|im_start|>user\nDescribe what you see and answer any questions about the image.<|im_end|>\n<|im_start|>assistant\n"
+```
+
+### Speculative Decoding (MTP Acceleration)
+
+```bash
+./llama-cli \
+  -m Qwen3.5-4B-heretic-IQ4_NL-imatrix.gguf \
+  --draft mtp-Qwen3.5-4B-heretic-Q8_0.gguf \
+  -c 8192 \
+  -ngl 99 \
+  -p "<|im_start|>user\nDescribe what you see and answer any questions about the image.<|im_end|>\n<|im_start|>assistant\n"
+```
+
+### OpenAI-Compatible API Server
+
+```bash
+./llama-server \
+  --host 0.0.0.0 \
+  --port 8080 \
+  -m Qwen3.5-4B-heretic-IQ4_NL-imatrix.gguf \
+  --mmproj mmproj-Qwen3.5-4B-heretic-Q8_0.gguf \
+  -c 16384 \
+  -ngl 99 \
+  --flash-attn
+```
+
+## 💬 Chat Templates & Prompt Design (ChatML)
+
+```text
+<|im_start|>system
+You are a helpful multimodal assistant.<|im_end|>
+<|im_start|>user
+Your question or image payload here.<|im_end|>
+<|im_start|>assistant
+```
+
+## ⚠️ Safety & Operational Notes
+
+- This model is abliterated and will generate content that standard aligned models refuse. Use responsibly and in compliance with applicable laws.
+- Vision tensors are kept at BF16 or Q8_0 depending on the mmproj variant chosen, to preserve spatial feature quality.
+- Speculative decoding via the accompanying `mtp` draft model can meaningfully increase throughput on supported llama.cpp builds.
+- Imatrix calibration improves perplexity recovery compared to non-imatrix quantization, particularly on low-frequency tokens.
+- IQ4_NL produces a smaller file than Q4_K_M and tends to run faster on CPU and ARM devices; imatrix calibration narrows the quality gap between the two formats considerably.