Skip to main content

Web UI for FluxFlow text-to-image generation

Project description

FluxFlow UI

Web interface for FluxFlow text-to-image generation and training.

🚧 Model Availability Notice

Training In Progress: FluxFlow models are currently being trained. The UI is fully functional, but trained model checkpoints are not yet available for download.

When Available: Trained checkpoints will be published to MODEL_ZOO.md upon completion of training validation.

Current Capabilities: You can use this UI to:

  • Configure and launch training runs with your own datasets
  • Monitor training progress in real-time
  • Test the architecture with your own trained checkpoints

Installation

Note: This documentation describes v0.8.0. For the previous stable version (v0.4.0), see v0.4.0 documentation.

Prerequisites

Required:

  • Python 3.10 or higher
  • pip package manager
  • 8GB+ RAM (16GB+ recommended)

For GPU Training (Recommended):

  • NVIDIA GPU: CUDA 11.8+ with compatible drivers
  • Apple Silicon: macOS 12.3+ (for MPS support)
  • GPU VRAM: 8GB minimum, 16GB+ for high quality training

Verify Prerequisites:

python --version  # Should show 3.10 or higher
pip --version     # Should be installed
nvidia-smi        # (NVIDIA only) Should show GPU info

Production Install (v0.8.0 - Current Stable)

pip install fluxflow-ui

What gets installed:

  • fluxflow-ui - Web interface for training and generation
  • fluxflow-training - Training capabilities (automatically installed as dependency)
  • fluxflow core package (transitively installed)
  • CLI command: fluxflow-ui

Package available on PyPI: fluxflow-ui v0.8.0

⚠️ Note: v0.8.0 requires fluxflow-training>=0.8.0 and supports the pillar-attention flow architecture introduced in v0.8.0.

Development Install

git clone https://github.com/danny-mio/fluxflow-ui.git
cd fluxflow-ui
pip install -e ".[dev]"

⚠️ Security Warning

FluxFlow UI is designed for local development use only.

  • No authentication or authorization
  • File browser can access entire filesystem
  • Not hardened for production deployment

See SECURITY.md for details on security measures, limitations, and production deployment warnings.

Do not expose this application to the internet without additional security hardening.


Features

  • Training Interface: Configure and monitor training runs
    • Start/stop training, monitor loss curves and metrics, view sample generations
  • Generation Interface: Generate images from text prompts
    • Load trained models, adjust sampling parameters, batch generation support
  • Real-time Progress: Live training updates and logs
  • Model Management: Load and manage checkpoints
  • Interactive Controls: Adjust generation parameters in real-time

Quick Start

Launch the Web UI

FluxFlow UI supports two interfaces:

Flask (Primary - Recommended):

fluxflow-ui

Gradio (Alternative):

python -m fluxflow_ui.app

Then open your browser to http://localhost:7860

Note: Flask is the primary interface with full features. Gradio is provided as an alternative but may have limited functionality.

Classifier-Free Guidance (CFG)

✨ Available since v0.3.0: FluxFlow UI supports training and generation with Classifier-Free Guidance.

Training with CFG

To train models with CFG support:

  1. Navigate to the Training tab
  2. Expand the CFG Training section
  3. Set cfg_dropout_prob between 0.0-0.20 (recommended: 0.10-0.15)
    • This randomly drops text conditioning during training
    • Higher values = stronger CFG effect but may reduce unconditional quality
    • Set to 0.0 to disable CFG training

Generating with CFG

To use CFG during generation:

  1. Navigate to the Generation tab
  2. Load a checkpoint trained with cfg_dropout_prob > 0
  3. Expand the CFG Settings section
  4. Enable CFG and set parameters:
    • Enable CFG: Toggle on
    • Guidance Scale: 1.0-15.0 (recommended: 3.0-7.0)
      • 1.0 = no guidance
      • 3.0-7.0 = balanced quality/creativity
      • 7.0-15.0 = strong guidance (may oversaturate)
    • Negative Prompt (optional): Text to avoid in generation

Note: CFG requires 2× forward passes per sampling step, doubling generation time.

CFG Benefits

  • Better prompt adherence: Images follow text descriptions more closely
  • Higher quality: Improved coherence and detail
  • Negative prompts: Ability to steer away from unwanted features
  • Flexible control: Adjust guidance strength per generation

Package Contents

  • fluxflow_ui.tabs - UI tab implementations
  • fluxflow_ui.utils - Config management and training runners
  • fluxflow_ui.templates - HTML templates
  • fluxflow_ui.static - CSS and JavaScript assets

Configuration

The UI runs on http://0.0.0.0:7860 by default. To customize the host and port, modify the main() function in src/fluxflow_ui/app_flask.py.

Development

Install with development dependencies:

pip install -e ".[dev]"

Links

License

MIT License - see LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fluxflow_ui-0.8.0.tar.gz (49.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fluxflow_ui-0.8.0-py3-none-any.whl (43.3 kB view details)

Uploaded Python 3

File details

Details for the file fluxflow_ui-0.8.0.tar.gz.

File metadata

  • Download URL: fluxflow_ui-0.8.0.tar.gz
  • Upload date:
  • Size: 49.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for fluxflow_ui-0.8.0.tar.gz
Algorithm Hash digest
SHA256 01e8cf4de58d2432a4213527faad5a469b964eb8eb85749401f398019ac05641
MD5 4a25f509385ecac2fb542fb307225668
BLAKE2b-256 4ccebf765e0e87f06a5c1c908e07cf9de442ff787eb2cc4c2753809dc8088a96

See more details on using hashes here.

Provenance

The following attestation bundles were made for fluxflow_ui-0.8.0.tar.gz:

Publisher: ci.yml on danny-mio/fluxflow-ui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fluxflow_ui-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: fluxflow_ui-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 43.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for fluxflow_ui-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b43aa7dfc76d47fa20452a0d6cc0e07043092ddadc75df1fc5abff9e3c6faba0
MD5 38da1971b1dbac375336a09dbb4f7f94
BLAKE2b-256 6def95a682d92cf501766d6d1bfb7bf47d3f0a7a26685786926d106c579e442f

See more details on using hashes here.

Provenance

The following attestation bundles were made for fluxflow_ui-0.8.0-py3-none-any.whl:

Publisher: ci.yml on danny-mio/fluxflow-ui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page