Update README.md

README.md

@@ -1,41 +1,54 @@
+# FLUX\.2\-klein\-4B 整合GGUF权重包
+
+
+```Plain Text
 ---
 license: apache-2.0
 ---
-FLUX.2-klein-4B 整合GGUF权重包
+```
 
-模型说明
-本仓库为整合版权重仓库，仅做文件归集、整合打包，无任何权重训练、微调、参数修改操作：
-- GGUF量化Transformer主干：来源于 unsloth/FLUX.2-klein-4B-GGUF
-采用 Unsloth Dynamic 2.0 量化方案，关键层保留高精度，极致平衡推理速度与生成画质。
-- VAE、模型配置、原生配套资源：来源于官方基座 black-forest-labs/FLUX.2-klein-4B
-- 
-原始来源链接
-- GGUF量化主干模型：https://huggingface.co/unsloth/FLUX.2-klein-4B-GGUF
-- FLUX.2-klein-4B 官方原始基座：https://huggingface.co/black-forest-labs/FLUX.2-klein-4B
-- 
-修改说明
-本项目仅将两个上游仓库资源整合归集：将 Unsloth 量化的 GGUF Transformer 权重，与官方完整 VAE、模型配置文件合并为一体，方便本地 GGUF 推理、ComfyUI 及 diffusers 一键加载。未修改权重参数、未微调、未重量化、未蒸馏。
+## 模型说明
 
+本仓库为**整合版权重仓库**，仅做文件归集、整合打包，无任何权重训练、微调、参数修改操作：
 
+- **GGUF量化Transformer主干**：来源于 `unsloth/FLUX.2-klein-4B-GGUF`
+采用 Unsloth Dynamic 2\.0 量化方案，关键层保留高精度，极致平衡推理速度与生成画质。
 
+- **VAE、模型配置、原生配套资源**：来源于官方基座 `black-forest-labs/FLUX.2-klein-4B`
 
-快速使用 / 推理示例
+## 原始来源链接
 
+- GGUF量化主干模型：[https://huggingface\.co/unsloth/FLUX\.2\-klein\-4B\-GGUF](https://huggingface.co/unsloth/FLUX.2-klein-4B-GGUF)
+
+- FLUX\.2\-klein\-4B 官方原始基座：[https://huggingface\.co/black\-forest\-labs/FLUX\.2\-klein\-4B](https://huggingface.co/black-forest-labs/FLUX.2-klein-4B)
+
+## 修改说明
+
+本项目仅将两个上游仓库资源整合归集：将 Unsloth 量化的 GGUF Transformer 权重，与官方完整 VAE、模型配置文件合并为一体，方便本地diffusers  GGUF 推理、。**未修改权重参数、未微调、未重量化、未蒸馏**。
 
-安装依赖
-pip install torch sdnq diffusers huggingface-hub
-完整可运行代码
 
 
+## 快速使用 / 推理示例（官方标准写法）
 
+### 安装依赖
+
+```Plain Text
+pip install torch sdnq diffusers huggingface-hub
+```
+
+### 完整可运行代码
+
+```Plain Text
 import torch
 from sdnq import SDNQConfig
 from diffusers import Flux2KleinPipeline, Flux2Transformer2DModel, GGUFQuantizationConfig
 from huggingface_hub import hf_hub_download
 
+# 设备与精度配置
 device = "cuda"
 dtype = torch.bfloat16
 
+# 精准下载本仓库 GGUF 权重与配置文件
 gguf_path = hf_hub_download(
     repo_id="csssss/com2ai-klein-4b",
     filename="transformer/flux-2-klein-4b-Q8_0.gguf",
@@ -46,6 +59,7 @@ config_path = hf_hub_download(
     filename="transformer/config.json",
 )
 
+# 加载量化 Transformer
 transformer = Flux2Transformer2DModel.from_single_file(
     gguf_path, 
     quantization_config=GGUFQuantizationConfig(compute_dtype=dtype),
@@ -53,14 +67,17 @@ transformer = Flux2Transformer2DModel.from_single_file(
     config=config_path
 )
 
+# 加载完整 FLUX 推理管道（含官方VAE）
 pipe = Flux2KleinPipeline.from_pretrained(
     "csssss/com2ai-klein-4b",
     transformer=transformer,
     torch_dtype=dtype
 )
 
+# 显存优化
 pipe.enable_model_cpu_offload()
 
+# 文生图推理示例
 prompt = "A cat holding a sign that says hello world"
 image = pipe(
     prompt=prompt,
@@ -71,5 +88,8 @@ image = pipe(
     generator=torch.Generator(device=device).manual_seed(0)
 ).images[0]
 
+# 保存结果
 image.save("flux-klein.png")
 print("✅ 图像生成成功，已保存为 flux-klein.png")
+```
+