Sygil-Dev/sygil-webui
1
1
Fork 0
mirror of https://github.com/Sygil-Dev/sygil-webui.git synced 2024-12-14 14:05:36 +03:00
Code Issues Projects Releases Wiki Activity

chore: update docs (#1351)

Browse Source 
* added front matter
* fixed links
* logo is removed until further consideration
This commit is contained in:
Thomas Mello 2022-09-28 14:18:56 +03:00 committed by GitHub
parent 0cc41b903b
commit 3dd798dc1a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 29 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,11 +1,11 @@
![](images/sd-wui_logo.png) # <center>Web-based UI for Stable Diffusion</center>
# <center>Web-based UI for Stable Diffusion by [sd-webui](https://github.com/sd-webui)</center> ## Created by [sd-webui](https://github.com/sd-webui)
## [Visit sd-webui's Discord Server](https://discord.gg/gyXNe4NySY) [![Discord Server](https://user-images.githubusercontent.com/5977640/190528254-9b5b4423-47ee-4f24-b4f9-fd13fba37518.png)](https://discord.gg/gyXNe4NySY) ## [Visit sd-webui's Discord Server](https://discord.gg/gyXNe4NySY) [![Discord Server](https://user-images.githubusercontent.com/5977640/190528254-9b5b4423-47ee-4f24-b4f9-fd13fba37518.png)](https://discord.gg/gyXNe4NySY)
## Installation instructions for: ## Installation instructions for:
- **[Windows](https://sd-webui.github.io/stable-diffusion-webui/docs/1.installation.html)** - **[Windows](https://sd-webui.github.io/stable-diffusion-webui/docs/1.windows-installation.html)**
- **[Linux](https://sd-webui.github.io/stable-diffusion-webui/docs/2.linux-installation.html)** - **[Linux](https://sd-webui.github.io/stable-diffusion-webui/docs/2.linux-installation.html)**

9
docs/1.windows-installation.md
View File

@ -1,3 +1,6 @@
---
title: Windows Installation
---
<!-- <!--
This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/). This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/).
@ -16,13 +19,9 @@ You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
--> -->
# Windows Installation
[To install on Linux, see this page.](https://github.com/sd-webui/stable-diffusion-webui/blob/master/docs/2.linux-installation.md)
# Windows - step by step Installation guide
# Initial Setup # Initial Setup
> This is a windows guide. [To install on Linux, see this page.](2.linux-installation.md)
## Pre requisites ## Pre requisites

7
docs/2.linux-installation.md
View File

@ -1,3 +1,6 @@
---
title: Linux Installation
---
<!-- <!--
This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/). This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/).
@ -16,12 +19,10 @@ You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
--> -->
# Linux Installation
### The definitive Stable Diffusion WebUI experience ™ Now 100% Linux Compatible! ### The definitive Stable Diffusion WebUI experience ™ Now 100% Linux Compatible!
#### Created by [Joshua Kimsey](https://github.com/JoshuaKimsey) #### Created by [Joshua Kimsey](https://github.com/JoshuaKimsey)
[To install on Windows, see this page.](https://github.com/sd-webui/stable-diffusion-webui/blob/master/docs/1.windows-installation.md) > This is a Linux guide. [To install on Windows, see this page.](1.windows-installation.md)
**Note: This guide describes how to use the automated installation script created by [Joshua Kimsey](https://github.com/JoshuaKimsey). It is my personal recommendation to use this script as it will automatically handle downloading and updating the repo for you. This is not a requirement to running the Stable Diffusion WebUI on Linux, but you will need to install your own conda environment manually and then run `webui.sh` to run the Stable Diffusion WebUI.** **Note: This guide describes how to use the automated installation script created by [Joshua Kimsey](https://github.com/JoshuaKimsey). It is my personal recommendation to use this script as it will automatically handle downloading and updating the repo for you. This is not a requirement to running the Stable Diffusion WebUI on Linux, but you will need to install your own conda environment manually and then run `webui.sh` to run the Stable Diffusion WebUI.**

5
docs/3.docker-guide.md
View File

@ -1,3 +1,6 @@
---
title: Running Stable Diffusion WebUI Using Docker
---
<!-- <!--
This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/). This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/).
@ -16,8 +19,6 @@ You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
--> -->
# Running Stable Diffusion WebUI Using Docker
This Docker environment is intended to speed up development and testing of Stable Diffusion WebUI features. Use of a container image format allows for packaging and isolation of Stable Diffusion / WebUI's dependencies separate from the Host environment. This Docker environment is intended to speed up development and testing of Stable Diffusion WebUI features. Use of a container image format allows for packaging and isolation of Stable Diffusion / WebUI's dependencies separate from the Host environment.
You can use this Dockerfile to build a Docker image and run Stable Diffusion WebUI locally. You can use this Dockerfile to build a Docker image and run Stable Diffusion WebUI locally.

6
docs/4.streamlit-interface.md
View File

@ -1,3 +1,6 @@
---
title: Streamlit Web UI Interface
---
<!-- <!--
This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/). This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/).
@ -16,9 +19,6 @@ You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
--> -->
# Streamlit Web UI Interface
**Features:** **Features:**
- Clean UI with an easy to use design, with support for widescreen displays. - Clean UI with an easy to use design, with support for widescreen displays.
- Dynamic live preview of your generations - Dynamic live preview of your generations

7
docs/5.gradio-interface.md
View File

@ -1,3 +1,6 @@
---
title: Gradio Web UI Interface
---
<!-- <!--
This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/). This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/).
@ -16,8 +19,6 @@ You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
--> -->
# Gradio Web UI Interface
### Gradio Web UI Features: ### Gradio Web UI Features:
- Older UI design that is fully functional and feature complete. - Older UI design that is fully functional and feature complete.
- Has access to all upscaling models, including LSDR. - Has access to all upscaling models, including LSDR.
@ -88,7 +89,7 @@ The Gradio Image Lab is a central location to access image enhancers and upscale
- LSDR: A 4x upsclaer that uses Latent Diffusion, preserving a lot more detail at the cost of speed and VRAM - LSDR: A 4x upsclaer that uses Latent Diffusion, preserving a lot more detail at the cost of speed and VRAM
- GoLatent: Uses LSDR to do a 4x upscale, then GoBig to make a final 8x upscale with great detail preservation. - GoLatent: Uses LSDR to do a 4x upscale, then GoBig to make a final 8x upscale with great detail preservation.
Please see the [Image Enhancers](https://github.com/sd-webui/stable-diffusion-webui/blob/master/docs/6.image_enhancers.md) section to learn more about how to use these tools. Please see the [Image Enhancers](6.image_enhancers.md) section to learn more about how to use these tools.
## Gradio Optional Customizations ## Gradio Optional Customizations

4
docs/6.image_enhancers.md
View File

@ -1,3 +1,6 @@
---
title: Upscalers
---
<!-- <!--
This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/). This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/).
@ -17,7 +20,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
--> -->
# **Upscalers**
Included with both versions of the Web UI Interface are a series of image restorers and upscalers. They are included to help users create outputs with restored features, such as better faces, or at larger resolutions than Stable Diffusion is able to natively output. Included with both versions of the Web UI Interface are a series of image restorers and upscalers. They are included to help users create outputs with restored features, such as better faces, or at larger resolutions than Stable Diffusion is able to natively output.

4
docs/8.custom-models.md
View File

@ -1,3 +1,6 @@
---
title: Custom models
---
<!-- <!--
This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/). This file is part of stable-diffusion-webui (https://github.com/sd-webui/stable-diffusion-webui/).
@ -16,7 +19,6 @@ You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
--> -->
# Custom models
You can use other *versions* of Stable Diffusion, and *finetunes* of Stable Diffusion. You can use other *versions* of Stable Diffusion, and *finetunes* of Stable Diffusion.