Skip to content

Commit 12a369c

Browse files
committed
docs: update readme
1 parent fd35047 commit 12a369c

2 files changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ API and command-line option may change frequently.***
1515

1616
## 🔥Important News
1717

18+
* **2026/04/11** 🚀 stable-diffusion.cpp now uses a brand-new embedded web UI.
19+
👉 Details: [PR #1408](https://github.com/leejet/stable-diffusion.cpp/pull/1408)
20+
1821
* **2026/01/18** 🚀 stable-diffusion.cpp now supports **FLUX.2-klein**
1922
👉 Details: [PR #1193](https://github.com/leejet/stable-diffusion.cpp/pull/1193)
2023

examples/server/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
1+
# Example
2+
3+
The following example starts `sd-server` with a standalone diffusion model, VAE, and LLM text encoder:
4+
5+
```
6+
.\bin\Release\sd-server.exe --diffusion-model ..\models\diffusion_models\z_image_turbo_bf16.safetensors --vae ..\models\vae\ae.sft --llm ..\models\text_encoders\qwen_3_4b.safetensors --diffusion-fa --offload-to-cpu -v --cfg-scale 1.0
7+
```
8+
9+
What this example does:
10+
11+
* `--diffusion-model` selects the standalone diffusion model
12+
* `--vae` selects the VAE decoder
13+
* `--llm` selects the text encoder / language model used by this pipeline
14+
* `--diffusion-fa` enables flash attention in the diffusion model
15+
* `--offload-to-cpu` reduces VRAM pressure by keeping weights in RAM when possible
16+
* `-v` enables verbose logging
17+
* `--cfg-scale 1.0` sets the default CFG scale for generation
18+
19+
After the server starts successfully:
20+
21+
* the web UI is available at `http://127.0.0.1:1234/`
22+
* the native async API is available under `/sdcpp/v1/...`
23+
* the compatibility APIs are available under `/v1/...` and `/sdapi/v1/...`
24+
25+
If you want to use a different host or port, pass:
26+
27+
```bash
28+
--listen-ip <ip> --listen-port <port>
29+
```
30+
131
# Frontend
232

333
## Build with Frontend

0 commit comments

Comments
 (0)