Pipeworks Image Generator

User Guide

  • Installation
    • Requirements
    • Installation Methods
      • From PyPI (Recommended)
      • From Source
    • Environment Configuration
    • Verification
    • Troubleshooting
      • CUDA Not Available
      • Memory Issues
  • Quickstart Guide
    • Using the Web UI
    • Using the Python API
      • Text-to-Image
      • Generate and Save
      • Batch Generation
      • Using Character Conditions
      • Using the Prompt Builder
    • Next Steps
  • Character Conditions System
    • Overview
    • Key Features
      • Weighted Probability
      • Semantic Exclusions
      • Mandatory/Optional Axes
    • Usage
      • Basic Generation
      • Reproducible Generation
      • Integration with Image Generation
      • Dynamic Conditions
    • UI Integration
    • Architecture
      • Data Structures
      • Generation Process
    • API Reference

API Reference

  • Core API Reference
    • Image Generation
    • Configuration
      • Environment Variable Loading
      • Global Configuration Instance
      • Usage Example
      • Directory Management
      • Z-Image-Turbo Constraints
      • Performance Optimisation Settings
      • GpuWorkerConfig
        • GpuWorkerConfig.id
        • GpuWorkerConfig.label
        • GpuWorkerConfig.mode
        • GpuWorkerConfig.base_url
        • GpuWorkerConfig.bearer_token
        • GpuWorkerConfig.timeout_seconds
        • GpuWorkerConfig.enabled
        • GpuWorkerConfig.model_config
      • PipeworksConfig
        • PipeworksConfig.Paths
        • PipeworksConfig.model_config
        • PipeworksConfig.torch_dtype
        • PipeworksConfig.device
        • PipeworksConfig.num_inference_steps
        • PipeworksConfig.guidance_scale
        • PipeworksConfig.default_width
        • PipeworksConfig.default_height
        • PipeworksConfig.enable_attention_slicing
        • PipeworksConfig.enable_model_cpu_offload
        • PipeworksConfig.compile_model
        • PipeworksConfig.attention_backend
        • PipeworksConfig.models_dir
        • PipeworksConfig.outputs_dir
        • PipeworksConfig.static_dir
        • PipeworksConfig.data_dir
        • PipeworksConfig.gallery_dir
        • PipeworksConfig.templates_dir
        • PipeworksConfig.server_host
        • PipeworksConfig.server_port
        • PipeworksConfig.disable_http_cache
        • PipeworksConfig.gpu_workers
        • PipeworksConfig.default_gpu_worker_id
        • PipeworksConfig.worker_api_bearer_tokens
        • PipeworksConfig.remote_worker_max_batch_size
        • PipeworksConfig.remote_worker_max_decoded_bytes
        • PipeworksConfig.get_enabled_gpu_workers()
        • PipeworksConfig.resolve_default_gpu_worker_id()
        • PipeworksConfig.worker_api_tokens()
        • PipeworksConfig.__init__()
        • PipeworksConfig.gallery_db
    • Prompt Builder
    • Character Conditions
    • Model Adapters
    • Tokenizer
  • UI API Reference
    • UI Components
    • UI Models
    • UI State Management
    • Event Handlers
      • Generation Handlers
      • Prompt Handlers
      • Navigation Handlers
    • Validation
    • Formatting
    • Adapters

Additional Resources

  • Model Adapter System
    • Overview
    • Architecture
    • Basic Usage
      • Programmatic API
        • Text-to-Image Generation (Z-Image-Turbo)
        • Image Editing (Qwen-Image-Edit)
      • Using with Workflows
      • Plugin System Integration
    • Configuration
      • Environment Variables
      • Python Configuration
    • UI Integration
      • UI State Management
      • Model Selection Dropdown (Future Enhancement)
    • Interactive Fiction Game Use Case
    • Adding New Model Adapters
    • Model Adapter Interface
      • Required Methods
      • Model Types
      • Plugin Lifecycle Hooks
    • Available Models
      • Z-Image-Turbo
      • Qwen-Image-Edit
    • Troubleshooting
      • Model not loading
      • Model type mismatch
      • CUDA out of memory
    • Performance Tips
    • Future Enhancements
    • Examples
Pipeworks Image Generator
  • Search

© Copyright 2025, aapark.

Built with Sphinx using a theme provided by Read the Docs.