Update README.md

README.md

@@ -1,26 +1,29 @@
 ---
-license: fair-noncommercial-research-license
-base_model: aoxo/flux.1dev-abliteratedv2
+base_model:
+- aoxo/flux.1dev-abliteratedv2
 library_name: gguf
+pipeline_tag: text-to-image
 tags:
-  - flux
-  - flux.1-dev
-  - gguf
-  - quantized
-  - image-generation
-  - text-to-image
-  - comfyui
-  - comfyui-gguf
-  - abliterated
+- gguf
+- flux
+- flux.1-dev
+- quantized
+- image-generation
+- text-to-image
+- comfyui
+- comfyui-gguf
+- abliterated
+license: fair-noncommercial-research-license
 ---
 
-# FLUX.1-dev Abliterated V2 — Q4_K_M GGUF
+# Flux-12B Abliterated V2 — GGUF Q4_K_M
 
-> **A GGUF Q4_K_M quantization of [aoxo/flux.1dev-abliteratedv2](https://huggingface.co/aoxo/flux.1dev-abliteratedv2), optimized for local inference with limited VRAM.**
+A **GGUF Q4_K_M quantization** of [`aoxo/flux.1dev-abliteratedv2`](https://huggingface.co/aoxo/flux.1dev-abliteratedv2), prepared for **local inference with ComfyUI and ComfyUI-GGUF**.
 
-This repository provides a **Q4_K_M GGUF** version of the FLUX.1-dev Abliterated V2 model.
+This repository provides a compact quantized version of the Flux.1-dev Abliterated V2 model while preserving the original model's image-generation capabilities as closely as possible.
 
-The goal of this quantization is to make the model significantly more accessible on consumer hardware while retaining the overall capabilities and characteristics of the original model.
+> **This is a quantized conversion, not the original model.**
+> Please refer to the original repository for the source model, license, and full model information.
 
 ---
 
@@ -28,28 +31,176 @@ The goal of this quantization is to make the model significantly more accessible
 
 **Base model:** [`aoxo/flux.1dev-abliteratedv2`](https://huggingface.co/aoxo/flux.1dev-abliteratedv2)
 
-**Original architecture:** FLUX.1-dev
+**Architecture:** FLUX.1-dev / 12B
+
+**Format:** GGUF
 
 **Quantization:** `Q4_K_M`
 
-**Format:** `GGUF`
+**Task:** Text-to-Image
+
+**Recommended environment:** ComfyUI + ComfyUI-GGUF
+
+---
+
+## 🚀 Why GGUF?
+
+GGUF provides a convenient way to run large models locally with reduced memory requirements.
+
+The `Q4_K_M` quantization provides a strong balance between:
+
+* 🧠 Model quality
+* 💾 File size
+* ⚡ Inference performance
+* 🖥️ VRAM requirements
+
+GGUF is supported by a growing ecosystem of local inference tools and includes model metadata directly inside the file.
+
+---
+
+# 🖥️ ComfyUI
+
+This model is intended primarily for use with **ComfyUI** through **ComfyUI-GGUF**.
+
+### Requirements
+
+* ComfyUI
+* ComfyUI-GGUF
+* A compatible Flux workflow
+* Sufficient system RAM / VRAM for Flux inference
 
-**Intended use:** Local image generation / text-to-image
+### Installation
 
-**Primary frontend:** ComfyUI + ComfyUI-GGUF
+1. Install **ComfyUI**.
+2. Install the **ComfyUI-GGUF** custom node.
+3. Download the `.gguf` file from the **Files and versions** section of this repository.
+4. Place the GGUF model in the appropriate model directory used by your ComfyUI-GGUF setup.
+5. Load a Flux workflow that supports GGUF models.
+6. Select the downloaded `Q4_K_M` model.
+
+> The exact folder may depend on your ComfyUI-GGUF configuration and workflow.
 
 ---
 
-## 📦 File
+# 📦 Quantization
+
+This repository currently provides:
+
+| Quantization | Format |
+| ------------ | ------ |
+| **Q4_K_M**   | GGUF   |
+
+`Q4_K_M` is a 4-bit K-quantization variant designed to provide a useful compromise between model size and quality. Hugging Face documents Q4_K as a 4-bit quantization family, with K-quant variants designed around block/super-block quantization.
+
+---
+
+# 🎨 Usage
+
+The model is designed for local image generation.
+
+A typical workflow is:
 
-| File | Quantization | Format |
-|---|---|---|
-| `flux-abliterated-v2-Q4_K_M.gguf` | Q4_K_M | GGUF |
+```text
+Prompt
+   ↓
+Flux Text Encoder
+   ↓
+Flux GGUF Q4_K_M
+   ↓
+Sampler
+   ↓
+VAE
+   ↓
+Generated Image
+```
 
-The Q4_K_M quantization is intended to provide a practical balance between **model size, memory usage and generation quality**.
+Use your preferred Flux.1-dev workflow and replace the transformer/model component with the GGUF version where supported.
 
 ---
 
-# 🚀 ComfyUI
+# ⚙️ Performance
+
+Actual performance depends heavily on:
+
+* GPU model
+* Available VRAM
+* System RAM
+* ComfyUI configuration
+* Resolution
+* Number of sampling steps
+* CPU/GPU offloading
+* Flux workflow
+
+Because of this, VRAM and generation-speed figures are intentionally not specified here unless they have been measured on a particular hardware configuration.
+
+---
+
+# 🧪 Model Status
+
+This is an **unofficial GGUF conversion** of the original abliterated Flux model.
+
+The goal of this release is to make the model more accessible to users who want to run it locally with a smaller memory footprint.
+
+If you encounter:
+
+* corrupted output,
+* loading errors,
+* unexpected artifacts,
+* incorrect tensor loading,
+* or other compatibility problems,
+
+please open an issue or leave feedback on the repository.
+
+---
+
+# 📜 Credits
+
+### Original model
+
+**aoxo/flux.1dev-abliteratedv2**
+
+https://huggingface.co/aoxo/flux.1dev-abliteratedv2
+
+All credit for the original model and its underlying work belongs to the original authors.
+
+### GGUF conversion
+
+**anlord**
+
+This repository contains the GGUF quantized conversion published by **anlord**.
+
+---
+
+# ⚠️ License
+
+The original model is distributed under:
+
+**Fair Noncommercial Research License**
+
+Please read and comply with the original model's license before downloading, using, modifying, or redistributing this model.
+
+The license of the original model takes precedence over any assumptions made from this README.
+
+---
+
+# ⭐ Feedback
+
+If this model is useful to you, consider leaving a ⭐ on the repository.
+
+Feedback, generation examples, bug reports, and suggestions for additional quantizations are welcome.
+
+---
+
+## 🔗 Links
+
+* **This GGUF:** https://huggingface.co/anlord/Flux-12B-abliterated-V2-GGUF
+* **Original model:** https://huggingface.co/aoxo/flux.1dev-abliteratedv2
+* **Hugging Face GGUF documentation:** https://huggingface.co/docs/hub/gguf
+
+---
+
+### About this release
+
+**Flux-12B Abliterated V2 — GGUF Q4_K_M**
 
-This model is designed to work with **[ComfyUI](https://github.com/comfyanonymous/ComfyUI)** using **[ComfyUI-GGUF](https://github.com/city96/ComfyUI-GGUF)**.
+A community GGUF quantization prepared by **anlord** for convenient local inference.