aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeonard Kugis <leonard@kug.is>2024-04-08 02:56:56 +0200
committerLeonard Kugis <leonard@kug.is>2024-04-08 02:56:56 +0200
commit0a649e76a7e3989e944706c11aaa44cfc753feed (patch)
tree19a490e1c3234e9a4f5e73c06b4e4c7fef5da030
parent5272cedec7fe29907e356e3b5ef7a4f565bafb40 (diff)
Added new quick installation to README
-rw-r--r--README.md37
1 files changed, 36 insertions, 1 deletions
diff --git a/README.md b/README.md
index f4cfcf29..dbe539f9 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,38 @@
# Stable Diffusion web UI
+
A web interface for Stable Diffusion, implemented using Gradio library.
-![](screenshot.png)
+Original author: AUTOMATIC1111
+
+This repo provides a stable-diffusion-webui compatible with gfx803 GPU architecture (e.g. Radeon RX480, Radeon RX580).
+
+## Quick install for this version
+
+1. Clone this repository: `git clone https://kug.is/cgit/stable-diffusion-webui-gfx803.git`.
+2. Build the docker image: `docker build -t stable-diffusion-webui-gfx803 .`.
+ This step might take a long time and the CLI becomes inresponsive in between, but do not worry.
+3. Run the container for the first time: `docker run -it --network=host --device=/dev/kfd --device=/dev/dri --group-add=video --ipc=host --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -v $HOME/dockerx:/dockerx stable-diffusion-webui-gfx803:latest`.
+4. Cd into the `stable-diffusion-webui-gfx803` folder, if you are not already in it.
+5. Source the venv: `source venv/bin/activate`.
+6. Launch the main script: `python launch.py --precision full --no-half`.
+
+For consecutive runs you do not need to build the image again. Instead, do the following:
+
+1. Identify exited container: `docker container ls -a`.
+2. Restart the container: `docker container restart <container-id>`.
+3. Attach to it with bash: `docker exec -it <container-id> bash`.
+4. Cd into the `stable-diffusion-webui-gfx803` folder, if you are not already in it.
+5. Source the venv: `source venv/bin/activate`.
+6. Launch the main script: `python launch.py --precision full --no-half`.
+
+## Remark
+
+Below is the guide for the original repo. Take with care.
## Features
+
[Detailed feature showcase with images](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Features):
+
- Original txt2img and img2img modes
- One click install and run script (but you still must install python and git)
- Outpainting
@@ -95,6 +123,7 @@ A web interface for Stable Diffusion, implemented using Gradio library.
## Installation and Running
Make sure the required [dependencies](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Dependencies) are met and follow the instructions available for:
+
- [NVidia](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Install-and-Run-on-NVidia-GPUs) (recommended)
- [AMD](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Install-and-Run-on-AMD-GPUs) GPUs.
- [Intel CPUs, Intel GPUs (both integrated and discrete)](https://github.com/openvinotoolkit/stable-diffusion-webui/wiki/Installation-on-Intel-Silicon) (external wiki page)
@@ -104,18 +133,21 @@ Alternatively, use online services (like Google Colab):
- [List of Online Services](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Online-Services)
### Installation on Windows 10/11 with NVidia-GPUs using release package
+
1. Download `sd.webui.zip` from [v1.0.0-pre](https://github.com/AUTOMATIC1111/stable-diffusion-webui/releases/tag/v1.0.0-pre) and extract its contents.
2. Run `update.bat`.
3. Run `run.bat`.
> For more details see [Install-and-Run-on-NVidia-GPUs](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Install-and-Run-on-NVidia-GPUs)
### Automatic Installation on Windows
+
1. Install [Python 3.10.6](https://www.python.org/downloads/release/python-3106/) (Newer version of Python does not support torch), checking "Add Python to PATH".
2. Install [git](https://git-scm.com/download/win).
3. Download the stable-diffusion-webui repository, for example by running `git clone https://github.com/AUTOMATIC1111/stable-diffusion-webui.git`.
4. Run `webui-user.bat` from Windows Explorer as normal, non-administrator, user.
### Automatic Installation on Linux
+
1. Install the dependencies:
```bash
# Debian-based:
@@ -133,11 +165,13 @@ wget -q https://raw.githubusercontent.com/AUTOMATIC1111/stable-diffusion-webui/m
```
3. Run `webui.sh`.
4. Check `webui-user.sh` for options.
+
### Installation on Apple Silicon
Find the instructions [here](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Installation-on-Apple-Silicon).
## Contributing
+
Here's how to add code to this repo: [Contributing](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Contributing)
## Documentation
@@ -147,6 +181,7 @@ The documentation was moved from this README over to the project's [wiki](https:
For the purposes of getting Google and other search engines to crawl the wiki, here's a link to the (not for humans) [crawlable wiki](https://github-wiki-see.page/m/AUTOMATIC1111/stable-diffusion-webui/wiki).
## Credits
+
Licenses for borrowed code can be found in `Settings -> Licenses` screen, and also in `html/licenses.html` file.
- Stable Diffusion - https://github.com/Stability-AI/stablediffusion, https://github.com/CompVis/taming-transformers