caishi
/
StableStudio
mirror of https://github.com/Stability-AI/StableStudio.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README

This commit is contained in:
Conner Ruhl 2023-05-22 17:01:24 -05:00
parent f87e36598b
commit 53ec45f6c2
2 changed files with 32 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
misc/Electric1111.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 607 KiB

40
packages/stablestudio-plugin-webui/README.md
View File

@ -1,18 +1,42 @@
<div align="center">
# 🔌 [`stable-diffusion-webui`](https://github.com/AUTOMATIC1111/stable-diffusion-webui) Plugin
**🗺 Contents – [ℹ️ About](#about) · [📦 Installation](#installation) · [🤝 Contract](#technology) · [🔮 Future](#conventions)**
**[⬆️ Top-Level README](../../README.md)**
![Electric1111](../../misc/Electric1111.png)
### 🚧 👷 **PLUGINS ARE EXPERIMENTAL AND NOT FINAL** 🛠 🚧
_The contract and implementation are [likely to change](https://github.com/Stability-AI/StableStudio/issues/3)..._
</div>
# <a id="about" href="#about">ℹ️ About</a>
In order to make StableStudio easier to extend, we've ripped out the "back-end" into a plugin system.
This means you can implement an entirely different inference stack, StableStudio doesn't care if it's local or a hosted API.
This is a basic implement for stable-diffusion-webui plugin.
# How to use
# <a id="usage" href="#usage">⚙️ Usage</a>
1. On stable-diffusion-webui side, edit webui-user.bat and
`set COMMANDLINE_ARGS=--nowebui --cors-allow-origins=http://localhost:3000`
Then start your webui.
2. Once you see **INFO: Uvicorn running on http://127.0.0.1:7861**, means you started webui on api mode successfully.
you can open http://127.0.0.1:7861/docs to double check.
`set COMMANDLINE_ARGS=--nowebui --cors-allow-origins=http://localhost:3000`
Then start your webui.
2. Once you see **INFO: Uvicorn running on http://127.0.0.1:7861**, means you started webui on api mode successfully.
you can open http://127.0.0.1:7861/docs to double check.
3. On StableStudio side, run `yarn dev:use-webui-plugin`
4. once the server started, click settings to check this plugin loaded successfully or not. ![webui-plugin](docs/images/webui-plugin.png)
![overall](docs/images/overall.png)
![overall](docs/images/overall.png)
5. click **Dream**, your webui server should start to process your request from StableStudio.
6. if you need to load existing from webui, you also need to install the extension [sd-webui-StableStudio](https://github.com/jtydhr88/sd-webui-StableStudio))
Still, currently this plugin is a basic implement for webui, and only support a few of features:
- [x] txt2img
- [x] basic features (prompt, negative prompt, steps, batch_size, image size)
- [x] features provided by StableStudio
@ -24,9 +48,9 @@ Still, currently this plugin is a basic implement for webui, and only support a
- [x] webui status could replace images generated status
- [x] load existing images (need an extension on webui: [sd-webui-StableStudio](https://github.com/jtydhr88/sd-webui-StableStudio))
- [x] Need to think about how to deal with extensions ecosystem in webui (made a start with [sd-webui-StableStudio](https://github.com/jtydhr88/sd-webui-StableStudio))
- [x] upscale
- [x] upscale
- [ ] test and bugs fix (working)
- [ ] Lora support
- [ ] plugin could use path in settings along with a field for extra cli flags to launch webui on startup
- [ ] MacOS and Linux support (since I don’t have environment with MacOS/Linux, may need someone help with this)
- [ ] many other features from webui...
- [ ] many other features from webui...