You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Contributing to StableSwarmUI
1
+
# Contributing to SwarmUI
2
2
3
3
Please open an Issue or Discussion, or ask on Discord before opening a pull request, to make sure your work doesn't overlap with others.
4
4
@@ -12,7 +12,7 @@ Want to help translate Swarm into another language?
12
12
- Are you just helping improve an existing language?
13
13
- Great! Just edit the file in `languages/(language-code).json` and improve the translations included
14
14
- Do you want to add a new language?
15
-
- See example commit here: https://github.com/Stability-AI/StableSwarmUI/commit/20fd27a20127b6529a2837eb838a0cfae80c20b8
15
+
- See example commit here: https://github.com/mcmonkeyprojects/SwarmUI/commit/20fd27a20127b6529a2837eb838a0cfae80c20b8
16
16
- In short: copy/paste `languages/en.json` to `languages/(your-code).json`, fill out the info at the top, and start translating keys.
17
17
- Also add `src/wwwroot/imgs/flags/(your-code).jpg` as a small icon image of a flag that represents the language.
18
18
- You can use https://github.com/mcmonkeyprojects/translate-tool to fill out any keys you can't be bothered filling in yourself with automatic AI-powered translation
Join the [Discord](https://discord.gg/q2y38cqjNw) to discuss the project, get support, see announcements, etc.
10
10
11
-
Follow the [Feature Announcements Thread](https://github.com/Stability-AI/StableSwarmUI/discussions/11) for updates on new features.
12
-
13
-
# Migration Notice
14
-
15
-
As of 2024/06/21 StableSwarmUI will no longer be maintained under Stability AI.
16
-
17
-
The original developer will be maintaining an independent version of this project as [mcmonkeyprojects/SwarmUI](https://github.com/mcmonkeyprojects/SwarmUI)
18
-
19
-
Windows users can migrate to the new independent repo by simply updating and then running `migrate-windows.bat`
20
-
21
-
For Linux, Mac, or manual Windows: open a terminal in your Swarm folder then run `git remote set-url origin https://github.com/mcmonkeyprojects/SwarmUI`
22
-
23
-
See full migration guide here: https://github.com/mcmonkeyprojects/SwarmUI/discussions/2
11
+
Follow the [Feature Announcements Thread](https://github.com/mcmonkeyprojects/SwarmUI/discussions/1) for updates on new features.
24
12
25
13
----
26
14
@@ -45,7 +33,7 @@ Key feature targets not yet implemented:
45
33
46
34
**WARNING**: Google Colab does not necessarily allow remote WebUIs, particularly for free accounts, use at your own risk.
47
35
48
-
Colab link if you want to try Swarm: https://colab.research.google.com/github/Stability-AI/StableSwarmUI/blob/master/colab/colab-notebook.ipynb
36
+
Colab link if you want to try Swarm: https://colab.research.google.com/github/mcmonkeyprojects/SwarmUI/blob/master/colab/colab-notebook.ipynb
49
37
50
38
### Runpod
51
39
@@ -57,11 +45,11 @@ Note it may take several minutes to start up the first time. Check the container
57
45
58
46
Note: if you're on Windows 10, you may need to manually install [git](https://git-scm.com/download/win) and [DotNET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) first. (Windows 11 this is automated).
59
47
60
-
- Download [The Install-Windows.bat file](https://github.com/Stability-AI/StableSwarmUI/releases/download/0.6.1-Beta/install-windows.bat), store it somewhere you want to install at (not `Program Files`), and run it.
48
+
- Download [The Install-Windows.bat file](https://github.com/mcmonkeyprojects/SwarmUI/releases/download/0.6.5-Beta/install-windows.bat), store it somewhere you want to install at (not `Program Files`), and run it.
61
49
- It should open a command prompt and install itself.
62
50
- If it closes without going further, try running it again, it sometimes needs to run twice. (TODO: Fix that)
63
51
- It will place an icon on your desktop that you can use to re-launch the server at any time.
64
-
- When the installer completes, it will automatically launch the StableSwarmUI server, and open a browser window to the install page.
52
+
- When the installer completes, it will automatically launch the SwarmUI server, and open a browser window to the install page.
65
53
- Follow the install instructions on the page.
66
54
- After you submit, be patient, some of the install processing take a few minutes (downloading models and etc).
67
55
@@ -71,16 +59,16 @@ Note: if you're on Windows 10, you may need to manually install [git](https://gi
71
59
72
60
- Install git from https://git-scm.com/download/win
73
61
- Install DotNET 8 SDK from https://dotnet.microsoft.com/en-us/download/dotnet/8.0 (Make sure to get the SDK x64 for Windows)
74
-
- open a terminal to the folder you want swarm in and run `git clone https://github.com/Stability-AI/StableSwarmUI`
62
+
- open a terminal to the folder you want swarm in and run `git clone https://github.com/mcmonkeyprojects/SwarmUI`
75
63
- open the folder and run `launch-windows.bat`
76
64
77
65
# Installing on Linux
78
66
79
67
- Install `git`, `python3` via your OS package manager if they are not already installed (make sure to include `pip` and `venv` on distros that do not include them in python directly)
80
68
- For example, on recent Ubuntu versions, `sudo apt install git python3-pip python3-venv`
81
-
- Download [the install-linux.sh file](https://github.com/Stability-AI/StableSwarmUI/releases/download/0.6.1-Beta/install-linux.sh), store it somewhere you want to install at, and run it
69
+
- Download [the install-linux.sh file](https://github.com/mcmonkeyprojects/SwarmUI/releases/download/0.6.5-Beta/install-linux.sh), store it somewhere you want to install at, and run it
82
70
- If you like terminals, you can open a terminal to the folder and run the following commands:
- Run the `./install-linux.sh` script, it will install everything for you and eventually open the webpage in your browser.
86
74
- Follow the install instructions on-page.
@@ -96,8 +84,8 @@ Note: if you're on Windows 10, you may need to manually install [git](https://gi
96
84
- Some users [have said](https://github.com/Stability-AI/StableSwarmUI/pull/6) that certain Linux distros expect `aspnet-runtime` to be installed separately
97
85
- Open a shell terminal and `cd` to a directory you want to install into
- open `http://localhost:7801/Install` (if it doesn't launch itself)
103
91
- Follow the install instructions on-page.
@@ -106,28 +94,28 @@ Note: if you're on Windows 10, you may need to manually install [git](https://gi
106
94
107
95
# Installing on Mac
108
96
109
-
> **Note**: You can only run StableSwarmUI on Mac computers with M1 or M2 (Mx) Apple silicon processors.
97
+
> **Note**: You can only run SwarmUI on Mac computers with M1 or M2 (Mx) Apple silicon processors.
110
98
111
99
- Open Terminal.
112
100
- Ensure your `brew` packages are updated with `brew update`.
113
101
- Verify your `brew` installation with `brew doctor`. You should not see any error in the command output.
114
102
- Install .NET for macOS: `brew install dotnet`.
115
103
- If you don't have Python, install it: `brew install python@3.10` and `brew install virtualenv`
116
-
- Change the directory (`cd`) to the folder where you want to install StableSwarmUI.
117
-
- Clone the StableSwarmUI GitHub repository: `git clone https://github.com/Stability-AI/StableSwarmUI`.
118
-
-`cd StableSwarmUI` and run the installation script: `./launch-macos.sh`.
104
+
- Change the directory (`cd`) to the folder where you want to install SwarmUI.
105
+
- Clone the SwarmUI GitHub repository: `git clone https://github.com/mcmonkeyprojects/SwarmUI`.
106
+
-`cd eSwarmUI` and run the installation script: `./launch-macos.sh`.
119
107
120
-
The installation starts now and downloads the Stable Diffusion models from the internet. Depending on your internet connection, this may take several minutes. Wait for your web browser to open the StableSwarmUI window.
108
+
The installation starts now and downloads the Stable Diffusion models from the internet. Depending on your internet connection, this may take several minutes. Wait for your web browser to open the SwarmUI window.
121
109
122
-
> During the StableSwarmUI installation, you are prompted for the type of backend you want to use. For Mac computers with M1 or M2, you can safely choose the ComfyUI backend and choose the Stable Diffusion XL Base and Refiner models in the Download Models screen.
110
+
> During the SwarmUI installation, you are prompted for the type of backend you want to use. For Mac computers with M1 or M2, you can safely choose the ComfyUI backend and choose the Stable Diffusion XL Base and Refiner models in the Download Models screen.
123
111
124
112
# Running with Docker
125
113
126
114
- To forward an Nvidia GPU, you must have the Nvidia Container Toolkit installed: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html
127
115
- Open a shell terminal and `cd` to a directory you want to install into
- Note that it will forward the `Models` and `Output` directory, and will mount `Data` and `dlbackend` as independent persistent volumes.
@@ -140,7 +128,7 @@ See [the documentation folder](/docs/README.md).
140
128
141
129
The "Swarm" name is in reference to the original key function of the UI: enabling a 'swarm' of GPUs to all generate images for the same user at once (especially for large grid generations). This is just the feature that inspired the name and not the end all of what Swarm is.
142
130
143
-
The overall goal of StableSwarmUI is to a be full-featured one-stop-shop for all things Stable Diffusion.
131
+
The overall goal of SwarmUI is to a be full-featured one-stop-shop for all things Stable Diffusion.
144
132
145
133
See [the motivations document](/docs/Motivations.md) for motivations on technical choices.
146
134
@@ -161,13 +149,20 @@ This project:
161
149
- has the option to connect to remote servers to use [the Stability AI API](https://platform.stability.ai/) as a backend.
162
150
- supports user-built extensions which may have their own licenses or legal conditions.
163
151
164
-
StableSwarmUI itself is under the MIT license, however some usages may be affected by the GPL variant licenses of connected projects list above, and note that any models used have their own licenses.
152
+
SwarmUI itself is under the MIT license, however some usages may be affected by the GPL variant licenses of connected projects list above, and note that any models used have their own licenses.
153
+
154
+
### Previous License
155
+
156
+
(For updates prior to June 2024)
157
+
158
+
The MIT License (MIT)
159
+
Copyright (c) 2024 Stability AI
165
160
166
161
### License
167
162
168
163
The MIT License (MIT)
169
164
170
-
Copyright (c) 2024 Stability AI
165
+
Copyright (c) 2024 Alex "mcmonkey" Goodwin
171
166
172
167
Permission is hereby granted, free of charge, to any person obtaining a copy
173
168
of this software and associated documentation files (the "Software"), to deal
Copy file name to clipboardExpand all lines: colab/colab-notebook.ipynb
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@
22
22
"SWARMPATH = '/content/drive/MyDrive'\n",
23
23
"\n",
24
24
"# Colab breaks venvs, and doesn't save anything valid to drive, so just screw it do a global install of pip reqs if we used a comfy backend in the drive\n",
Copy file name to clipboardExpand all lines: docs/API.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# StableSwarmUI API Documentation
1
+
# SwarmUI API Documentation
2
2
3
-
StableSwarmUI has a full-capability network API that you can use from external programs, both to use Swarm features (eg generate images) and to manage the Swarm instance (eg modify backends).
3
+
SwarmUI has a full-capability network API that you can use from external programs, both to use Swarm features (eg generate images) and to manage the Swarm instance (eg modify backends).
4
4
5
5
Swarm uses its own API - you can simply open the web interface, open your browser tools, and interact with Swarm to watch what API calls are made, and then replicate those from your own code.
0 commit comments