atikur-rabbi commited on
Commit
7b85f3f
1 Parent(s): 00556cd
Files changed (5) hide show
  1. CHANGELOG.md +0 -386
  2. Dockerfile +27 -17
  3. LICENSE +0 -661
  4. README.md +1 -256
  5. requirements.txt +0 -6
CHANGELOG.md DELETED
@@ -1,386 +0,0 @@
1
- # Changelog
2
-
3
- ## [v1.34.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.33.0...v1.34.0) - 2023-03-17
4
-
5
- ### Added
6
-
7
- * Add test for custom model and vae tiling
8
- * Add vae tiling for high resolution images
9
- * Update diffusers, onnx, and safetensors
10
-
11
- ## [v1.33.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.32.0...v1.33.0) - 2023-02-25
12
-
13
- ### Added
14
-
15
- * Update diffusers to 0.13.1
16
-
17
- ### Fixed
18
-
19
- * Ensure booleans do not consume other args
20
-
21
- ## [v1.32.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.31.0...v1.32.0) - 2023-02-20
22
-
23
- ### Added
24
-
25
- * Ensure onnx option is tested
26
- * Split onnx into separate option
27
-
28
- ## [v1.31.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.30.1...v1.31.0) - 2023-02-17
29
-
30
- ### Added
31
-
32
- * Add test for instruct pix2pix
33
- * Add instruct pix2pix pipeline
34
- * Update transformers to 4.26.1
35
- * Update onnxruntime to 1.14.0
36
-
37
- ### Changed
38
-
39
- * Add full-sized image for testing
40
-
41
- ## [v1.30.1](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.30.0...v1.30.1) - 2023-02-03
42
-
43
- ### Fixed
44
-
45
- * Switch xformers to 0.0.16 stable
46
-
47
- ## [v1.30.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.29.0...v1.30.0) - 2023-01-28
48
-
49
- ### Added
50
-
51
- * Update diffusers to 0.12.1
52
-
53
- ### Changed
54
-
55
- * Reorder arguments alphabetically
56
- * Rename option names in tests
57
- * Rename certain options for ease-of-use
58
-
59
- ### Fixed
60
-
61
- * Download test image since img folder is gone
62
- * Rename option names in depth diffusion test
63
-
64
- ## [v1.29.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.28.0...v1.29.0) - 2023-01-26
65
-
66
- ### Added
67
-
68
- * Add test for depth-guided diffusion
69
- * Add depth-guided stable diffusion
70
-
71
- ## [v1.28.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.27.0...v1.28.0) - 2023-01-26
72
-
73
- ### Added
74
-
75
- * Upgrade diffusers to 0.12.0
76
-
77
- ### Fixed
78
-
79
- * Suppress CLIPFeatureExtractor warning
80
-
81
- ## [v1.27.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.26.0...v1.27.0) - 2023-01-16
82
-
83
- ### Added
84
-
85
- * Automatically publish new versions
86
-
87
- ### Fixed
88
-
89
- * Update unstable xformers to 0.0.16rc425
90
-
91
- ## [v1.26.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.25.1...v1.26.0) - 2023-01-13
92
-
93
- ### Added
94
-
95
- * Support pulling image from ghcr
96
- * Publish docker pipeline to ghcr
97
-
98
- ### Changed
99
-
100
- * Simplify ghcr publish action
101
- * Move ghcr url into variable
102
-
103
- ## [v1.25.1](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.25.0...v1.25.1) - 2023-01-10
104
-
105
- ### Fixed
106
-
107
- * Update safetensors and unstable xformers
108
- * Add numpy 1.23.5 to fix float errors
109
-
110
- ## [v1.25.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.24.0...v1.25.0) - 2022-12-26
111
-
112
- ### Added
113
-
114
- * Add test for scheduler option
115
- * Allow different schedulers to be used
116
- * Update torch to 1.13.1 and unstable xformers
117
-
118
- ## [v1.24.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.23.0...v1.24.0) - 2022-12-20
119
-
120
- ### Added
121
-
122
- * Add tests for stable diffusion 2.0 and 2.1
123
- * Update diffusers to 0.11.1
124
- * Switch to python slim and halve image size
125
-
126
- ## [v1.23.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.22.0...v1.23.0) - 2022-12-14
127
-
128
- ### Added
129
-
130
- * Add memory efficient transformers
131
- * Add test for image upscaling
132
-
133
- ### Fixed
134
-
135
- * Ensure default test produces output
136
-
137
- ## [v1.22.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.21.0...v1.22.0) - 2022-12-12
138
-
139
- ### Added
140
-
141
- * Add upscaler pipeline
142
- * Update diffusers to 0.10.2
143
-
144
- ## [v1.21.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.20.0...v1.21.0) - 2022-12-09
145
-
146
- ### Added
147
-
148
- * Update diffusers to 0.10.1
149
- * Update diffusers to 0.10.0
150
- * Update transformers to 4.25.1
151
-
152
- ### Fixed
153
-
154
- * Remove use of autocast
155
- * Remove unused arguments from pipeline
156
- * Return after setting gpu arg
157
- * Removed unused imports
158
-
159
- ## [v1.20.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.19.1...v1.20.0) - 2022-11-29
160
-
161
- ### Added
162
-
163
- * Update diffusers to 0.9.0
164
- * Update tensorflow to 2.11.0
165
-
166
- ### Fixed
167
-
168
- * Ensure skip option works on onnx pipeline
169
-
170
- ## [v1.19.1](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.19.0...v1.19.1) - 2022-11-22
171
-
172
- ### Added
173
-
174
- * Test image to image pipeline
175
-
176
- ### Fixed
177
-
178
- * Do not pass gpu arg if using cpu pipeline
179
-
180
- ## [v1.19.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.18.0...v1.19.0) - 2022-11-17
181
-
182
- ### Added
183
-
184
- * Add test for cpu pipeline
185
- * Add cpu pipeline using onnx
186
-
187
- ### Changed
188
-
189
- * Test image with different dimensions
190
-
191
- ## [v1.18.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.17.0...v1.18.0) - 2022-11-11
192
-
193
- ### Added
194
-
195
- * Add diffusion inpainting
196
-
197
- ## [v1.17.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.16.0...v1.17.0) - 2022-11-08
198
-
199
- ### Added
200
-
201
- * Add image-to-image diffusion
202
- * Add input folder for image-to-image diffusion
203
-
204
- ### Changed
205
-
206
- * Call run command directly from tests
207
-
208
- ### Fixed
209
-
210
- * Ensure output folder is always created
211
-
212
- ## [v1.16.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.15.0...v1.16.0) - 2022-11-07
213
-
214
- ### Added
215
-
216
- * Add standard tests for all options
217
- * Upgrade diffusers to 0.7.2
218
-
219
- ## [v1.15.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.14.0...v1.15.0) - 2022-11-04
220
-
221
- ### Added
222
-
223
- * Add negative prompts
224
-
225
- ### Changed
226
-
227
- * Switch to using num_images_per_prompt
228
-
229
- ## [v1.14.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.13.0...v1.14.0) - 2022-11-03
230
-
231
- ### Added
232
-
233
- * Upgrade diffusers to 0.7.0
234
-
235
- ## [v1.13.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.12.0...v1.13.0) - 2022-11-02
236
-
237
- ### Added
238
-
239
- * Upgrade torch to 1.13.0 and cuda to 11.7
240
-
241
- ## [v1.12.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.11.1...v1.12.0) - 2022-11-01
242
-
243
- ### Added
244
-
245
- * Update transformers to v4.24.0
246
-
247
- ### Fixed
248
-
249
- * Always use torch instead of tensorflow
250
-
251
- ## [v1.11.1](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.11.0...v1.11.1) - 2022-10-26
252
-
253
- ### Changed
254
-
255
- * Split pipeline and inference
256
-
257
- ## [v1.11.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.10.0...v1.11.0) - 2022-10-21
258
-
259
- ### Added
260
-
261
- * Make model configurable
262
-
263
- ## [v1.10.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.9.0...v1.10.0) - 2022-10-19
264
-
265
- ### Added
266
-
267
- * Upgrade to diffusers 0.6.0
268
-
269
- ### Fixed
270
-
271
- * Switch output and image names
272
-
273
- ## [v1.9.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.8.1...v1.9.0) - 2022-10-14
274
-
275
- ### Added
276
-
277
- * Upgrade to latest huggingface releases
278
-
279
- ## [v1.8.1](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.8.0...v1.8.1) - 2022-10-13
280
-
281
- ### Fixed
282
-
283
- * Remove cuda stubs to prevent errors
284
-
285
- ## [v1.8.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.7.0...v1.8.0) - 2022-10-12
286
-
287
- ### Added
288
-
289
- * Upgrade to diffusers 0.4.2
290
-
291
- ## [v1.7.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.6.0...v1.7.0) - 2022-10-07
292
-
293
- ### Added
294
-
295
- * Upgrade to diffusers 0.4.1
296
- * Pin dependencies using requirements.txt
297
-
298
- ## [v1.6.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.5.0...v1.6.0) - 2022-09-14
299
-
300
- ### Added
301
-
302
- * Add attention slicing
303
-
304
- ### Changed
305
-
306
- * Use tagged version of tensorflow
307
-
308
- ## [v1.5.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.4.0...v1.5.0) - 2022-09-08
309
-
310
- ### Added
311
-
312
- * Specify user access token at command line
313
-
314
- ## [v1.4.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.3.0...v1.4.0) - 2022-09-05
315
-
316
- ### Added
317
-
318
- * Add pipeline iteration
319
-
320
- ### Changed
321
-
322
- * Move image name out of loop
323
-
324
- ## [v1.3.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.2.2...v1.3.0) - 2022-09-02
325
-
326
- ### Added
327
-
328
- * Support skipping safety checker
329
-
330
- ## [v1.2.2](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.2.1...v1.2.2) - 2022-09-01
331
-
332
- ### Changed
333
-
334
- * Rename iso date time function
335
-
336
- ### Fixed
337
-
338
- * Prevent errors when file name is too long
339
-
340
- ## [v1.2.1](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.2.0...v1.2.1) - 2022-08-29
341
-
342
- ### Fixed
343
-
344
- * Allow full range of random seeds
345
-
346
- ## [v1.2.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.1.1...v1.2.0) - 2022-08-26
347
-
348
- ### Added
349
-
350
- * Support half-sized (float16) tensors
351
-
352
- ### Changed
353
-
354
- * Update scale argument description
355
-
356
- ### Fixed
357
-
358
- * Remove unused sys import
359
-
360
- ## [v1.1.1](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.1.0...v1.1.1) - 2022-08-25
361
-
362
- ### Fixed
363
-
364
- * Double quote to prevent globbing
365
- * Only output two digits of precision
366
-
367
- ## [v1.1.0](https://github.com/fboulnois/stable-diffusion-docker/compare/v1.0.0...v1.1.0) - 2022-08-24
368
-
369
- ### Added
370
-
371
- * Add a subset of txt2img.py options
372
- * Include model params in image filename
373
-
374
- ### Changed
375
-
376
- * Use enumerate instead of index
377
-
378
- ### Fixed
379
-
380
- * Remove unnecessary image library import
381
-
382
- ## [v1.0.0](https://github.com/fboulnois/stable-diffusion-docker/releases/tag/v1.0.0) - 2022-08-22
383
-
384
- ### Added
385
-
386
- * Initial release
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Dockerfile CHANGED
@@ -1,11 +1,24 @@
1
- FROM python:3.10-slim-bullseye
2
-
3
- RUN rm -rf /usr/local/cuda/lib64/stubs
4
-
5
- COPY requirements.txt /
6
-
7
- RUN pip install -r requirements.txt \
8
- --extra-index-url https://download.pytorch.org/whl/cu117
 
 
 
 
 
 
 
 
 
 
 
 
 
9
 
10
  RUN useradd -m huggingface
11
 
@@ -13,13 +26,10 @@ USER huggingface
13
 
14
  WORKDIR /home/huggingface
15
 
16
- ENV USE_TORCH=1
17
-
18
- RUN mkdir -p /home/huggingface/.cache/huggingface \
19
- && mkdir -p /home/huggingface/input \
20
- && mkdir -p /home/huggingface/output
21
-
22
- COPY docker-entrypoint.py /usr/local/bin
23
- # COPY token.txt /home/huggingface
24
 
25
- ENTRYPOINT [ "docker-entrypoint.py" ]
 
 
 
1
+ FROM ubuntu:20.04
2
+
3
+ RUN apt-get update && apt-get install -y --no-install-recommends \
4
+ build-essential \
5
+ ca-certificates \
6
+ curl \
7
+ git \
8
+ libgl1-mesa-glx \
9
+ libglib2.0-0 \
10
+ libsm6 \
11
+ libxext6 \
12
+ libxrender-dev \
13
+ python3-dev \
14
+ python3-pip \
15
+ python3-setuptools \
16
+ python3-wheel \
17
+ sudo \
18
+ unzip \
19
+ vim \
20
+ wget \
21
+ && rm -rf /var/lib/apt/lists/*
22
 
23
  RUN useradd -m huggingface
24
 
 
26
 
27
  WORKDIR /home/huggingface
28
 
29
+ RUN wget https://github.com/cmdr2/stable-diffusion-ui/releases/download/v2.5.24/Easy-Diffusion-Linux.zip && \
30
+ unzip Easy-Diffusion-Linux.zip && \
31
+ rm Easy-Diffusion-Linux.zip
 
 
 
 
 
32
 
33
+ # ENTRYPOINT [ "docker-entrypoint.py" ]
34
+ RUN cd Easy-Diffusion-Linux/easy-diffusion && \
35
+ ls
LICENSE DELETED
@@ -1,661 +0,0 @@
1
- GNU AFFERO GENERAL PUBLIC LICENSE
2
- Version 3, 19 November 2007
3
-
4
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5
- Everyone is permitted to copy and distribute verbatim copies
6
- of this license document, but changing it is not allowed.
7
-
8
- Preamble
9
-
10
- The GNU Affero General Public License is a free, copyleft license for
11
- software and other kinds of works, specifically designed to ensure
12
- cooperation with the community in the case of network server software.
13
-
14
- The licenses for most software and other practical works are designed
15
- to take away your freedom to share and change the works. By contrast,
16
- our General Public Licenses are intended to guarantee your freedom to
17
- share and change all versions of a program--to make sure it remains free
18
- software for all its users.
19
-
20
- When we speak of free software, we are referring to freedom, not
21
- price. Our General Public Licenses are designed to make sure that you
22
- have the freedom to distribute copies of free software (and charge for
23
- them if you wish), that you receive source code or can get it if you
24
- want it, that you can change the software or use pieces of it in new
25
- free programs, and that you know you can do these things.
26
-
27
- Developers that use our General Public Licenses protect your rights
28
- with two steps: (1) assert copyright on the software, and (2) offer
29
- you this License which gives you legal permission to copy, distribute
30
- and/or modify the software.
31
-
32
- A secondary benefit of defending all users' freedom is that
33
- improvements made in alternate versions of the program, if they
34
- receive widespread use, become available for other developers to
35
- incorporate. Many developers of free software are heartened and
36
- encouraged by the resulting cooperation. However, in the case of
37
- software used on network servers, this result may fail to come about.
38
- The GNU General Public License permits making a modified version and
39
- letting the public access it on a server without ever releasing its
40
- source code to the public.
41
-
42
- The GNU Affero General Public License is designed specifically to
43
- ensure that, in such cases, the modified source code becomes available
44
- to the community. It requires the operator of a network server to
45
- provide the source code of the modified version running there to the
46
- users of that server. Therefore, public use of a modified version, on
47
- a publicly accessible server, gives the public access to the source
48
- code of the modified version.
49
-
50
- An older license, called the Affero General Public License and
51
- published by Affero, was designed to accomplish similar goals. This is
52
- a different license, not a version of the Affero GPL, but Affero has
53
- released a new version of the Affero GPL which permits relicensing under
54
- this license.
55
-
56
- The precise terms and conditions for copying, distribution and
57
- modification follow.
58
-
59
- TERMS AND CONDITIONS
60
-
61
- 0. Definitions.
62
-
63
- "This License" refers to version 3 of the GNU Affero General Public License.
64
-
65
- "Copyright" also means copyright-like laws that apply to other kinds of
66
- works, such as semiconductor masks.
67
-
68
- "The Program" refers to any copyrightable work licensed under this
69
- License. Each licensee is addressed as "you". "Licensees" and
70
- "recipients" may be individuals or organizations.
71
-
72
- To "modify" a work means to copy from or adapt all or part of the work
73
- in a fashion requiring copyright permission, other than the making of an
74
- exact copy. The resulting work is called a "modified version" of the
75
- earlier work or a work "based on" the earlier work.
76
-
77
- A "covered work" means either the unmodified Program or a work based
78
- on the Program.
79
-
80
- To "propagate" a work means to do anything with it that, without
81
- permission, would make you directly or secondarily liable for
82
- infringement under applicable copyright law, except executing it on a
83
- computer or modifying a private copy. Propagation includes copying,
84
- distribution (with or without modification), making available to the
85
- public, and in some countries other activities as well.
86
-
87
- To "convey" a work means any kind of propagation that enables other
88
- parties to make or receive copies. Mere interaction with a user through
89
- a computer network, with no transfer of a copy, is not conveying.
90
-
91
- An interactive user interface displays "Appropriate Legal Notices"
92
- to the extent that it includes a convenient and prominently visible
93
- feature that (1) displays an appropriate copyright notice, and (2)
94
- tells the user that there is no warranty for the work (except to the
95
- extent that warranties are provided), that licensees may convey the
96
- work under this License, and how to view a copy of this License. If
97
- the interface presents a list of user commands or options, such as a
98
- menu, a prominent item in the list meets this criterion.
99
-
100
- 1. Source Code.
101
-
102
- The "source code" for a work means the preferred form of the work
103
- for making modifications to it. "Object code" means any non-source
104
- form of a work.
105
-
106
- A "Standard Interface" means an interface that either is an official
107
- standard defined by a recognized standards body, or, in the case of
108
- interfaces specified for a particular programming language, one that
109
- is widely used among developers working in that language.
110
-
111
- The "System Libraries" of an executable work include anything, other
112
- than the work as a whole, that (a) is included in the normal form of
113
- packaging a Major Component, but which is not part of that Major
114
- Component, and (b) serves only to enable use of the work with that
115
- Major Component, or to implement a Standard Interface for which an
116
- implementation is available to the public in source code form. A
117
- "Major Component", in this context, means a major essential component
118
- (kernel, window system, and so on) of the specific operating system
119
- (if any) on which the executable work runs, or a compiler used to
120
- produce the work, or an object code interpreter used to run it.
121
-
122
- The "Corresponding Source" for a work in object code form means all
123
- the source code needed to generate, install, and (for an executable
124
- work) run the object code and to modify the work, including scripts to
125
- control those activities. However, it does not include the work's
126
- System Libraries, or general-purpose tools or generally available free
127
- programs which are used unmodified in performing those activities but
128
- which are not part of the work. For example, Corresponding Source
129
- includes interface definition files associated with source files for
130
- the work, and the source code for shared libraries and dynamically
131
- linked subprograms that the work is specifically designed to require,
132
- such as by intimate data communication or control flow between those
133
- subprograms and other parts of the work.
134
-
135
- The Corresponding Source need not include anything that users
136
- can regenerate automatically from other parts of the Corresponding
137
- Source.
138
-
139
- The Corresponding Source for a work in source code form is that
140
- same work.
141
-
142
- 2. Basic Permissions.
143
-
144
- All rights granted under this License are granted for the term of
145
- copyright on the Program, and are irrevocable provided the stated
146
- conditions are met. This License explicitly affirms your unlimited
147
- permission to run the unmodified Program. The output from running a
148
- covered work is covered by this License only if the output, given its
149
- content, constitutes a covered work. This License acknowledges your
150
- rights of fair use or other equivalent, as provided by copyright law.
151
-
152
- You may make, run and propagate covered works that you do not
153
- convey, without conditions so long as your license otherwise remains
154
- in force. You may convey covered works to others for the sole purpose
155
- of having them make modifications exclusively for you, or provide you
156
- with facilities for running those works, provided that you comply with
157
- the terms of this License in conveying all material for which you do
158
- not control copyright. Those thus making or running the covered works
159
- for you must do so exclusively on your behalf, under your direction
160
- and control, on terms that prohibit them from making any copies of
161
- your copyrighted material outside their relationship with you.
162
-
163
- Conveying under any other circumstances is permitted solely under
164
- the conditions stated below. Sublicensing is not allowed; section 10
165
- makes it unnecessary.
166
-
167
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168
-
169
- No covered work shall be deemed part of an effective technological
170
- measure under any applicable law fulfilling obligations under article
171
- 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172
- similar laws prohibiting or restricting circumvention of such
173
- measures.
174
-
175
- When you convey a covered work, you waive any legal power to forbid
176
- circumvention of technological measures to the extent such circumvention
177
- is effected by exercising rights under this License with respect to
178
- the covered work, and you disclaim any intention to limit operation or
179
- modification of the work as a means of enforcing, against the work's
180
- users, your or third parties' legal rights to forbid circumvention of
181
- technological measures.
182
-
183
- 4. Conveying Verbatim Copies.
184
-
185
- You may convey verbatim copies of the Program's source code as you
186
- receive it, in any medium, provided that you conspicuously and
187
- appropriately publish on each copy an appropriate copyright notice;
188
- keep intact all notices stating that this License and any
189
- non-permissive terms added in accord with section 7 apply to the code;
190
- keep intact all notices of the absence of any warranty; and give all
191
- recipients a copy of this License along with the Program.
192
-
193
- You may charge any price or no price for each copy that you convey,
194
- and you may offer support or warranty protection for a fee.
195
-
196
- 5. Conveying Modified Source Versions.
197
-
198
- You may convey a work based on the Program, or the modifications to
199
- produce it from the Program, in the form of source code under the
200
- terms of section 4, provided that you also meet all of these conditions:
201
-
202
- a) The work must carry prominent notices stating that you modified
203
- it, and giving a relevant date.
204
-
205
- b) The work must carry prominent notices stating that it is
206
- released under this License and any conditions added under section
207
- 7. This requirement modifies the requirement in section 4 to
208
- "keep intact all notices".
209
-
210
- c) You must license the entire work, as a whole, under this
211
- License to anyone who comes into possession of a copy. This
212
- License will therefore apply, along with any applicable section 7
213
- additional terms, to the whole of the work, and all its parts,
214
- regardless of how they are packaged. This License gives no
215
- permission to license the work in any other way, but it does not
216
- invalidate such permission if you have separately received it.
217
-
218
- d) If the work has interactive user interfaces, each must display
219
- Appropriate Legal Notices; however, if the Program has interactive
220
- interfaces that do not display Appropriate Legal Notices, your
221
- work need not make them do so.
222
-
223
- A compilation of a covered work with other separate and independent
224
- works, which are not by their nature extensions of the covered work,
225
- and which are not combined with it such as to form a larger program,
226
- in or on a volume of a storage or distribution medium, is called an
227
- "aggregate" if the compilation and its resulting copyright are not
228
- used to limit the access or legal rights of the compilation's users
229
- beyond what the individual works permit. Inclusion of a covered work
230
- in an aggregate does not cause this License to apply to the other
231
- parts of the aggregate.
232
-
233
- 6. Conveying Non-Source Forms.
234
-
235
- You may convey a covered work in object code form under the terms
236
- of sections 4 and 5, provided that you also convey the
237
- machine-readable Corresponding Source under the terms of this License,
238
- in one of these ways:
239
-
240
- a) Convey the object code in, or embodied in, a physical product
241
- (including a physical distribution medium), accompanied by the
242
- Corresponding Source fixed on a durable physical medium
243
- customarily used for software interchange.
244
-
245
- b) Convey the object code in, or embodied in, a physical product
246
- (including a physical distribution medium), accompanied by a
247
- written offer, valid for at least three years and valid for as
248
- long as you offer spare parts or customer support for that product
249
- model, to give anyone who possesses the object code either (1) a
250
- copy of the Corresponding Source for all the software in the
251
- product that is covered by this License, on a durable physical
252
- medium customarily used for software interchange, for a price no
253
- more than your reasonable cost of physically performing this
254
- conveying of source, or (2) access to copy the
255
- Corresponding Source from a network server at no charge.
256
-
257
- c) Convey individual copies of the object code with a copy of the
258
- written offer to provide the Corresponding Source. This
259
- alternative is allowed only occasionally and noncommercially, and
260
- only if you received the object code with such an offer, in accord
261
- with subsection 6b.
262
-
263
- d) Convey the object code by offering access from a designated
264
- place (gratis or for a charge), and offer equivalent access to the
265
- Corresponding Source in the same way through the same place at no
266
- further charge. You need not require recipients to copy the
267
- Corresponding Source along with the object code. If the place to
268
- copy the object code is a network server, the Corresponding Source
269
- may be on a different server (operated by you or a third party)
270
- that supports equivalent copying facilities, provided you maintain
271
- clear directions next to the object code saying where to find the
272
- Corresponding Source. Regardless of what server hosts the
273
- Corresponding Source, you remain obligated to ensure that it is
274
- available for as long as needed to satisfy these requirements.
275
-
276
- e) Convey the object code using peer-to-peer transmission, provided
277
- you inform other peers where the object code and Corresponding
278
- Source of the work are being offered to the general public at no
279
- charge under subsection 6d.
280
-
281
- A separable portion of the object code, whose source code is excluded
282
- from the Corresponding Source as a System Library, need not be
283
- included in conveying the object code work.
284
-
285
- A "User Product" is either (1) a "consumer product", which means any
286
- tangible personal property which is normally used for personal, family,
287
- or household purposes, or (2) anything designed or sold for incorporation
288
- into a dwelling. In determining whether a product is a consumer product,
289
- doubtful cases shall be resolved in favor of coverage. For a particular
290
- product received by a particular user, "normally used" refers to a
291
- typical or common use of that class of product, regardless of the status
292
- of the particular user or of the way in which the particular user
293
- actually uses, or expects or is expected to use, the product. A product
294
- is a consumer product regardless of whether the product has substantial
295
- commercial, industrial or non-consumer uses, unless such uses represent
296
- the only significant mode of use of the product.
297
-
298
- "Installation Information" for a User Product means any methods,
299
- procedures, authorization keys, or other information required to install
300
- and execute modified versions of a covered work in that User Product from
301
- a modified version of its Corresponding Source. The information must
302
- suffice to ensure that the continued functioning of the modified object
303
- code is in no case prevented or interfered with solely because
304
- modification has been made.
305
-
306
- If you convey an object code work under this section in, or with, or
307
- specifically for use in, a User Product, and the conveying occurs as
308
- part of a transaction in which the right of possession and use of the
309
- User Product is transferred to the recipient in perpetuity or for a
310
- fixed term (regardless of how the transaction is characterized), the
311
- Corresponding Source conveyed under this section must be accompanied
312
- by the Installation Information. But this requirement does not apply
313
- if neither you nor any third party retains the ability to install
314
- modified object code on the User Product (for example, the work has
315
- been installed in ROM).
316
-
317
- The requirement to provide Installation Information does not include a
318
- requirement to continue to provide support service, warranty, or updates
319
- for a work that has been modified or installed by the recipient, or for
320
- the User Product in which it has been modified or installed. Access to a
321
- network may be denied when the modification itself materially and
322
- adversely affects the operation of the network or violates the rules and
323
- protocols for communication across the network.
324
-
325
- Corresponding Source conveyed, and Installation Information provided,
326
- in accord with this section must be in a format that is publicly
327
- documented (and with an implementation available to the public in
328
- source code form), and must require no special password or key for
329
- unpacking, reading or copying.
330
-
331
- 7. Additional Terms.
332
-
333
- "Additional permissions" are terms that supplement the terms of this
334
- License by making exceptions from one or more of its conditions.
335
- Additional permissions that are applicable to the entire Program shall
336
- be treated as though they were included in this License, to the extent
337
- that they are valid under applicable law. If additional permissions
338
- apply only to part of the Program, that part may be used separately
339
- under those permissions, but the entire Program remains governed by
340
- this License without regard to the additional permissions.
341
-
342
- When you convey a copy of a covered work, you may at your option
343
- remove any additional permissions from that copy, or from any part of
344
- it. (Additional permissions may be written to require their own
345
- removal in certain cases when you modify the work.) You may place
346
- additional permissions on material, added by you to a covered work,
347
- for which you have or can give appropriate copyright permission.
348
-
349
- Notwithstanding any other provision of this License, for material you
350
- add to a covered work, you may (if authorized by the copyright holders of
351
- that material) supplement the terms of this License with terms:
352
-
353
- a) Disclaiming warranty or limiting liability differently from the
354
- terms of sections 15 and 16 of this License; or
355
-
356
- b) Requiring preservation of specified reasonable legal notices or
357
- author attributions in that material or in the Appropriate Legal
358
- Notices displayed by works containing it; or
359
-
360
- c) Prohibiting misrepresentation of the origin of that material, or
361
- requiring that modified versions of such material be marked in
362
- reasonable ways as different from the original version; or
363
-
364
- d) Limiting the use for publicity purposes of names of licensors or
365
- authors of the material; or
366
-
367
- e) Declining to grant rights under trademark law for use of some
368
- trade names, trademarks, or service marks; or
369
-
370
- f) Requiring indemnification of licensors and authors of that
371
- material by anyone who conveys the material (or modified versions of
372
- it) with contractual assumptions of liability to the recipient, for
373
- any liability that these contractual assumptions directly impose on
374
- those licensors and authors.
375
-
376
- All other non-permissive additional terms are considered "further
377
- restrictions" within the meaning of section 10. If the Program as you
378
- received it, or any part of it, contains a notice stating that it is
379
- governed by this License along with a term that is a further
380
- restriction, you may remove that term. If a license document contains
381
- a further restriction but permits relicensing or conveying under this
382
- License, you may add to a covered work material governed by the terms
383
- of that license document, provided that the further restriction does
384
- not survive such relicensing or conveying.
385
-
386
- If you add terms to a covered work in accord with this section, you
387
- must place, in the relevant source files, a statement of the
388
- additional terms that apply to those files, or a notice indicating
389
- where to find the applicable terms.
390
-
391
- Additional terms, permissive or non-permissive, may be stated in the
392
- form of a separately written license, or stated as exceptions;
393
- the above requirements apply either way.
394
-
395
- 8. Termination.
396
-
397
- You may not propagate or modify a covered work except as expressly
398
- provided under this License. Any attempt otherwise to propagate or
399
- modify it is void, and will automatically terminate your rights under
400
- this License (including any patent licenses granted under the third
401
- paragraph of section 11).
402
-
403
- However, if you cease all violation of this License, then your
404
- license from a particular copyright holder is reinstated (a)
405
- provisionally, unless and until the copyright holder explicitly and
406
- finally terminates your license, and (b) permanently, if the copyright
407
- holder fails to notify you of the violation by some reasonable means
408
- prior to 60 days after the cessation.
409
-
410
- Moreover, your license from a particular copyright holder is
411
- reinstated permanently if the copyright holder notifies you of the
412
- violation by some reasonable means, this is the first time you have
413
- received notice of violation of this License (for any work) from that
414
- copyright holder, and you cure the violation prior to 30 days after
415
- your receipt of the notice.
416
-
417
- Termination of your rights under this section does not terminate the
418
- licenses of parties who have received copies or rights from you under
419
- this License. If your rights have been terminated and not permanently
420
- reinstated, you do not qualify to receive new licenses for the same
421
- material under section 10.
422
-
423
- 9. Acceptance Not Required for Having Copies.
424
-
425
- You are not required to accept this License in order to receive or
426
- run a copy of the Program. Ancillary propagation of a covered work
427
- occurring solely as a consequence of using peer-to-peer transmission
428
- to receive a copy likewise does not require acceptance. However,
429
- nothing other than this License grants you permission to propagate or
430
- modify any covered work. These actions infringe copyright if you do
431
- not accept this License. Therefore, by modifying or propagating a
432
- covered work, you indicate your acceptance of this License to do so.
433
-
434
- 10. Automatic Licensing of Downstream Recipients.
435
-
436
- Each time you convey a covered work, the recipient automatically
437
- receives a license from the original licensors, to run, modify and
438
- propagate that work, subject to this License. You are not responsible
439
- for enforcing compliance by third parties with this License.
440
-
441
- An "entity transaction" is a transaction transferring control of an
442
- organization, or substantially all assets of one, or subdividing an
443
- organization, or merging organizations. If propagation of a covered
444
- work results from an entity transaction, each party to that
445
- transaction who receives a copy of the work also receives whatever
446
- licenses to the work the party's predecessor in interest had or could
447
- give under the previous paragraph, plus a right to possession of the
448
- Corresponding Source of the work from the predecessor in interest, if
449
- the predecessor has it or can get it with reasonable efforts.
450
-
451
- You may not impose any further restrictions on the exercise of the
452
- rights granted or affirmed under this License. For example, you may
453
- not impose a license fee, royalty, or other charge for exercise of
454
- rights granted under this License, and you may not initiate litigation
455
- (including a cross-claim or counterclaim in a lawsuit) alleging that
456
- any patent claim is infringed by making, using, selling, offering for
457
- sale, or importing the Program or any portion of it.
458
-
459
- 11. Patents.
460
-
461
- A "contributor" is a copyright holder who authorizes use under this
462
- License of the Program or a work on which the Program is based. The
463
- work thus licensed is called the contributor's "contributor version".
464
-
465
- A contributor's "essential patent claims" are all patent claims
466
- owned or controlled by the contributor, whether already acquired or
467
- hereafter acquired, that would be infringed by some manner, permitted
468
- by this License, of making, using, or selling its contributor version,
469
- but do not include claims that would be infringed only as a
470
- consequence of further modification of the contributor version. For
471
- purposes of this definition, "control" includes the right to grant
472
- patent sublicenses in a manner consistent with the requirements of
473
- this License.
474
-
475
- Each contributor grants you a non-exclusive, worldwide, royalty-free
476
- patent license under the contributor's essential patent claims, to
477
- make, use, sell, offer for sale, import and otherwise run, modify and
478
- propagate the contents of its contributor version.
479
-
480
- In the following three paragraphs, a "patent license" is any express
481
- agreement or commitment, however denominated, not to enforce a patent
482
- (such as an express permission to practice a patent or covenant not to
483
- sue for patent infringement). To "grant" such a patent license to a
484
- party means to make such an agreement or commitment not to enforce a
485
- patent against the party.
486
-
487
- If you convey a covered work, knowingly relying on a patent license,
488
- and the Corresponding Source of the work is not available for anyone
489
- to copy, free of charge and under the terms of this License, through a
490
- publicly available network server or other readily accessible means,
491
- then you must either (1) cause the Corresponding Source to be so
492
- available, or (2) arrange to deprive yourself of the benefit of the
493
- patent license for this particular work, or (3) arrange, in a manner
494
- consistent with the requirements of this License, to extend the patent
495
- license to downstream recipients. "Knowingly relying" means you have
496
- actual knowledge that, but for the patent license, your conveying the
497
- covered work in a country, or your recipient's use of the covered work
498
- in a country, would infringe one or more identifiable patents in that
499
- country that you have reason to believe are valid.
500
-
501
- If, pursuant to or in connection with a single transaction or
502
- arrangement, you convey, or propagate by procuring conveyance of, a
503
- covered work, and grant a patent license to some of the parties
504
- receiving the covered work authorizing them to use, propagate, modify
505
- or convey a specific copy of the covered work, then the patent license
506
- you grant is automatically extended to all recipients of the covered
507
- work and works based on it.
508
-
509
- A patent license is "discriminatory" if it does not include within
510
- the scope of its coverage, prohibits the exercise of, or is
511
- conditioned on the non-exercise of one or more of the rights that are
512
- specifically granted under this License. You may not convey a covered
513
- work if you are a party to an arrangement with a third party that is
514
- in the business of distributing software, under which you make payment
515
- to the third party based on the extent of your activity of conveying
516
- the work, and under which the third party grants, to any of the
517
- parties who would receive the covered work from you, a discriminatory
518
- patent license (a) in connection with copies of the covered work
519
- conveyed by you (or copies made from those copies), or (b) primarily
520
- for and in connection with specific products or compilations that
521
- contain the covered work, unless you entered into that arrangement,
522
- or that patent license was granted, prior to 28 March 2007.
523
-
524
- Nothing in this License shall be construed as excluding or limiting
525
- any implied license or other defenses to infringement that may
526
- otherwise be available to you under applicable patent law.
527
-
528
- 12. No Surrender of Others' Freedom.
529
-
530
- If conditions are imposed on you (whether by court order, agreement or
531
- otherwise) that contradict the conditions of this License, they do not
532
- excuse you from the conditions of this License. If you cannot convey a
533
- covered work so as to satisfy simultaneously your obligations under this
534
- License and any other pertinent obligations, then as a consequence you may
535
- not convey it at all. For example, if you agree to terms that obligate you
536
- to collect a royalty for further conveying from those to whom you convey
537
- the Program, the only way you could satisfy both those terms and this
538
- License would be to refrain entirely from conveying the Program.
539
-
540
- 13. Remote Network Interaction; Use with the GNU General Public License.
541
-
542
- Notwithstanding any other provision of this License, if you modify the
543
- Program, your modified version must prominently offer all users
544
- interacting with it remotely through a computer network (if your version
545
- supports such interaction) an opportunity to receive the Corresponding
546
- Source of your version by providing access to the Corresponding Source
547
- from a network server at no charge, through some standard or customary
548
- means of facilitating copying of software. This Corresponding Source
549
- shall include the Corresponding Source for any work covered by version 3
550
- of the GNU General Public License that is incorporated pursuant to the
551
- following paragraph.
552
-
553
- Notwithstanding any other provision of this License, you have
554
- permission to link or combine any covered work with a work licensed
555
- under version 3 of the GNU General Public License into a single
556
- combined work, and to convey the resulting work. The terms of this
557
- License will continue to apply to the part which is the covered work,
558
- but the work with which it is combined will remain governed by version
559
- 3 of the GNU General Public License.
560
-
561
- 14. Revised Versions of this License.
562
-
563
- The Free Software Foundation may publish revised and/or new versions of
564
- the GNU Affero General Public License from time to time. Such new versions
565
- will be similar in spirit to the present version, but may differ in detail to
566
- address new problems or concerns.
567
-
568
- Each version is given a distinguishing version number. If the
569
- Program specifies that a certain numbered version of the GNU Affero General
570
- Public License "or any later version" applies to it, you have the
571
- option of following the terms and conditions either of that numbered
572
- version or of any later version published by the Free Software
573
- Foundation. If the Program does not specify a version number of the
574
- GNU Affero General Public License, you may choose any version ever published
575
- by the Free Software Foundation.
576
-
577
- If the Program specifies that a proxy can decide which future
578
- versions of the GNU Affero General Public License can be used, that proxy's
579
- public statement of acceptance of a version permanently authorizes you
580
- to choose that version for the Program.
581
-
582
- Later license versions may give you additional or different
583
- permissions. However, no additional obligations are imposed on any
584
- author or copyright holder as a result of your choosing to follow a
585
- later version.
586
-
587
- 15. Disclaimer of Warranty.
588
-
589
- THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590
- APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591
- HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592
- OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593
- THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594
- PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595
- IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596
- ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597
-
598
- 16. Limitation of Liability.
599
-
600
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601
- WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602
- THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603
- GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604
- USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605
- DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606
- PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607
- EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608
- SUCH DAMAGES.
609
-
610
- 17. Interpretation of Sections 15 and 16.
611
-
612
- If the disclaimer of warranty and limitation of liability provided
613
- above cannot be given local legal effect according to their terms,
614
- reviewing courts shall apply local law that most closely approximates
615
- an absolute waiver of all civil liability in connection with the
616
- Program, unless a warranty or assumption of liability accompanies a
617
- copy of the Program in return for a fee.
618
-
619
- END OF TERMS AND CONDITIONS
620
-
621
- How to Apply These Terms to Your New Programs
622
-
623
- If you develop a new program, and you want it to be of the greatest
624
- possible use to the public, the best way to achieve this is to make it
625
- free software which everyone can redistribute and change under these terms.
626
-
627
- To do so, attach the following notices to the program. It is safest
628
- to attach them to the start of each source file to most effectively
629
- state the exclusion of warranty; and each file should have at least
630
- the "copyright" line and a pointer to where the full notice is found.
631
-
632
- <one line to give the program's name and a brief idea of what it does.>
633
- Copyright (C) <year> <name of author>
634
-
635
- This program is free software: you can redistribute it and/or modify
636
- it under the terms of the GNU Affero General Public License as published
637
- by the Free Software Foundation, either version 3 of the License, or
638
- (at your option) any later version.
639
-
640
- This program is distributed in the hope that it will be useful,
641
- but WITHOUT ANY WARRANTY; without even the implied warranty of
642
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643
- GNU Affero General Public License for more details.
644
-
645
- You should have received a copy of the GNU Affero General Public License
646
- along with this program. If not, see <https://www.gnu.org/licenses/>.
647
-
648
- Also add information on how to contact you by electronic and paper mail.
649
-
650
- If your software can interact with users remotely through a computer
651
- network, you should also make sure that it provides a way for users to
652
- get its source. For example, if your program is a web application, its
653
- interface could display a "Source" link that leads users to an archive
654
- of the code. There are many ways you could offer source, and different
655
- solutions will be better for different programs; see section 13 for the
656
- specific requirements.
657
-
658
- You should also get your employer (if you work as a programmer) or school,
659
- if any, to sign a "copyright disclaimer" for the program, if necessary.
660
- For more information on this, and how to apply and follow the GNU AGPL, see
661
- <https://www.gnu.org/licenses/>.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
README.md CHANGED
@@ -2,7 +2,7 @@
2
  title: sdui
3
  emoji: 🐢
4
  colorFrom: blue
5
- colorTo: red
6
  sdk: docker
7
  pinned: false
8
  duplicated_from: atikur-rabbi/sdui
@@ -10,258 +10,3 @@ duplicated_from: atikur-rabbi/sdui
10
 
11
  # Stable Diffusion in Docker
12
 
13
- Run the official [Stable Diffusion](https://huggingface.co/CompVis/stable-diffusion)
14
- releases on [Huggingface](https://huggingface.co/) in a GPU accelerated Docker
15
- container.
16
-
17
- ```sh
18
- ./build.sh run 'An impressionist painting of a parakeet eating spaghetti in the desert'
19
- ```
20
-
21
- ![An impressionist painting of a parakeet eating spaghetti in the desert 1](https://raw.githubusercontent.com/fboulnois/repository-assets/main/assets/stable-diffusion-docker/An_impressionist_painting_of_a_parakeet_eating_spaghetti_in_the_desert_s1.png)
22
- ![An impressionist painting of a parakeet eating spaghetti in the desert 2](https://raw.githubusercontent.com/fboulnois/repository-assets/main/assets/stable-diffusion-docker/An_impressionist_painting_of_a_parakeet_eating_spaghetti_in_the_desert_s2.png)
23
-
24
- ```sh
25
- ./build.sh run --image parakeet_eating_spaghetti.png --strength 0.6 'Bouquet of roses'
26
- ```
27
-
28
- ![Bouquet of roses 1](https://raw.githubusercontent.com/fboulnois/repository-assets/main/assets/stable-diffusion-docker/Bouquet_of_roses_s1.png)
29
- ![Bouquet of roses 2](https://raw.githubusercontent.com/fboulnois/repository-assets/main/assets/stable-diffusion-docker/Bouquet_of_roses_s2.png)
30
-
31
- ## Before you start
32
-
33
- ### Minimum requirements
34
-
35
- By default, the pipeline uses the full model and weights which requires a CUDA
36
- capable GPU with 8GB+ of VRAM. It should take a few seconds to create one image.
37
- On less powerful GPUs you may need to modify some of the options; see the
38
- [Examples](#examples) section for more details. If you lack a suitable GPU you
39
- can set the options `--device cpu` and `--onnx` instead.
40
-
41
- ### Huggingface token
42
-
43
- Since it uses the official model, you will need to create a [user access token](https://huggingface.co/docs/hub/security-tokens)
44
- in your [Huggingface account](https://huggingface.co/settings/tokens). Save the
45
- user access token in a file called `token.txt` and make sure it is available
46
- when building the container. The token content should begin with `hf_...`
47
-
48
- ## Quickstart
49
-
50
- The pipeline is managed using a single [`build.sh`](build.sh) script.
51
-
52
- Pull the latest version of `stable-diffusion-docker` using `./build.sh pull`.
53
- You will need to use the option `--token` to specify a valid [user access token](#huggingface-token)
54
- when using [`./build run`](#run).
55
-
56
- Alternately, build the image locally before running it.
57
-
58
- ## Build
59
-
60
- Make sure your [user access token](#huggingface-token) is saved in a file called
61
- `token.txt`.
62
-
63
- To build:
64
-
65
- ```sh
66
- ./build.sh build # or just ./build.sh
67
- ```
68
-
69
- ## Run
70
-
71
- ### Text-to-Image (`txt2img`)
72
-
73
- Create an image from a text prompt.
74
-
75
- To run:
76
-
77
- ```sh
78
- ./build.sh run 'Andromeda galaxy in a bottle'
79
- ```
80
-
81
- ### Image-to-Image (`img2img`)
82
-
83
- Create an image from an existing image and a text prompt.
84
-
85
- First, copy an image to the `input` folder. Next, to run:
86
-
87
- ```sh
88
- ./build.sh run --image image.png 'Andromeda galaxy in a bottle'
89
- ```
90
-
91
- ### Depth-Guided Diffusion (`depth2img`)
92
-
93
- Modify an existing image with its depth map and a text prompt.
94
-
95
- First, copy an image to the `input` folder. Next, to run:
96
-
97
- ```sh
98
- ./build.sh run --model 'stabilityai/stable-diffusion-2-depth' \
99
- --image image.png 'A detailed description of the objects to change'
100
- ```
101
-
102
- ### Instruct Pix2Pix (`pix2pix`)
103
-
104
- Modify an existing image with a text prompt.
105
-
106
- First, copy an image to the `input` folder. Next, to run:
107
-
108
- ```sh
109
- ./build.sh run --model 'timbrooks/instruct-pix2pix' \
110
- --image image.png 'A detailed description of the objects to change'
111
- ```
112
-
113
- ### Image Upscaling (`upscale4x`)
114
-
115
- Create a high resolution image from an existing image with a text prompt.
116
-
117
- First, copy an image to the `input` folder. Next, to run:
118
-
119
- ```sh
120
- ./build.sh run --model 'stabilityai/stable-diffusion-x4-upscaler' \
121
- --image image.png 'Andromeda galaxy in a bottle'
122
- ```
123
-
124
- ### Diffusion Inpainting (`inpaint`)
125
-
126
- Modify specific areas of an existing image with an image mask and a text prompt.
127
-
128
- First, copy an image and an image mask to the `input` folder. White areas of the
129
- mask will be diffused and black areas will be kept untouched. Next, to run:
130
-
131
- ```sh
132
- ./build.sh run --model 'runwayml/stable-diffusion-inpainting' \
133
- --image image.png --mask mask.png 'Andromeda galaxy in a bottle'
134
- ```
135
-
136
- ## Options
137
-
138
- The following are the most common options:
139
-
140
- * `--prompt [PROMPT]`: the prompt to render into an image
141
- * `--model [MODEL]`: the model used to render images (default is
142
- `CompVis/stable-diffusion-v1-4`)
143
- * `--height [HEIGHT]`: image height in pixels (default 512, must be divisible by 64)
144
- * `--width [WIDTH]`: image width in pixels (default 512, must be divisible by 64)
145
- * `--iters [ITERS]`: number of times to run pipeline (default 1)
146
- * `--samples [SAMPLES]`: number of images to create per run (default 1)
147
- * `--scale [SCALE]`: how closely the image should follow the prompt (default 7.5)
148
- * `--scheduler [SCHEDULER]`: override the scheduler used to denoise the image
149
- (default `None`)
150
- * `--seed [SEED]`: RNG seed for repeatability (default is a random seed)
151
- * `--steps [STEPS]`: number of sampling steps (default 50)
152
-
153
- Other options:
154
-
155
- * `--attention-slicing`: use less memory but decrease inference speed (default
156
- is no attention slicing)
157
- * `--device [DEVICE]`: the cpu or cuda device to use to render images (default
158
- `cuda`)
159
- * `--half`: use float16 tensors instead of float32 (default `float32`)
160
- * `--image [IMAGE]`: the input image to use for image-to-image diffusion
161
- (default `None`)
162
- * `--image-scale [IMAGE_SCALE]`: how closely the image should follow the
163
- original image (default `None`)
164
- * `--mask [MASK]`: the input mask to use for diffusion inpainting (default
165
- `None`)
166
- * `--negative-prompt [NEGATIVE_PROMPT]`: the prompt to not render into an image
167
- (default `None`)
168
- * `--onnx`: use the onnx runtime for inference (default is off)
169
- * `--skip`: skip safety checker (default is the safety checker is on)
170
- * `--strength [STRENGTH]`: diffusion strength to apply to the input image
171
- (default 0.75)
172
- * `--token [TOKEN]`: specify a Huggingface user access token at the command line
173
- instead of reading it from a file (default is a file)
174
- * `--vae-tiling`: use less memory when generating ultra-high resolution images
175
- but massively decrease inference speed (default is no tiling)
176
- * `--xformers-memory-efficient-attention`: use less memory but require the
177
- xformers library (default is that xformers is not required)
178
-
179
- Some of the original `txt2img.py` options [have been renamed](https://github.com/fboulnois/stable-diffusion-docker/issues/49)
180
- for easy-of-use and compatibility with other pipelines:
181
-
182
- | txt2img | stable-diffusion-docker |
183
- |---------|-------------------------|
184
- | `--H` | `--height` |
185
- | `--W` | `--width` |
186
- | `--n_iter` | `--iters` |
187
- | `--n_samples` | `--samples` |
188
- | `--ddim_steps` | `--steps` |
189
-
190
- ## Examples
191
-
192
- These commands are both identical:
193
-
194
- ```sh
195
- ./build.sh run 'abstract art'
196
- ./build.sh run --prompt 'abstract art'
197
- ```
198
-
199
- Set the seed to 42:
200
-
201
- ```sh
202
- ./build.sh run --seed 42 'abstract art'
203
- ```
204
-
205
- Options can be combined:
206
-
207
- ```sh
208
- ./build.sh run --scale 7.0 --seed 42 'abstract art'
209
- ```
210
-
211
- Many popular models are supported out-of-the-box:
212
-
213
- | Model Name | Option using `--model` |
214
- |------------|------------------------|
215
- | [Stable Diffusion 1.4](https://huggingface.co/CompVis/stable-diffusion-v1-4) | `'CompVis/stable-diffusion-v1-4'` |
216
- | [Stable Diffusion 1.5](https://huggingface.co/runwayml/stable-diffusion-v1-5) | `'runwayml/stable-diffusion-v1-5'` |
217
- | [Stable Diffusion 2.0](https://huggingface.co/stabilityai/stable-diffusion-2) | `'stabilityai/stable-diffusion-2'` |
218
- | [Stable Diffusion 2.1](https://huggingface.co/stabilityai/stable-diffusion-2-1) | `'stabilityai/stable-diffusion-2-1'` |
219
- | [OpenJourney 1.0](https://huggingface.co/prompthero/openjourney) | `'prompthero/openjourney'` |
220
- | [Dreamlike Diffusion 1.0](https://huggingface.co/dreamlike-art/dreamlike-diffusion-1.0) | `'dreamlike-art/dreamlike-diffusion-1.0'` |
221
- | [and more!](https://huggingface.co/models?other=stable-diffusion&sort=likes) | ... |
222
-
223
- ```sh
224
- ./build.sh run --model 'prompthero/openjourney' --prompt 'abstract art'
225
- ```
226
-
227
- On systems without enough GPU VRAM, you can try mixing and matching options:
228
-
229
- * Give Docker Desktop more resources by increasing the CPU, memory, and swap in
230
- the Settings -> Resources section if the container is terminated
231
- * Make images smaller than 512x512 using `--height` and `--width` to decrease
232
- memory use and increase image creation speed
233
- * Use `--half` to decrease memory use but slightly decrease image quality
234
- * Use `--attention-slicing` to decrease memory use but also decrease image
235
- creation speed
236
- * Use `--xformers-memory-efficient-attention` to decrease memory use if the
237
- pipeline and the hardware supports the option
238
- * Decrease the number of samples and increase the number of iterations with
239
- `--samples` and `--iters` to decrease overall memory use
240
- * Skip the safety checker with `--skip` to run less code
241
-
242
- ```sh
243
- ./build.sh run --height 256 --width 256 --half \
244
- --attention-slicing --xformers-memory-efficient-attention \
245
- --samples 1 --iters 1 --skip --prompt 'abstract art'
246
- ```
247
-
248
- On Windows, if you aren't using WSL2 and instead use MSYS, MinGW, or Git Bash,
249
- prefix your commands with `MSYS_NO_PATHCONV=1` (or export it beforehand):
250
-
251
- ```sh
252
- MSYS_NO_PATHCONV=1 ./build.sh run --half --prompt 'abstract art'
253
- ```
254
-
255
- ## Outputs
256
-
257
- ### Model
258
-
259
- The model and other files are cached in a volume called `huggingface`. The
260
- models are stored in `<volume>/diffusers/<model>/snapshots/<githash>/unet/<weights>`.
261
- Checkpoint files (`ckpt`s) are unofficial versions of the official models, and
262
- so these are not part of the official release.
263
-
264
- ### Images
265
-
266
- The images are saved as PNGs in the `output` folder using the prompt text. The
267
- `build.sh` script creates and mounts this folder as a volume in the container.
 
2
  title: sdui
3
  emoji: 🐢
4
  colorFrom: blue
5
+ colorTo: green
6
  sdk: docker
7
  pinned: false
8
  duplicated_from: atikur-rabbi/sdui
 
10
 
11
  # Stable Diffusion in Docker
12
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
requirements.txt DELETED
@@ -1,6 +0,0 @@
1
- diffusers[torch]==0.14.0
2
- onnxruntime==1.14.1
3
- safetensors==0.3.0
4
- torch==1.13.1+cu117
5
- transformers==4.26.1
6
- xformers==0.0.16