Spaces:
Runtime error
Runtime error
Added additional context to README
Browse files
README.md
CHANGED
@@ -20,7 +20,7 @@ models:
|
|
20 |
|
21 |
## Stable Diffusion WebUI + ControlNet
|
22 |
|
23 |
-
|
24 |
|
25 |
🐳 🤗 Builds a Docker image to be run as a [Hugging Face Space](https://huggingface.co/) using A10G or T4 hardware.
|
26 |
|
@@ -28,7 +28,7 @@ Uses Stable Diffusion 2.1 models. Comes with several popular extensions to [AUTO
|
|
28 |
|
29 |
1. Duplicate this space to your Hugging Face account or clone this repo to your account.
|
30 |
2. Under the *"Settings"* tab of your space you can choose which hardware for your space, that you will also be billed for.
|
31 |
-
3. The [`on_start.sh`](./on_start.sh) file will be run when the container is started, right before the
|
32 |
|
33 |
---
|
34 |
|
@@ -48,12 +48,40 @@ Uses Stable Diffusion 2.1 models. Comes with several popular extensions to [AUTO
|
|
48 |
* Trained models: [https://github.com/lllyasviel/ControlNet](https://github.com/lllyasviel/ControlNet)
|
49 |
* Pre-extracted models: [https://huggingface.co/webui/ControlNet-modules-safetensors/tree/main](https://huggingface.co/webui/ControlNet-modules-safetensors/tree/main)
|
50 |
|
51 |
-
#### Stable Diffusion
|
52 |
|
53 |
* [https://huggingface.co/stabilityai/stable-diffusion-2/blob/main/LICENSE-MODEL](https://huggingface.co/stabilityai/stable-diffusion-2/blob/main/LICENSE-MODEL)
|
54 |
* [https://huggingface.co/spaces/CompVis/stable-diffusion-license](https://huggingface.co/spaces/CompVis/stable-diffusion-license)
|
55 |
* [https://github.com/lllyasviel/ControlNet/blob/main/LICENSE](https://github.com/lllyasviel/ControlNet/blob/main/LICENSE)
|
56 |
|
57 |
-
|
58 |
|
59 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
20 |
|
21 |
## Stable Diffusion WebUI + ControlNet
|
22 |
|
23 |
+
Comes both with Stable Diffusion 2.1 models and Stable Diffusion 1.5 models. Comes with several popular extensions to [AUTOMATIC1111's WebUI]([https://github.com/AUTOMATIC1111/stable-diffusion-webui]), including the [ControlNet WebUI extension](https://github.com/Mikubill/sd-webui-controlnet). ControlNet models primarily works best with the SD 1.5 models at the time of writing.
|
24 |
|
25 |
🐳 🤗 Builds a Docker image to be run as a [Hugging Face Space](https://huggingface.co/) using A10G or T4 hardware.
|
26 |
|
|
|
28 |
|
29 |
1. Duplicate this space to your Hugging Face account or clone this repo to your account.
|
30 |
2. Under the *"Settings"* tab of your space you can choose which hardware for your space, that you will also be billed for.
|
31 |
+
3. The [`on_start.sh`](./on_start.sh) file will be run when the container is started, right before the WebUI is initiated. This is where you can install any additional extensions or models you may need.
|
32 |
|
33 |
---
|
34 |
|
|
|
48 |
* Trained models: [https://github.com/lllyasviel/ControlNet](https://github.com/lllyasviel/ControlNet)
|
49 |
* Pre-extracted models: [https://huggingface.co/webui/ControlNet-modules-safetensors/tree/main](https://huggingface.co/webui/ControlNet-modules-safetensors/tree/main)
|
50 |
|
51 |
+
#### Licenses for using Stable Diffusion models and ControlNet models
|
52 |
|
53 |
* [https://huggingface.co/stabilityai/stable-diffusion-2/blob/main/LICENSE-MODEL](https://huggingface.co/stabilityai/stable-diffusion-2/blob/main/LICENSE-MODEL)
|
54 |
* [https://huggingface.co/spaces/CompVis/stable-diffusion-license](https://huggingface.co/spaces/CompVis/stable-diffusion-license)
|
55 |
* [https://github.com/lllyasviel/ControlNet/blob/main/LICENSE](https://github.com/lllyasviel/ControlNet/blob/main/LICENSE)
|
56 |
|
57 |
+
### Enable additional models (checkpoints, LoRA, VAE, etc.)
|
58 |
|
59 |
+
Enable the models you want to use on the bottom of the [`on_start.sh`](./on_start.sh) file. This is also the place to add any additional models you may want to install when starting your space.
|
60 |
+
|
61 |
+
```bash
|
62 |
+
## Checkpoint · Example:
|
63 |
+
download-model --checkpoint "FILENAME" "URL"
|
64 |
+
|
65 |
+
## LORA (low-rank adaptation) · Example:
|
66 |
+
download-model --lora "FILENAME" "URL"
|
67 |
+
|
68 |
+
## VAE (variational autoencoder) · Example:
|
69 |
+
download-model --vae "FILENAME" "URL"
|
70 |
+
```
|
71 |
+
|
72 |
+
#### Some examples of additional (optional) models
|
73 |
+
|
74 |
+
Some models such as additional checkpoints, VAE, LoRA, etc. may already be present in the [`on_start.sh`](./on_start.sh) file. You can enable them by removing the `#` in front of their respective line or disable them by removing the line or adding a leading `#` before `download-model`.
|
75 |
+
|
76 |
+
* [Checkpoint · Dreamlike Diffusion 1.0](https://huggingface.co/dreamlike-art/dreamlike-diffusion-1.0) ([license](https://huggingface.co/dreamlike-art/dreamlike-diffusion-1.0/blob/main/LICENSE.md))
|
77 |
+
* [Checkpoint · Dreamshaper 3.31](https://huggingface.co/Lykon/DreamShaper)
|
78 |
+
* [Checkpoint · The Ally's Mix III: Revolutions](https://civitai.com/models/10752/the-allys-mix-iii-revolutions)
|
79 |
+
* [Checkpoint · Deliberate v2](https://civitai.com/models/4823/deliberate)
|
80 |
+
* [Checkpoint · dalcefo_painting](https://civitai.com/models/5396/dalcefopainting)
|
81 |
+
* [Checkpoint · RPG v4](https://huggingface.co/Anashel/rpg)
|
82 |
+
* [Checkpoint · A to Zovya RPG Artist's Tools (1.5 & 2.1)](https://civitai.com/models/8124/a-to-zovya-rpg-artists-tools-15-and-21)
|
83 |
+
* [LoRA · epi_noiseoffset v2](https://civitai.com/models/13941/epinoiseoffset)
|
84 |
+
* [VAE · sd-vae-ft-mse-original](https://huggingface.co/stabilityai/sd-vae-ft-mse-original)
|
85 |
+
* See [https://huggingface.co/models?filter=stable-diffusion](https://huggingface.co/models?filter=stable-diffusion) and [https://civitai.com/](https://civitai.com/) for more.
|
86 |
+
|
87 |
+
Visit the individual model pages for more information on the models and their licenses.
|