ollamadiffuser 1.1.6__py3-none-any.whl → 1.2.1__py3-none-any.whl

{ollamadiffuser-1.1.6.dist-info → ollamadiffuser-1.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ollamadiffuser
-Version: 1.1.6
+Version: 1.2.1
 Summary: 🎨 Local AI Image Generation with Ollama-style CLI for Stable Diffusion, FLUX.1, and LoRA support
 Home-page: https://github.com/ollamadiffuser/ollamadiffuser
 Author: OllamaDiffuser Team
@@ -52,15 +52,16 @@ Requires-Dist: psutil>=5.9.0
 Requires-Dist: jinja2>=3.0.0
 Requires-Dist: peft>=0.10.0
 Requires-Dist: numpy>=1.21.0
+Requires-Dist: controlnet-aux>=0.0.7
+Requires-Dist: opencv-python>=4.8.0
+Requires-Dist: stable-diffusion-cpp-python>=0.1.0
+Requires-Dist: gguf>=0.1.0
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0.0; extra == "dev"
 Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
 Requires-Dist: black>=23.0.0; extra == "dev"
 Requires-Dist: isort>=5.12.0; extra == "dev"
 Requires-Dist: flake8>=6.0.0; extra == "dev"
-Provides-Extra: full
-Requires-Dist: controlnet-aux>=0.0.7; extra == "full"
-Requires-Dist: opencv-python>=4.8.0; extra == "full"
 Dynamic: author
 Dynamic: home-page
 Dynamic: license-file
@@ -81,11 +82,69 @@ Dynamic: requires-python
 
 ---
 
+## 🔑 Hugging Face Authentication
+
+**Do you need a Hugging Face token?** It depends on which models you want to use!
+
+### 🟢 Models that DON'T require a token:
+- **FLUX.1-schnell** - Apache 2.0 license, ready to use ✅
+- **Stable Diffusion 1.5** - Basic model, no authentication needed ✅
+- **Most ControlNet models** - Generally public access ✅
+
+### 🟡 Models that DO require a token:
+- **FLUX.1-dev** - Requires HF token and license agreement ⚠️
+- **Stable Diffusion 3.5** - Requires HF token and license agreement ⚠️
+- **Some premium LoRAs** - Gated models from Hugging Face ⚠️
+
+### 🚀 Quick Setup
+
+**For basic usage** (no token needed):
+```bash
+# These work immediately without any setup:
+ollamadiffuser pull flux.1-schnell
+ollamadiffuser pull stable-diffusion-1.5
+```
+
+**For advanced models** (token required):
+```bash
+# 1. Set your token
+export HF_TOKEN=your_token_here
+
+# 2. Now you can access gated models
+ollamadiffuser pull flux.1-dev
+ollamadiffuser pull stable-diffusion-3.5-medium
+```
+
+### 🔧 How to get a Hugging Face token:
+
+1. **Create account**: Visit [huggingface.co](https://huggingface.co) and sign up
+2. **Generate token**: Go to Settings → Access Tokens → Create new token
+3. **Accept licenses**: Visit the model pages and accept license agreements:
+   - [FLUX.1-dev](https://huggingface.co/black-forest-labs/FLUX.1-dev)
+   - [Stable Diffusion 3.5](https://huggingface.co/stabilityai/stable-diffusion-3.5-medium)
+4. **Set environment variable**:
+   ```bash
+   # Temporary (current session)
+   export HF_TOKEN=your_token_here
+   
+   # Permanent (add to ~/.bashrc or ~/.zshrc)
+   echo 'export HF_TOKEN=your_token_here' >> ~/.bashrc
+   ```
+
+### 💡 Pro Tips:
+- **Start simple**: Begin with FLUX.1-schnell (no token required, commercial use OK)
+- **Token scope**: Use "read" permissions for downloading models
+- **Privacy**: Your token stays local - never shared with OllamaDiffuser servers
+- **Troubleshooting**: If downloads fail, verify your token and model access permissions
+
+---
+
 ## ✨ Features
 
 - **🚀 Fast Startup**: Instant application launch with lazy loading architecture
 - **🎛️ ControlNet Support**: Precise image generation control with 10+ control types
 - **🔄 LoRA Integration**: Dynamic LoRA loading and management
+- **📦 GGUF Support**: Memory-efficient quantized models (3GB VRAM minimum!)
 - **🌐 Multiple Interfaces**: CLI, Python API, Web UI, and REST API
 - **📦 Model Management**: Easy installation and switching between models
 - **⚡ Performance Optimized**: Memory-efficient with GPU acceleration
@@ -109,6 +168,18 @@ curl -X POST http://localhost:8000/api/generate \
   --output image.png
 ```
 
+### GGUF Quick Start (Low VRAM)
+```bash
+# For systems with limited VRAM (3GB+)
+pip install ollamadiffuser stable-diffusion-cpp-python gguf
+
+# Download memory-efficient GGUF model
+ollamadiffuser pull flux.1-dev-gguf-q4ks
+
+# Generate with reduced memory usage
+ollamadiffuser run flux.1-dev-gguf-q4ks
+```
+
 ### Option 2: Development Installation
 ```bash
 # Clone the repository
@@ -162,12 +233,26 @@ curl -X POST http://localhost:8000/api/generate/controlnet \
 
 Choose from a variety of state-of-the-art image generation models:
 
-| Model | License | Quality | Speed | Commercial Use |
-|-------|---------|---------|-------|----------------|
-| **FLUX.1-schnell** | Apache 2.0 | High | **4 steps** (12x faster) | ✅ Commercial OK |
-| **FLUX.1-dev** | Non-commercial | High | 50 steps | ❌ Non-commercial |
-| **Stable Diffusion 3.5** | CreativeML | Medium | 28 steps | ⚠️ Check License |
-| **Stable Diffusion 1.5** | CreativeML | Fast | Lightweight | ⚠️ Check License |
+| Model | License | Quality | Speed | Commercial Use | VRAM |
+|-------|---------|---------|-------|----------------|------|
+| **FLUX.1-schnell** | Apache 2.0 | High | **4 steps** (12x faster) | ✅ Commercial OK | 20GB+ |
+| **FLUX.1-dev** | Non-commercial | High | 50 steps | ❌ Non-commercial | 20GB+ |
+| **FLUX.1-dev-gguf** | Non-commercial | High | 4 steps | ❌ Non-commercial | **3-16GB** |
+| **Stable Diffusion 3.5** | CreativeML | Medium | 28 steps | ⚠️ Check License | 12GB+ |
+| **Stable Diffusion 1.5** | CreativeML | Fast | Lightweight | ⚠️ Check License | 6GB+ |
+
+### 💾 GGUF Models - Reduced Memory Requirements
+
+**NEW**: GGUF quantized models enable running FLUX.1-dev on budget hardware!
+
+| GGUF Variant | VRAM | Quality | Best For |
+|--------------|------|---------|----------|
+| `flux.1-dev-gguf-q4ks` | 6GB | ⭐⭐⭐⭐ | **Recommended** - RTX 3060/4060 |
+| `flux.1-dev-gguf-q3ks` | 4GB | ⭐⭐⭐ | Mobile GPUs, GTX 1660 Ti |
+| `flux.1-dev-gguf-q2k` | 3GB | ⭐⭐ | Entry-level hardware |
+| `flux.1-dev-gguf-q6k` | 10GB | ⭐⭐⭐⭐⭐ | RTX 3080/4070+ |
+
+📖 **[Complete GGUF Guide](GGUF_GUIDE.md)** - Hardware recommendations, installation, and optimization tips
 
 ### Why Choose FLUX.1-schnell?
 - **Apache 2.0 license** - Perfect for commercial use
@@ -305,6 +390,11 @@ else:
 - **Stable Diffusion 3**: Latest architecture
 - **FLUX.1**: State-of-the-art quality
 
+### GGUF Quantized Models
+- **FLUX.1-dev GGUF**: 7 quantization levels (3GB-16GB VRAM)
+- **Memory Efficient**: Run high-quality models on budget hardware
+- **Same API**: Works seamlessly with existing commands
+
 ### ControlNet Models
 - **SD 1.5 ControlNet**: 4 control types (canny, depth, openpose, scribble)
 - **SDXL ControlNet**: 2 control types (canny, depth)
@@ -338,6 +428,19 @@ image = engine.generate_image(
 )
 ```
 
+### GGUF Model Usage
+```bash
+# Check GGUF support
+ollamadiffuser registry check-gguf
+
+# Download GGUF model for your hardware
+ollamadiffuser pull flux.1-dev-gguf-q4ks  # 6GB VRAM
+ollamadiffuser pull flux.1-dev-gguf-q3ks  # 4GB VRAM
+
+# Use with optimized settings
+ollamadiffuser run flux.1-dev-gguf-q4ks
+```
+
 ### Batch Processing
 ```python
 from ollamadiffuser.core.utils.controlnet_preprocessors import controlnet_preprocessor
@@ -375,6 +478,7 @@ with open("control.jpg", "rb") as f:
 
 ## 📚 Documentation & Guides
 
+- **[GGUF Models Guide](GGUF_GUIDE.md)**: Complete guide to memory-efficient GGUF models
 - **[ControlNet Guide](CONTROLNET_GUIDE.md)**: Comprehensive ControlNet usage and examples
 - **[Website Documentation](https://www.ollamadiffuser.com/)**: Complete tutorials and guides
 
@@ -386,10 +490,17 @@ with open("control.jpg", "rb") as f:
 - **Python**: 3.8+
 
 ### Recommended Hardware
+
+#### For Regular Models
 - **GPU**: 8GB+ VRAM (NVIDIA/AMD)
 - **RAM**: 16GB+ system RAM
 - **Storage**: SSD with 50GB+ free space
 
+#### For GGUF Models (Memory Efficient)
+- **GPU**: 3GB+ VRAM (or CPU only)
+- **RAM**: 8GB+ system RAM (16GB+ for CPU inference)
+- **Storage**: SSD with 20GB+ free space
+
 ### Supported Platforms
 - **CUDA**: NVIDIA GPUs (recommended)
 - **MPS**: Apple Silicon (M1/M2/M3)
@@ -420,6 +531,18 @@ pip install "ollamadiffuser[full]"
 pip install 'ollamadiffuser[full]'
 ```
 
+#### GGUF Support Issues
+```bash
+# Install GGUF dependencies
+pip install stable-diffusion-cpp-python gguf
+
+# Check GGUF support
+ollamadiffuser registry check-gguf
+
+# See full GGUF troubleshooting guide
+# Read GGUF_GUIDE.md for detailed troubleshooting
+```
+
 #### Complete Dependency Check
 ```bash
 # Run comprehensive system diagnostics
@@ -474,6 +597,10 @@ curl -X POST http://localhost:8000/api/controlnet/initialize
 
 #### Memory Issues
 ```bash
+# Use GGUF models for lower memory usage
+ollamadiffuser pull flux.1-dev-gguf-q4ks  # 6GB VRAM
+ollamadiffuser pull flux.1-dev-gguf-q3ks  # 4GB VRAM
+
 # Use smaller image sizes via API
 curl -X POST http://localhost:8000/api/generate \
   -H "Content-Type: application/json" \
@@ -492,12 +619,18 @@ curl -X POST http://localhost:8000/api/generate \
 # If you encounter OpenCV issues on Apple Silicon
 pip uninstall opencv-python
 pip install opencv-python-headless>=4.8.0
+
+# For GGUF Metal acceleration
+CMAKE_ARGS="-DSD_METAL=ON" pip install stable-diffusion-cpp-python
 ```
 
 #### Windows
 ```bash
 # If you encounter build errors
 pip install --only-binary=all opencv-python>=4.8.0
+
+# For GGUF CUDA acceleration
+CMAKE_ARGS="-DSD_CUDA=ON" pip install stable-diffusion-cpp-python
 ```
 
 #### Linux
@@ -540,6 +673,8 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 ## 🙏 Acknowledgments
 
 - **Stability AI**: For Stable Diffusion models
+- **Black Forest Labs**: For FLUX.1 models
+- **city96**: For FLUX.1-dev GGUF quantizations
 - **Hugging Face**: For model hosting and diffusers library
 - **ControlNet Team**: For ControlNet architecture
 - **Community**: For feedback and contributions

{ollamadiffuser-1.1.6.dist-info → ollamadiffuser-1.2.1.dist-info}/RECORD

@@ -1,20 +1,23 @@
-ollamadiffuser/__init__.py,sha256=DWqHxjTy1ekkwx7FhVOWIannwUuINWT2aPNKNOEcC7o,1127
+ollamadiffuser/__init__.py,sha256=n9dmXqrOp56VjdptVANGVeHea_UiuGHqP1d-b6dyq6g,1127
 ollamadiffuser/__main__.py,sha256=tNWMvEHq4ddtKLp7DrhIoOdnFw3F8RNrETC_u5xpkFI,141
 ollamadiffuser/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ollamadiffuser/api/server.py,sha256=4-3gT8W1404bxvJ7y9htvKbd2yxrrbtAUvT7shOlJss,17679
+ollamadiffuser/api/server.py,sha256=kc-Up50zmLfSM4f4InYR4Btkl35lyEN6UFcxlvxICSQ,18237
 ollamadiffuser/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ollamadiffuser/cli/commands.py,sha256=Pe0vyfGiffwd10QlVxBCTtNnMqHi8nJ3oNn_k8nAi5k,8903
-ollamadiffuser/cli/main.py,sha256=Iea_jVRu_Z3CViIcRTZM_SQJ7jtx91ZNaRvilxXqfqk,41908
+ollamadiffuser/cli/main.py,sha256=qj0VKTOjw_gox2dPVtbU-9kCo25TqshyVyqW8qsv4Pk,56081
 ollamadiffuser/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ollamadiffuser/core/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ollamadiffuser/core/config/model_registry.py,sha256=o408Qk-UQJ4NBM-AcyWAj4EhRUzrvl6zdOkKk1-ATHg,31238
 ollamadiffuser/core/config/settings.py,sha256=VhI1vLGmOAQ7-XtyHrT5KoMpcGeGt-Mij-9NxX_ZKsI,4881
 ollamadiffuser/core/inference/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ollamadiffuser/core/inference/engine.py,sha256=ky76lAjWexlrgmHSZZILa3FPQP7xx2WQ0_DdW34M9Xk,57808
+ollamadiffuser/core/inference/engine.py,sha256=-EVcH4NyRVBQ-puvI_Az3KOZJYG9b-ySzsvoBTY3mlY,73962
 ollamadiffuser/core/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ollamadiffuser/core/models/manager.py,sha256=vO1Az_aO5lZKMgSyK_6j2wT5nzPMowZgKhcH2mQVLkI,24139
+ollamadiffuser/core/models/gguf_loader.py,sha256=ocfl3_MDVXC9nSjW8YJdz4kX1Q-Qe2ltu6w4fbqhxVY,35724
+ollamadiffuser/core/models/manager.py,sha256=rTEAameGih3wPcVG_Y-4k_brBeEqEoBjoI7fjggNtiY,16799
+ollamadiffuser/core/models/registry.py,sha256=YPx3xcHnCHogyowi9fQ6oXZg7_jz0fM5bDyyg-BgSFY,15125
 ollamadiffuser/core/utils/__init__.py,sha256=ZdXZWX1hfDnnV6OmRD6UStNljDJIQ892da2CtC-zdDw,31
 ollamadiffuser/core/utils/controlnet_preprocessors.py,sha256=v21X_Bk-a4gKbUZUKoeP2W8TSGlv-ST8IYNsn3NrZ2c,15446
-ollamadiffuser/core/utils/download_utils.py,sha256=DvCt-cjH6WSBJniJT112b4a9AUzlwOYhQtPuEfISmtM,20961
+ollamadiffuser/core/utils/download_utils.py,sha256=dqHf7loKSqDHzgQEV-p1kDwoHxwlgurLPX8J96vD5fA,22421
 ollamadiffuser/core/utils/lora_manager.py,sha256=SrZydPSGJqCS_Vek35bEdG2Q51qCOLZmPvnNzUjjIN0,14328
 ollamadiffuser/ui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ollamadiffuser/ui/web.py,sha256=hK41sF9uVR_14lc4AlTXaGjw5m7aiJXpVp1cSOOmkT8,27715
@@ -34,9 +37,9 @@ ollamadiffuser/ui/samples/scribble/face_sketch.png,sha256=MVVYy_aS48xoS_RnIDzLUa
 ollamadiffuser/ui/samples/scribble/tree_sketch.png,sha256=3P-NGgW25xRwreDxiBYKcDhd2oHZAwKSkjNVM5oPTWY,3017
 ollamadiffuser/ui/templates/index.html,sha256=qTQVFxiTbeZ90O-iNqWC_4pYP6yyIs2z6U69VJPqAB4,38176
 ollamadiffuser/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ollamadiffuser-1.1.6.dist-info/licenses/LICENSE,sha256=cnGL9l2P510Uk3TCnv62kot6vAfdSawhOZh7Y-oYoIE,1071
-ollamadiffuser-1.1.6.dist-info/METADATA,sha256=bDoFxbnLvkp40zA1PIkGDXBvznaS7FQ2PEKPimPLfJI,17070
-ollamadiffuser-1.1.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ollamadiffuser-1.1.6.dist-info/entry_points.txt,sha256=tHXXO3N0GSnIobDe_eSOLfHPjjVFjeTg2Fd-APoD6sY,64
-ollamadiffuser-1.1.6.dist-info/top_level.txt,sha256=97wOGgTCxDE765Nr_o7B4Kwr_M_jy8fCCeQ81sMKlC4,15
-ollamadiffuser-1.1.6.dist-info/RECORD,,
+ollamadiffuser-1.2.1.dist-info/licenses/LICENSE,sha256=cnGL9l2P510Uk3TCnv62kot6vAfdSawhOZh7Y-oYoIE,1071
+ollamadiffuser-1.2.1.dist-info/METADATA,sha256=FoUPXS8xMBHOSfMgQcv2E1ITGhPU2IwF_nDU7BBHvQs,21756
+ollamadiffuser-1.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ollamadiffuser-1.2.1.dist-info/entry_points.txt,sha256=tHXXO3N0GSnIobDe_eSOLfHPjjVFjeTg2Fd-APoD6sY,64
+ollamadiffuser-1.2.1.dist-info/top_level.txt,sha256=97wOGgTCxDE765Nr_o7B4Kwr_M_jy8fCCeQ81sMKlC4,15
+ollamadiffuser-1.2.1.dist-info/RECORD,,