diff --git a/CHANGES.md b/CHANGES.md index b6974e91..21ed4500 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -27,6 +27,9 @@ - Support loading models in the safetensor format, for improved safety ### Detailed changelog +* 2.4.20 - 22 Dec 2022 - `Pause All` button to pause all the pending tasks. Thanks @JeLuf +* 2.4.20 - 22 Dec 2022 - `Undo`/`Redo` buttons in the image editor. Thanks @JeLuf +* 2.4.20 - 22 Dec 2022 - Drag handle to reorder the tasks. This fixed a bug where the metadata was no longer selectable (for copying). Thanks @JeLuf * 2.4.19 - 17 Dec 2022 - Add Undo/Redo buttons in the Image Editor. Thanks @JeLuf * 2.4.19 - 10 Dec 2022 - Show init img in task list * 2.4.19 - 7 Dec 2022 - Use pre-trained hypernetworks while generating images. Thanks @C0bra5 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 229df851..02ce6fc6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Thanks # For developers: -If you would like to contribute to this project, there is a discord for dicussion: +If you would like to contribute to this project, there is a discord for discussion: [![Discord Server](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.com/invite/u9yhsFmEkB) ## Development environment for UI (frontend and server) changes diff --git a/README.md b/README.md index 01509a46..0115e43a 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,107 @@ # Stable Diffusion UI -### Easiest way to install and use [Stable Diffusion](https://github.com/CompVis/stable-diffusion) on your own computer. No dependencies or technical knowledge required. 1-click install, powerful features. +### The easiest way to install and use [Stable Diffusion](https://github.com/CompVis/stable-diffusion) on your own computer. Does not require technical knowledge, does not require pre-installed software. 1-click install, powerful features, friendly community. -[![Discord Server](https://img.shields.io/discord/1014774730907209781?label=Discord)](https://discord.com/invite/u9yhsFmEkB) (for support, and development discussion) | [Troubleshooting guide for common problems](Troubleshooting.md) +[![Discord Server](https://img.shields.io/discord/1014774730907209781?label=Discord)](https://discord.com/invite/u9yhsFmEkB) (for support, and development discussion) | [Troubleshooting guide for common problems](https://github.com/cmdr2/stable-diffusion-ui/wiki/Troubleshooting) -New! Experimental support for Stable Diffusion 2.0 is available in beta! +### New: +Experimental support for Stable Diffusion 2.0 is available in beta! ---- -## Step 1: Download the installer +# Step 1: Download and prepare the installer +Click the download button for your operating system:

- - + +

-## Step 2: Run the program -- On Windows: Double-click `Start Stable Diffusion UI.cmd` -- On Linux: Run `./start.sh` in a terminal +## On Windows: +1. Unzip/extract the folder `stable-diffusion-ui` which should be in your downloads folder, unless you changed your default downloads destination. +2. Move the `stable-diffusion-ui` folder to your `C:` drive (or any other drive like `D:`, at the top root level). `C:\stable-diffusion-ui` or `D:\stable-diffusion-ui` as examples. This will avoid a common problem with Windows (file path length limits). +## On Linux: +1. Unzip/extract the folder `stable-diffusion-ui` which should be in your downloads folder, unless you changed your default downloads destination. +2. Open a terminal window, and navigate to the `stable-diffusion-ui` directory. -## Step 3: There is no step 3! -It's simple to get started. You don't need to install or struggle with Python, Anaconda, Docker etc. +# Step 2: Run the program +## On Windows: +Double-click `Start Stable Diffusion UI.cmd`. +If Windows SmartScreen prevents you from running the program click `More info` and then `Run anyway`. +## On Linux: +Run `./start.sh` (or `bash start.sh`) in a terminal. -The installer will take care of whatever is needed. A friendly [Discord community](https://discord.com/invite/u9yhsFmEkB) will help you if you face any problems. +The installer will take care of whatever is needed. If you face any problems, you can join the friendly [Discord community](https://discord.com/invite/u9yhsFmEkB) and ask for assistance. + +# Step 3: There is no Step 3. It's that simple! + +**To Uninstall:** Just delete the `stable-diffusion-ui` folder to uninstall all the downloaded packages. ---- # Easy for new users, powerful features for advanced users -### Features: -- **No Dependencies or Technical Knowledge Required**: 1-click install for Windows 10/11 and Linux. *No dependencies*, no need for WSL or Docker or Conda or technical setup. Just download and run! -- **Clutter-free UI**: a friendly and simple UI, while providing a lot of powerful features -- Supports "*Text to Image*" and "*Image to Image*" -- **Stable Diffusion 2.0 support (experimental)** - available in beta channel -- **Custom Models**: Use your own `.ckpt` file, by placing it inside the `models/stable-diffusion` folder! -- **Auto scan for malicious models** - uses picklescan to prevent malicious models -- **Live Preview**: See the image as the AI is drawing it -- **Task Queue**: Queue up all your ideas, without waiting for the current task to finish -- **In-Painting**: Specify areas of your image to paint into -- **Face Correction (GFPGAN) and Upscaling (RealESRGAN)** -- **Image Modifiers**: A library of *modifier tags* like *"Realistic"*, *"Pencil Sketch"*, *"ArtStation"* etc. Experiment with various styles quickly. -- **Loopback**: Use the output image as the input image for the next img2img task +## Features: + +### User experience +- **Hassle-free installation**: Does not require technical knowledge, does not require pre-installed software. Just download and run! +- **Clutter-free UI**: A friendly and simple UI, while providing a lot of powerful features. + +### Image generation +- **Supports**: "*Text to Image*" and "*Image to Image*". +- **In-Painting**: Specify areas of your image to paint into. +- **Simple Drawing Tool**: Draw basic images to guide the AI, without needing an external drawing program. +- **Face Correction (GFPGAN)** +- **Upscaling (RealESRGAN)** +- **Loopback**: Use the output image as the input image for the next img2img task. - **Negative Prompt**: Specify aspects of the image to *remove*. -- **Attention/Emphasis:** () in the prompt increases the model's attention to enclosed words, and [] decreases it -- **Weighted Prompts:** Use weights for specific words in your prompt to change their importance, e.g. `red:2.4 dragon:1.2` -- **Prompt Matrix:** (in beta) Quickly create multiple variations of your prompt, e.g. `a photograph of an astronaut riding a horse | illustration | cinematic lighting` -- **Lots of Samplers:** ddim, plms, heun, euler, euler_a, dpm2, dpm2_a, lms -- **Multiple Prompts File:** Queue multiple prompts by entering one prompt per line, or by running a text file -- **NSFW Setting**: A setting in the UI to control *NSFW content* -- **JPEG/PNG output** -- **Save generated images to disk** +- **Attention/Emphasis**: () in the prompt increases the model's attention to enclosed words, and [] decreases it. +- **Weighted Prompts**: Use weights for specific words in your prompt to change their importance, e.g. `red:2.4 dragon:1.2`. +- **Prompt Matrix**: Quickly create multiple variations of your prompt, e.g. `a photograph of an astronaut riding a horse | illustration | cinematic lighting`. +- **Lots of Samplers**: ddim, plms, heun, euler, euler_a, dpm2, dpm2_a, lms. +- **1-click Upscale/Face Correction**: Upscale or correct an image after it has been generated. +- **Make Similar Images**: Click to generate multiple variations of a generated image. +- **NSFW Setting**: A setting in the UI to control *NSFW content*. +- **JPEG/PNG output**: Multiple file formats. + +### Advanced features +- **Custom Models**: Use your own `.ckpt` or `.safetensors` file, by placing it inside the `models/stable-diffusion` folder! +- **Stable Diffusion 2.0 support (experimental)**: available in beta channel. +- **Use custom VAE models** +- **Use pre-trained Hypernetworks** +- **UI Plugins**: Choose from a growing list of [community-generated UI plugins](https://github.com/cmdr2/stable-diffusion-ui/wiki/UI-Plugins), or write your own plugin to add features to the project! + +### Performance and security +- **Low Memory Usage**: Creates 512x512 images with less than 4GB of GPU RAM! - **Use CPU setting**: If you don't have a compatible graphics card, but still want to run it on your CPU. +- **Multi-GPU support**: Automatically spreads your tasks across multiple GPUs (if available), for faster performance! +- **Auto scan for malicious models**: Uses picklescan to prevent malicious models. +- **Safetensors support**: Support loading models in the safetensor format, for improved safety. - **Auto-updater**: Gets you the latest improvements and bug-fixes to a rapidly evolving project. -- **Low Memory Usage**: Creates 512x512 images with less than 4GB of VRAM! - **Developer Console**: A developer-mode for those who want to modify their Stable Diffusion code, and edit the conda environment. -### Easy for new users: +### Usability: +- **Live Preview**: See the image as the AI is drawing it. +- **Task Queue**: Queue up all your ideas, without waiting for the current task to finish. +- **Image Modifiers**: A library of *modifier tags* like *"Realistic"*, *"Pencil Sketch"*, *"ArtStation"* etc. Experiment with various styles quickly. +- **Multiple Prompts File**: Queue multiple prompts by entering one prompt per line, or by running a text file. +- **Save generated images to disk**: Save your images to your PC! +- **UI Themes**: Customize the program to your liking. + +**(and a lot more)** + +---- + +## Easy for new users: ![Screenshot of the initial UI](media/shot-v10-simple.jpg?raw=true) -### Powerful features for advanced users: +## Powerful features for advanced users: ![Screenshot of advanced settings](media/shot-v10.jpg?raw=true) -### Live Preview +## Live Preview Useful for judging (and stopping) an image quickly, without waiting for it to finish rendering. ![live-512](https://user-images.githubusercontent.com/844287/192097249-729a0a1e-a677-485e-9ccc-16a9e848fabe.gif) -### Task Queue +## Task Queue ![Screenshot of task queue](media/task-queue-v1.jpg?raw=true) # System Requirements @@ -74,23 +111,10 @@ Useful for judging (and stopping) an image quickly, without waiting for it to fi You don't need to install or struggle with Python, Anaconda, Docker etc. The installer will take care of whatever is needed. -# Installation -1. **Download** [for Windows](https://github.com/cmdr2/stable-diffusion-ui/releases/download/v2.4.13/stable-diffusion-ui-windows.zip) or [for Linux](https://github.com/cmdr2/stable-diffusion-ui/releases/download/v2.4.13/stable-diffusion-ui-linux.zip). - -2. **Extract**: - - For Windows: After unzipping the file, please move the `stable-diffusion-ui` folder to your `C:` (or any drive like D:, at the top root level), e.g. `C:\stable-diffusion-ui`. This will avoid a common problem with Windows (file path length limits). - - For Linux: After extracting the .tar.xz file, please open a terminal, and go to the `stable-diffusion-ui` directory. - -3. **Run**: - - For Windows: `Start Stable Diffusion UI.cmd` by double-clicking it. - - For Linux: In the terminal, run `./start.sh` (or `bash start.sh`) - -This will automatically install Stable Diffusion, set it up, and start the interface. No additional steps are needed. - -**To Uninstall:** Just delete the `stable-diffusion-ui` folder to uninstall all the downloaded packages. +---- # How to use? -Please use our [guide](https://github.com/cmdr2/stable-diffusion-ui/wiki/How-to-Use) to understand how to use the features in this UI. +Please refer to our [guide](https://github.com/cmdr2/stable-diffusion-ui/wiki/How-to-Use) to understand how to use the features in this UI. # Bugs reports and code contributions welcome If there are any problems or suggestions, please feel free to ask on the [discord server](https://discord.com/invite/u9yhsFmEkB) or [file an issue](https://github.com/cmdr2/stable-diffusion-ui/issues). @@ -106,4 +130,11 @@ If you have any code contributions in mind, please feel free to say Hi to us on # Disclaimer The authors of this project are not responsible for any content generated using this interface. -The license of this software forbids you from sharing any content that violates any laws, produce any harm to a person, disseminate any personal information that would be meant for harm, spread misinformation, or target vulnerable groups. For the full list of restrictions please read [the license](LICENSE). You agree to these terms by using this software. +The license of this software forbids you from sharing any content that: +- Violates any laws. +- Produces any harm to a person or persons. +- Disseminates (spreads) any personal information that would be meant for harm. +- Spreads misinformation. +- Target vulnerable groups. + +For the full list of restrictions please read [the License](LICENSE). You agree to these terms by using this software. diff --git a/Troubleshooting.md b/Troubleshooting.md deleted file mode 100644 index f190de20..00000000 --- a/Troubleshooting.md +++ /dev/null @@ -1 +0,0 @@ -Moved to https://github.com/cmdr2/stable-diffusion-ui/wiki/Troubleshooting