Add README.md

README.md

@@ -0,0 +1,78 @@
+---
+license: apache-2.0
+base_model: baidu/ERNIE-Image-Turbo
+library_name: diffusers
+tags:
+- nunchaku-lite
+- quantized
+- ernie-image
+- ernie-image-turbo
+- text-to-image
+- svdquant
+- int4
+- fp4
+- diffusers
+---
+
+# ERNIE-Image-Turbo Nunchaku Lite
+
+This repository contains Nunchaku Lite SVDQuant checkpoints for [baidu/ERNIE-Image-Turbo](https://huggingface.co/baidu/ERNIE-Image-Turbo).
+
+- Runtime: [rootonchair/nunchaku-lite](https://github.com/rootonchair/nunchaku-lite.git)
+- Quantization framework: [rootonchair/diffuse-compressor](https://github.com/rootonchair/diffuse-compressor.git)
+
+## Checkpoints
+
+| File | Quantization | Rank | Recommended hardware |
+|---|---:|---:|---|
+| `svdq-int4_r32-ernie-image-turbo.safetensors` | INT4 | 32 | Turing, Ampere, Ada |
+| `svdq-nvfp4_r32-ernie-image-turbo.safetensors` | NVFP4 | 32 | Blackwell |
+
+## Benchmark Artifacts
+
+Detailed benchmark metadata is available in [`benchmarks/summary.json`](benchmarks/summary.json).
+
+![Benchmark comparison](benchmarks/comparison.png)
+
+| BF16 Diffusers | Nunchaku Lite |
+|---|---|
+| ![BF16 Diffusers sample](benchmarks/original_diffusers.png) | ![Nunchaku Lite sample](benchmarks/nunchaku_lite.png) |
+
+## Usage
+
+```python
+import torch
+from diffusers import ErnieImagePipeline
+from nunchaku_lite import load_nunchaku_pipeline
+
+pipe = load_nunchaku_pipeline(
+    "Baidu/ERNIE-Image-Turbo",
+    pipeline_cls=ErnieImagePipeline,
+    checkpoint="rootonchair/ERNIE-Image-Turbo-nunchaku-lite/svdq-nvfp4_r32-ernie-image-turbo.safetensors",
+    target="ernie_image",
+    precision="auto",
+    torch_dtype=torch.bfloat16,
+    device="cuda",
+).to("cuda")
+
+image = pipe(
+    prompt="This is a photograph depicting an urban street scene. Shot at eye level, it shows a covered pedestrian or commercial street. Slightly below the center of the frame, a cyclist rides away from the camera toward the background, appearing as a dark silhouette against backlighting with indistinct details. The ground is paved with regular square tiles, bisected by a prominent tactile paving strip running through the scene, whose raised textures are clearly visible under the light. Light streams in diagonally from the right side of the frame, creating a strong backlight effect with a distinct Tyndall effect-visible light beams illuminating dust or vapor in the air and casting long shadows across the street. Several pedestrians appear on the left side and in the distance, some with their backs to the camera and others walking sideways, all rendered as silhouettes or semi-silhouettes. The overall color palette is warm, dominated by golden yellows and dark browns, evoking the atmosphere of dusk or early morning.",
+    height=1264,
+    width=848,
+    num_inference_steps=8,
+    guidance_scale=1.0,
+    use_pe=True,
+).images[0]
+
+image.save("output.png")
+```
+
+For non-Blackwell GPUs, use the INT4 checkpoint instead:
+
+```python
+checkpoint="rootonchair/ERNIE-Image-Turbo-nunchaku-lite/svdq-int4_r32-ernie-image-turbo.safetensors"
+```
+
+## Citation
+
+This is a quantized derivative of [baidu/ERNIE-Image-Turbo](https://huggingface.co/baidu/ERNIE-Image-Turbo). Please follow the base model's license and citation guidance.