Skip to content

Commit

Permalink
feat(README): update with additional details on Flux LoRA model
Browse files Browse the repository at this point in the history
- Add information about Flux LoRA model's support for various LoRAs, including Dreambooth and Style LoRAs
- Clarify that custom LoRAs can be used by providing a Huggingface path or URL
- Add troubleshooting section with common steps to address issues
- Update section on Replicate model with more concise and informative content
  • Loading branch information
rtuszik committed Aug 21, 2024
1 parent 59e366b commit b9d062a
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# Image Generator GUI

## Overview

This Image Generator GUI is a Python application that provides a user-friendly interface for generating images using the [LucaTaco Flux-Dev LoRA explorer](https://replicate.com/lucataco/flux-dev-lora/readme) via Replicate. It allows users to input prompts, adjust various parameters, and generate high-quality images with ease.
The Image Generator GUI is a Python application that provides a user-friendly interface for generating images using the [LucaTaco Flux-Dev LoRA explorer](https://replicate.com/lucataco/flux-dev-lora/readme) via Replicate. This tool allows users to input prompts, adjust various parameters, and generate high-quality images with ease.

## Features

- User-friendly graphical interface
- Intuitive graphical user interface
- Real-time token counting with warnings for exceeding token limits
- Customizable image generation parameters:
- Aspect ratio
Expand All @@ -19,6 +17,8 @@ This Image Generator GUI is a Python application that provides a user-friendly i
- Image preview with full-size viewing capability
- Option to automatically save generated images
- Persistent settings between sessions
- Toggle between grid and list view for generated images
- Ability to interrupt ongoing image generation

## Installation

Expand Down Expand Up @@ -48,24 +48,29 @@ This Image Generator GUI is a Python application that provides a user-friendly i
3. Adjust the generation parameters as desired.
4. Click "Generate Images" to create your images.
5. Click on the generated thumbnails to view them in full size.
6. Use the "Toggle View" button to switch between grid and list views of the gallery.
7. The "Interrupt Generation" button allows you to stop the image generation process if needed.

## About the Replicate Model

This application uses the Flux-Dev LoRA model implemented via Huggingface Diffusers. Key points about the model:

- It supports various LoRAs, including Dreambooth and Style LoRAs.
- You can use custom LoRAs by providing a Huggingface path or URL.
- The model has a maximum token limit of 77 tokens for prompts.

### Licensing and Commercial Use

- Images generated on Replicate with FLUX.1 models and their fine-tunes can be used commercially.
- If you download the weights and generate images locally, commercial use is not permitted.
- Supports various LoRAs, including Dreambooth and Style LoRAs.
- Allows use of custom LoRAs by providing a Huggingface path or URL.

## Contributing

Contributions to improve the Image Generator GUI are welcome. Please feel free to submit pull requests or open issues for bugs and feature requests.

## Troubleshooting

If you encounter any issues:
1. Ensure your Replicate API key is correctly set in the `.env` file.
2. Check that all dependencies are installed correctly.
3. Verify that you have a stable internet connection.

For persistent problems, please open an issue on the GitHub repository.

---

For more information on training LoRAs or using the Flux model, please refer to the [official Flux LoRA trainer model](https://replicate.com/lucataco/flux-dev-lora).

0 comments on commit b9d062a

Please sign in to comment.