extern/easydiffusion
1
0
Fork 1
mirror of https://github.com/easydiffusion/easydiffusion.git synced 2024-11-22 08:13:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Changes to Front Docs

Browse Source
This commit is contained in:
SpecificKnot 2022-12-19 14:28:05 +00:00
parent af090cb289
commit 27b8e173e8
3 changed files with 39 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -6,7 +6,7 @@ Thanks
# For developers: # 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) [![Discord Server](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.com/invite/u9yhsFmEkB)
## Development environment for UI (frontend and server) changes ## Development environment for UI (frontend and server) changes

68
README.md
View File

@ -30,7 +30,7 @@ If Windows SmartScreen prevents you from running the program click `More info` a
## On Linux: ## On Linux:
Run `./start.sh` (or `bash start.sh`) in a terminal. 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, join the [Discord](https://discord.com/invite/u9yhsFmEkB) and ask fo assistance.
# Step 3: There is no Step 3. It's that simple! # Step 3: There is no Step 3. It's that simple!
@ -40,29 +40,31 @@ The installer will take care of whatever is needed. A friendly [Discord communit
# Easy for new users, powerful features for advanced users # Easy for new users, powerful features for advanced users
## Features: ## Features:
### User experience ### User experience
- **Hassle-free installation**: 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! - **Hassle-free installation**: No Dependencies such as Docker or Conda or Technical Knowledge is required. Just download and run!
- **Clutter-free UI**: a friendly and simple UI, while providing a lot of powerful features - **Clutter-free UI**: A friendly and simple UI, while providing a lot of powerful features.
### Image generation ### Image generation
- Supports "*Text to Image*" and "*Image to Image*" - **Supports**: "*Text to Image*" and "*Image to Image*".
- **In-Painting**: Specify areas of your image to paint into - **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 - **Simple Drawing Tool**: Draw basic images to guide the AI, without needing an external drawing program.
- **Face Correction (GFPGAN) and Upscaling (RealESRGAN)** - **Face Correction (GFPGAN)**
- **Loopback**: Use the output image as the input image for the next img2img task - **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*. - **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 - **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` - **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` - **Prompt Matrix**: (beta only) 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 - **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 - **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 - **Make Similar Images**: Click to generate multiple variations of a generated image.
- **NSFW Setting**: A setting in the UI to control *NSFW content* - **NSFW Setting**: A setting in the UI to control *NSFW content*.
- **JPEG/PNG output** - **JPEG/PNG output**: Multiple file formats.
### Advanced features ### Advanced features
- **Custom Models**: Use your own `.ckpt` or `.safetensors` file, by placing it inside the `models/stable-diffusion` folder! - **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 - **Stable Diffusion 2.0 support (experimental)**: available in beta channel.
- **Use custom VAE models** - **Use custom VAE models**
- **Use pre-trained Hypernetworks** - **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! - **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!
@ -70,21 +72,23 @@ The installer will take care of whatever is needed. A friendly [Discord communit
### Performance and security ### Performance and security
- **Low Memory Usage**: Creates 512x512 images with less than 4GB of GPU RAM! - **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. - **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! - **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 - **Auto scan for malicious models**: Uses picklescan to prevent malicious models.
- **Safetensors support**: Support loading models in the safetensor format, for improved safety - **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. - **Auto-updater**: Gets you the latest improvements and bug-fixes to a rapidly evolving project.
- **Developer Console**: A developer-mode for those who want to modify their Stable Diffusion code, and edit the conda environment. - **Developer Console**: A developer-mode for those who want to modify their Stable Diffusion code, and edit the conda environment.
### Usability: ### Usability:
- **Live Preview**: See the image as the AI is drawing it - **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. - **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. - **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 - **Multiple Prompts File**: Queue multiple prompts by entering one prompt per line, or by running a text file.
- **Save generated images to disk** - **Save generated images to disk**: Save your images to your PC!
- **UI Themes** - **UI Themes**: Customize the program to your liking.
*(and lots more)* **(and a lot more)**
----
## Easy for new users: ## Easy for new users:
![Screenshot of the initial UI](media/shot-v10-simple.jpg?raw=true) ![Screenshot of the initial UI](media/shot-v10-simple.jpg?raw=true)
@ -105,12 +109,10 @@ Useful for judging (and stopping) an image quickly, without waiting for it to fi
2. An NVIDIA graphics card, preferably with 4GB or more of VRAM. If you don't have a compatible graphics card, it'll automatically run in the slower "CPU Mode". 2. An NVIDIA graphics card, preferably with 4GB or more of VRAM. If you don't have a compatible graphics card, it'll automatically run in the slower "CPU Mode".
3. Minimum 8 GB of RAM and 25GB of disk space. 3. Minimum 8 GB of RAM and 25GB of disk space.
You don't need to install or struggle with Python, Anaconda, Docker etc. The installer will take care of whatever is needed. ----
This will automatically install Stable Diffusion, set it up, and start the interface. No additional steps are needed.
# How to use? # 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 # 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). 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).
@ -126,4 +128,10 @@ If you have any code contributions in mind, please feel free to say Hi to us on
# Disclaimer # Disclaimer
The authors of this project are not responsible for any content generated using this interface. 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.
- Producing any harm to a person.
- Disseminating (spreading) any personal information that would be meant for harm.
- Spreading 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.

1
Troubleshooting.md
View File

@ -1 +0,0 @@
Moved to https://github.com/cmdr2/stable-diffusion-ui/wiki/Troubleshooting