Skip to content

Commit 227a1c0

Browse files
committed
some doc improvements
1 parent 4ff3fe0 commit 227a1c0

File tree

2 files changed

+20
-13
lines changed

2 files changed

+20
-13
lines changed

docs/Basic Usage.md

+16-11
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,20 @@ Nonetheless, here's a step-by-step you can follow:
1111
Step one: [Install SwarmUI](/README.md#installing-on-windows).
1212

1313
Once you've ran the basic program-installation, if all went well, it will open a web interface to select basic install settings.
14-
- Agree to the SD license
15-
- Pick a theme (I think default is best, but you got options)
16-
- Pick who the UI is for (usually just Yourself or Yourself on LAN)
17-
- Pick what backend(s) to install. If you already have ComfyUI or another backend you can skip this - if not, pick one. I recommend ComfyUI for local usage.
18-
- Pick any model(s) you want to download. If you already have some you can skip this, if not, I recommend SDXL 1.0.
14+
- It starts with an option to skip the installer and use defaults. New users might prefer this. Otherwise:
15+
- Pick a theme (I think default is best, but you got options)
16+
- Pick who the UI is for (usually just Yourself or Yourself on LAN)
17+
- Pick what backend(s) to install. If you already have ComfyUI or another backend you can skip this - if not, pick one. I recommend ComfyUI for local usage.
18+
- If you already have a Comfy install and want to use it, this is not recommended for most users, but:
19+
- you can select no backend in the install page
20+
- and then add your existing install in the main UI later via `Server`->`Backends`->add a `ComfyUI Self-Starting`->give it your comfy `main.py` path->`Save`
21+
- you'll also want to edit `Server Configuration`->`Model Root` to be your existing comfy models dir, and change `SDModelFolder` to `checkpoints` to match Comfy's folder format.
22+
- Pick any starter model(s) you want to download. If you already have some you can skip this.
1923
- Confirm you want the settings you selected, and install.
2024

2125
Once this is done, it should automatically redirect you to the main interface.
2226

23-
(You can close the server at any time by just closing that console window it pulls up, and you can start it again via the desktop icon, or the `launch` script in the folder).
27+
(You can close the server at any time by just closing that console window it pulls up or via `Server`->`Shutdown`, and you can start it again via the desktop icon, or the `launch` script in the folder).
2428

2529
## Configuring
2630

@@ -50,13 +54,14 @@ If you have pre-existing Stable Diffusion files, you'll want to configure settin
5054

5155
If it didn't go well, ... well it's alpha software, hopefully there's an error message telling you what went wrong. If you can't figure it out, open an [issue here](https://github.com/mcmonkeyprojects/SwarmUI/issues) or ask on [discord](https://discord.gg/q2y38cqjNw).
5256

53-
## Using The SDXL Refiner
57+
## Using A Refiner / Upscaling Images
5458

55-
So, you want *refined* images, huh? Well, if the base isn't enough, and you downloaded the refiner, you can put it to use!
59+
So, you want *refined* images, huh? Well, if the first pass of generation is enough, you can use the Upscale/Refine options.
5660

57-
- Just open the `Refiner` parameter group (you might have to scroll down if your screen is small - it's right below `Init Image`).
58-
- Enable the `Refiner Model` parameter and select your model (it lists recognized refiners at the top, you can use other models too if you want)
59-
- Set the other parameters however you want. Click the `?` if you're not sure what a parameter does.
61+
- Just open the `Refine / Upscale` parameter group (you might have to scroll down if your screen is small - it's right below `Init Image`), and toggle the checkbox next to the group title.
62+
- If you have a dedicated refiner model, Enable the `Refiner Model` parameter and select your model
63+
- If you want to upscale, drag the `Refiner Upscale` over to `1.5` or `2`. If you're using a DiT model (eg SD3 or Flux), enable `Refiner Do Tiling`
64+
- Set the other parameters however you want. Click the `?` if you're not sure what a parameter does.
6065
- Click Generate! Yup that's literally all you have to do. Easy, huh?
6166
- You can turn it off at any time by toggling the toggler on the group (right next to where it says `Refiner` as the group label).
6267

src/BuiltinExtensions/ComfyUIBackend/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ You can also view the ComfyUI node graph and work with custom workflows directly
1111
- Self-Start lets swarm configure, launch, and manage the ComfyUI backend. This is highly recommended.
1212
- API-By-URL is for if you want to launch and manage the ComfyUI instance entirely yourself, but still connect it from Swarm.
1313
- Configuration is significantly more complex, and misbehavior may occur. This is not recommended.
14+
- In other words: Unless you're a professional getting paid by the hour to build a complex AI network, you almost certainly do not need or want the API-By-URL option.
1415

1516
### Installation (Self-Start)
1617

@@ -23,11 +24,12 @@ You can also view the ComfyUI node graph and work with custom workflows directly
2324
- First: have a valid and working ComfyUI installation.
2425
- Make sure it uses the exact same model paths as your SwarmUI instance does. This means that if you have eg `OfficialStableDiffusion/sd_xl_base_1.0.safetensors` in Swarm, you need have *EXACTLY* that in ComfyUI. The only exception is Windows paths that use `\` instead of `/` are fine, Swarm will automatically correct for that (If you use Self-Start, this is automatically managed from your Swarm settings).
2526
- Note that swarm may leave stray Input or Output images in the ComfyUI folder that you may wish to clean up (if you use Self-Start, this will be prevented automatically).
26-
- Swarm provides extra Comfy nodes automatically to Self-Start ComfyUI instances from folders within the ComfyUI extension folder, including `DLNodes` and `ExtraNodes` - it is highly recommended you copy these to your remote Comfy's `custom_nodes` path.
27+
- Swarm provides extra Comfy nodes automatically to Self-Start ComfyUI instances from folders within the ComfyUI extension folder, including `DLNodes` and `ExtraNodes` - it is highly recommended you copy these to your remote Comfy's `custom_nodes` path, or point to them with your `extra_model_paths` file.
28+
- If you use a Self-Start backend, it will autogenerate a valid extra model paths file into the `Data` folder, you may wish to do that to copy for your comfy API instance.
2729

2830
### Basic Usage Within SwarmUI
2931

30-
(TODO)
32+
(TODO): tldr don't worry about it, it just works, follow general Swarm usage docs
3133

3234
### Using Workflows In The UI
3335

0 commit comments

Comments
 (0)