Create README.md

README.md

@@ -0,0 +1,38 @@
+---
+license: apache-2.0
+base_model: stabilityai/stable-diffusion-xl-base-1.0
+tags:
+- ip-adapter
+- faceid
+- safetensors
+- controlnet
+- sdxl
+library_name: diffusers
+---
+
+# IP-Adapter FaceID Plus V2 SDXL (Flattened Safetensors)
+
+This repository contains the converted and flattened `.safetensors` version of the **IP-Adapter FaceID Plus V2** for SDXL. 
+
+## 🚀 Why this version?
+The original `.bin` weights provided by the authors use a nested dictionary structure (e.g., the `image_proj` key contains its own sub-dictionary). This often causes "KeyError" or "Expected Tensor but received dict" errors in various WebUIs and custom scripts.
+
+**This version:**
+- **Flattened Keys:** Converted nested dictionaries into a flat structure (e.g., `image_proj.0.weight`) compatible with [ComfyUI](https://github.com), [SD-WebUI-Forge](https://github.com), and [Easy Diffusion](https://easydiffusion.github.io).
+- **Safe Format:** Converted from Pickle (`.bin`) to `.safetensors` for faster loading and improved security.
+- **SDXL Native:** Specifically for use with SDXL 1.0 base models.
+
+## 🛠 Usage
+
+To use this model, you typically need three components:
+1. **This Model:** Place in your `models/ControlNet` folder.
+2. **FaceID LoRA:** You **must** use the matching [SDXL FaceID Plus v2 LoRA](https://huggingface.co) at a weight of ~0.5-0.7.
+3. **InsightFace:** Your environment must have the `insightface` library installed.
+
+### Recommended Settings:
+- **Preprocessor:** `ip-adapter_face_id_plus`
+- **ControlNet Strength:** 0.5 - 0.8 (Start at 0.6 if skin texture appears too harsh)
+- **Ending Control Step:** 0.7 - 0.8 (Helps blend skin textures naturally)
+
+## ⚖️ Credits
+Original weights and research by the [IP-Adapter Team](https://huggingface.co). Please refer to their repository for license details and original implementation.