Update README.md
Browse files
README.md
CHANGED
|
@@ -1,5 +1,50 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: other
|
| 3 |
-
license_name: circlestone-labs-non-commercial-license
|
| 4 |
-
license_link: https://huggingface.co/circlestone-labs/Anima/blob/main/LICENSE.txt
|
| 5 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: other
|
| 3 |
+
license_name: circlestone-labs-non-commercial-license
|
| 4 |
+
license_link: https://huggingface.co/circlestone-labs/Anima/blob/main/LICENSE.txt
|
| 5 |
+
tags:
|
| 6 |
+
- stable-diffusion.cpp
|
| 7 |
+
- gguf
|
| 8 |
+
- anima
|
| 9 |
+
- image-generation
|
| 10 |
+
- quantized
|
| 11 |
+
---
|
| 12 |
+
|
| 13 |
+
# Anima - GGUF Quantized Models
|
| 14 |
+
|
| 15 |
+
These are GGUF quantized versions of the [Anima](https://huggingface.co/circlestone-labs/Anima) model, highly optimized for local inference on low-RAM devices (like smartphones via Termux or older PCs) using `stable-diffusion.cpp`.
|
| 16 |
+
|
| 17 |
+
⚠️ **Important Note:** Support for Anima is currently **experimental** and has not yet been merged into the `main` branch of `stable-diffusion.cpp`. To use these models, you must compile the engine using the specific fork/branch from [PR #1296](https://github.com/leejet/stable-diffusion.cpp/pull/1296).
|
| 18 |
+
|
| 19 |
+
## 📦 Available Formats
|
| 20 |
+
|
| 21 |
+
* **`anima-preview-Q4_K.gguf` :** Smallest footprint. Best for Low RAM.
|
| 22 |
+
* **`anima-preview-Q5_K.gguf` :** Balanced size and quality.
|
| 23 |
+
* **`anima-preview-Q6_K.gguf` :** High quality, requires slightly more memory.
|
| 24 |
+
|
| 25 |
+
## 🚀 How to Use
|
| 26 |
+
|
| 27 |
+
Ensure you have built `stable-diffusion.cpp` from the experimental Anima branch.
|
| 28 |
+
|
| 29 |
+
```bash
|
| 30 |
+
./bin/sd-cli \
|
| 31 |
+
--diffusion-model /path/to/anima-preview-Q4_K.gguf \
|
| 32 |
+
--llm /path/to/qwen_3_06b_base.safetensors \
|
| 33 |
+
--vae /path/to/qwen_image_vae.safetensors \
|
| 34 |
+
--vae-tiling \
|
| 35 |
+
--steps 30 \
|
| 36 |
+
--cfg-scale 4 \
|
| 37 |
+
-W 1024 -H 1024 \
|
| 38 |
+
-p "a cute blue cat in a park" \
|
| 39 |
+
-o output.png
|
| 40 |
+
|
| 41 |
+
```
|
| 42 |
+
|
| 43 |
+
*(Note: The `--vae-tiling` flag is highly recommended to prevent out-of-memory errors during the image decoding phase).*
|
| 44 |
+
|
| 45 |
+
## 🙌 Acknowledgments & Credits
|
| 46 |
+
|
| 47 |
+
* **Original Model:** [circlestone-labs](https://huggingface.co/circlestone-labs).
|
| 48 |
+
* **Engine:** The [stable-diffusion.cpp](https://github.com/leejet/stable-diffusion.cpp) project for making local AI accessible.
|
| 49 |
+
* **Implementation:** Special thanks to GitHub contributor [@rmatif](https://github.com/rmatif) for developing Anima support in [PR #1296](https://github.com/leejet/stable-diffusion.cpp/pull/1296).
|
| 50 |
+
* **License:** These files are subject to the **circlestone-labs-non-commercial-license**.
|