scribbyotx
commited on
Commit
•
6d7c565
1
Parent(s):
a2db556
Upload 5 files
Browse files- LICENSE +201 -0
- README.md +67 -163
- config.json +7 -55
- requirements.txt +6 -0
- scrape.py +97 -0
LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
Apache License
|
2 |
+
Version 2.0, January 2004
|
3 |
+
http://www.apache.org/licenses/
|
4 |
+
|
5 |
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6 |
+
|
7 |
+
1. Definitions.
|
8 |
+
|
9 |
+
"License" shall mean the terms and conditions for use, reproduction,
|
10 |
+
and distribution as defined by Sections 1 through 9 of this document.
|
11 |
+
|
12 |
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13 |
+
the copyright owner that is granting the License.
|
14 |
+
|
15 |
+
"Legal Entity" shall mean the union of the acting entity and all
|
16 |
+
other entities that control, are controlled by, or are under common
|
17 |
+
control with that entity. For the purposes of this definition,
|
18 |
+
"control" means (i) the power, direct or indirect, to cause the
|
19 |
+
direction or management of such entity, whether by contract or
|
20 |
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21 |
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22 |
+
|
23 |
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24 |
+
exercising permissions granted by this License.
|
25 |
+
|
26 |
+
"Source" form shall mean the preferred form for making modifications,
|
27 |
+
including but not limited to software source code, documentation
|
28 |
+
source, and configuration files.
|
29 |
+
|
30 |
+
"Object" form shall mean any form resulting from mechanical
|
31 |
+
transformation or translation of a Source form, including but
|
32 |
+
not limited to compiled object code, generated documentation,
|
33 |
+
and conversions to other media types.
|
34 |
+
|
35 |
+
"Work" shall mean the work of authorship, whether in Source or
|
36 |
+
Object form, made available under the License, as indicated by a
|
37 |
+
copyright notice that is included in or attached to the work
|
38 |
+
(an example is provided in the Appendix below).
|
39 |
+
|
40 |
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41 |
+
form, that is based on (or derived from) the Work and for which the
|
42 |
+
editorial revisions, annotations, elaborations, or other modifications
|
43 |
+
represent, as a whole, an original work of authorship. For the purposes
|
44 |
+
of this License, Derivative Works shall not include works that remain
|
45 |
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46 |
+
the Work and Derivative Works thereof.
|
47 |
+
|
48 |
+
"Contribution" shall mean any work of authorship, including
|
49 |
+
the original version of the Work and any modifications or additions
|
50 |
+
to that Work or Derivative Works thereof, that is intentionally
|
51 |
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52 |
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53 |
+
the copyright owner. For the purposes of this definition, "submitted"
|
54 |
+
means any form of electronic, verbal, or written communication sent
|
55 |
+
to the Licensor or its representatives, including but not limited to
|
56 |
+
communication on electronic mailing lists, source code control systems,
|
57 |
+
and issue tracking systems that are managed by, or on behalf of, the
|
58 |
+
Licensor for the purpose of discussing and improving the Work, but
|
59 |
+
excluding communication that is conspicuously marked or otherwise
|
60 |
+
designated in writing by the copyright owner as "Not a Contribution."
|
61 |
+
|
62 |
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63 |
+
on behalf of whom a Contribution has been received by Licensor and
|
64 |
+
subsequently incorporated within the Work.
|
65 |
+
|
66 |
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67 |
+
this License, each Contributor hereby grants to You a perpetual,
|
68 |
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69 |
+
copyright license to reproduce, prepare Derivative Works of,
|
70 |
+
publicly display, publicly perform, sublicense, and distribute the
|
71 |
+
Work and such Derivative Works in Source or Object form.
|
72 |
+
|
73 |
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74 |
+
this License, each Contributor hereby grants to You a perpetual,
|
75 |
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76 |
+
(except as stated in this section) patent license to make, have made,
|
77 |
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78 |
+
where such license applies only to those patent claims licensable
|
79 |
+
by such Contributor that are necessarily infringed by their
|
80 |
+
Contribution(s) alone or by combination of their Contribution(s)
|
81 |
+
with the Work to which such Contribution(s) was submitted. If You
|
82 |
+
institute patent litigation against any entity (including a
|
83 |
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84 |
+
or a Contribution incorporated within the Work constitutes direct
|
85 |
+
or contributory patent infringement, then any patent licenses
|
86 |
+
granted to You under this License for that Work shall terminate
|
87 |
+
as of the date such litigation is filed.
|
88 |
+
|
89 |
+
4. Redistribution. You may reproduce and distribute copies of the
|
90 |
+
Work or Derivative Works thereof in any medium, with or without
|
91 |
+
modifications, and in Source or Object form, provided that You
|
92 |
+
meet the following conditions:
|
93 |
+
|
94 |
+
(a) You must give any other recipients of the Work or
|
95 |
+
Derivative Works a copy of this License; and
|
96 |
+
|
97 |
+
(b) You must cause any modified files to carry prominent notices
|
98 |
+
stating that You changed the files; and
|
99 |
+
|
100 |
+
(c) You must retain, in the Source form of any Derivative Works
|
101 |
+
that You distribute, all copyright, patent, trademark, and
|
102 |
+
attribution notices from the Source form of the Work,
|
103 |
+
excluding those notices that do not pertain to any part of
|
104 |
+
the Derivative Works; and
|
105 |
+
|
106 |
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107 |
+
distribution, then any Derivative Works that You distribute must
|
108 |
+
include a readable copy of the attribution notices contained
|
109 |
+
within such NOTICE file, excluding those notices that do not
|
110 |
+
pertain to any part of the Derivative Works, in at least one
|
111 |
+
of the following places: within a NOTICE text file distributed
|
112 |
+
as part of the Derivative Works; within the Source form or
|
113 |
+
documentation, if provided along with the Derivative Works; or,
|
114 |
+
within a display generated by the Derivative Works, if and
|
115 |
+
wherever such third-party notices normally appear. The contents
|
116 |
+
of the NOTICE file are for informational purposes only and
|
117 |
+
do not modify the License. You may add Your own attribution
|
118 |
+
notices within Derivative Works that You distribute, alongside
|
119 |
+
or as an addendum to the NOTICE text from the Work, provided
|
120 |
+
that such additional attribution notices cannot be construed
|
121 |
+
as modifying the License.
|
122 |
+
|
123 |
+
You may add Your own copyright statement to Your modifications and
|
124 |
+
may provide additional or different license terms and conditions
|
125 |
+
for use, reproduction, or distribution of Your modifications, or
|
126 |
+
for any such Derivative Works as a whole, provided Your use,
|
127 |
+
reproduction, and distribution of the Work otherwise complies with
|
128 |
+
the conditions stated in this License.
|
129 |
+
|
130 |
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131 |
+
any Contribution intentionally submitted for inclusion in the Work
|
132 |
+
by You to the Licensor shall be under the terms and conditions of
|
133 |
+
this License, without any additional terms or conditions.
|
134 |
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135 |
+
the terms of any separate license agreement you may have executed
|
136 |
+
with Licensor regarding such Contributions.
|
137 |
+
|
138 |
+
6. Trademarks. This License does not grant permission to use the trade
|
139 |
+
names, trademarks, service marks, or product names of the Licensor,
|
140 |
+
except as required for reasonable and customary use in describing the
|
141 |
+
origin of the Work and reproducing the content of the NOTICE file.
|
142 |
+
|
143 |
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144 |
+
agreed to in writing, Licensor provides the Work (and each
|
145 |
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146 |
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147 |
+
implied, including, without limitation, any warranties or conditions
|
148 |
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149 |
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150 |
+
appropriateness of using or redistributing the Work and assume any
|
151 |
+
risks associated with Your exercise of permissions under this License.
|
152 |
+
|
153 |
+
8. Limitation of Liability. In no event and under no legal theory,
|
154 |
+
whether in tort (including negligence), contract, or otherwise,
|
155 |
+
unless required by applicable law (such as deliberate and grossly
|
156 |
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157 |
+
liable to You for damages, including any direct, indirect, special,
|
158 |
+
incidental, or consequential damages of any character arising as a
|
159 |
+
result of this License or out of the use or inability to use the
|
160 |
+
Work (including but not limited to damages for loss of goodwill,
|
161 |
+
work stoppage, computer failure or malfunction, or any and all
|
162 |
+
other commercial damages or losses), even if such Contributor
|
163 |
+
has been advised of the possibility of such damages.
|
164 |
+
|
165 |
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166 |
+
the Work or Derivative Works thereof, You may choose to offer,
|
167 |
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168 |
+
or other liability obligations and/or rights consistent with this
|
169 |
+
License. However, in accepting such obligations, You may act only
|
170 |
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171 |
+
of any other Contributor, and only if You agree to indemnify,
|
172 |
+
defend, and hold each Contributor harmless for any liability
|
173 |
+
incurred by, or claims asserted against, such Contributor by reason
|
174 |
+
of your accepting any such warranty or additional liability.
|
175 |
+
|
176 |
+
END OF TERMS AND CONDITIONS
|
177 |
+
|
178 |
+
APPENDIX: How to apply the Apache License to your work.
|
179 |
+
|
180 |
+
To apply the Apache License to your work, attach the following
|
181 |
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182 |
+
replaced with your own identifying information. (Don't include
|
183 |
+
the brackets!) The text should be enclosed in the appropriate
|
184 |
+
comment syntax for the file format. We also recommend that a
|
185 |
+
file or class name and description of purpose be included on the
|
186 |
+
same "printed page" as the copyright notice for easier
|
187 |
+
identification within third-party archives.
|
188 |
+
|
189 |
+
Copyright [yyyy] [name of copyright owner]
|
190 |
+
|
191 |
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192 |
+
you may not use this file except in compliance with the License.
|
193 |
+
You may obtain a copy of the License at
|
194 |
+
|
195 |
+
http://www.apache.org/licenses/LICENSE-2.0
|
196 |
+
|
197 |
+
Unless required by applicable law or agreed to in writing, software
|
198 |
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199 |
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200 |
+
See the License for the specific language governing permissions and
|
201 |
+
limitations under the License.
|
README.md
CHANGED
@@ -1,170 +1,74 @@
|
|
1 |
-
|
2 |
-
license: openrail++
|
3 |
-
tags:
|
4 |
-
- art
|
5 |
-
- stable diffusion
|
6 |
-
- ControlNet
|
7 |
-
- SDXL
|
8 |
-
- Diffusion-XL
|
9 |
-
pipeline_tag: text-to-image
|
10 |
-
---
|
11 |
-
# MistoLine
|
12 |
-
## Control Every Line!
|
13 |
-
|
14 |
-
![Intro Image](assets/intro.png)
|
15 |
-
[GitHub Repo](https://github.com/TheMistoAI/MistoLine)
|
16 |
-
|
17 |
-
## NEWS!!!!! Anyline-preprocessor is released!!!!
|
18 |
-
[Anyline Repo](https://github.com/TheMistoAI/ComfyUI-Anyline)
|
19 |
-
|
20 |
-
**MistoLine: A Versatile and Robust SDXL-ControlNet Model for Adaptable Line Art Conditioning.**
|
21 |
-
|
22 |
-
MistoLine is an SDXL-ControlNet model that can adapt to any type of line art input, demonstrating high accuracy and excellent stability. It can generate high-quality images (with a short side greater than 1024px) based on user-provided line art of various types, including hand-drawn sketches, different ControlNet line preprocessors, and model-generated outlines. MistoLine eliminates the need to select different ControlNet models for different line preprocessors, as it exhibits strong generalization capabilities across diverse line art conditions.
|
23 |
-
|
24 |
-
We developed MistoLine by employing a novel line preprocessing algorithm **[Anyline](https://github.com/TheMistoAI/ComfyUI-Anyline)** and retraining the ControlNet model based on the Unet of stabilityai/ stable-diffusion-xl-base-1.0, along with innovations in large model training engineering. MistoLine showcases superior performance across
|
25 |
-
different types of line art inputs, surpassing existing ControlNet models in terms of detail restoration, prompt alignment, and stability, particularly in more complex scenarios.
|
26 |
-
|
27 |
-
MistoLine maintains consistency with the ControlNet architecture released by @lllyasviel, as illustrated in the following schematic diagram:
|
28 |
-
![ControlNet architecture](assets/controlnet_1.png)
|
29 |
-
![ControlNet architecture](assets/controlnet_2.png)
|
30 |
-
*reference:https://github.com/lllyasviel/ControlNet*
|
31 |
-
|
32 |
-
More information about ControlNet can be found in the following references:
|
33 |
-
https://github.com/lllyasviel/ControlNet
|
34 |
-
https://huggingface.co/docs/diffusers/main/en/api/pipelines/controlnet_sdxl
|
35 |
-
|
36 |
-
The model is compatible with most SDXL models, except for PlaygroundV2.5, CosXL, and SDXL-Lightning(maybe). It can be used in conjunction with LCM and other ControlNet models.
|
37 |
-
|
38 |
-
The following usage of this model is not allowed:
|
39 |
-
* Violating laws and regulations
|
40 |
-
* Harming or exploiting minors
|
41 |
-
* Creating and spreading false information
|
42 |
-
* Infringing on others' privacy
|
43 |
-
* Defaming or harassing others
|
44 |
-
* Automated decision-making that harms others' legal rights
|
45 |
-
* Discrimination based on social behavior or personal characteristics
|
46 |
-
* Exploiting the vulnerabilities of specific groups to mislead their behavior
|
47 |
-
* Discrimination based on legally protected characteristics
|
48 |
-
* Providing medical advice and diagnostic results
|
49 |
-
* Improperly generating and using information for purposes such as law enforcement and immigration
|
50 |
-
|
51 |
-
If you use or distribute this model for commercial purposes, you must comply with the following conditions:
|
52 |
-
1. Clearly acknowledge the contribution of TheMisto.ai to this model in the documentation, website, or other prominent and visible locations of your product.
|
53 |
-
Example: "This product uses the MistoLine-SDXL-ControlNet developed by TheMisto.ai."
|
54 |
-
2. If your product includes about screens, readme files, or other similar display areas, you must include the above attribution information in those areas.
|
55 |
-
3. If your product does not have the aforementioned areas, you must include the attribution information in other reasonable locations within the product to ensure that end-users can notice it.
|
56 |
-
4. You must not imply in any way that TheMisto.ai endorses or promotes your product. The use of the attribution information is solely to indicate the origin of this model.
|
57 |
-
If you have any questions about how to provide attribution in specific cases, please contact info@themisto.ai.
|
58 |
-
|
59 |
-
署名条款
|
60 |
-
如果您在商业用途中使用或分发本模型,您必须满足以下条件:
|
61 |
-
1. 在产品的文档,网站,或其他主要可见位置,明确提及 TheMisto.ai 对本软件的贡献。
|
62 |
-
示例: "本产品使用了 TheMisto.ai 开发的 MistoLine-SDXL-ControlNet。"
|
63 |
-
2. 如果您的产品包含有关屏幕,说明文件,或其他类似的显示区域,您必须在这些区域中包含上述署名信息。
|
64 |
-
3. 如果您的产品没有上述区域,您必须在产品的其他合理位置包含署名信息,以确保最终用户能够注意到。
|
65 |
-
4. 您不得以任何方式暗示 TheMisto.ai 为您的产品背书或促销。署名信息的使用仅用于表明本模型的来源。
|
66 |
-
如果您对如何在特定情况下提供署名有任何疑问,请联系info@themisto.ai。
|
67 |
-
|
68 |
-
The model output is not censored and the authors do not endorse the opinions in the generated content. Use at your own risk.
|
69 |
-
|
70 |
-
## Apply with Different Line Preprocessors
|
71 |
-
![preprocessors](assets/preprocessors.png)
|
72 |
-
|
73 |
-
## Compere with Other Controlnets
|
74 |
-
![comparison](assets/comparison.png)
|
75 |
-
|
76 |
-
## Application Examples
|
77 |
-
|
78 |
-
### Sketch Rendering
|
79 |
-
*The following case only utilized MistoLine as the controlnet:*
|
80 |
-
![Sketch Rendering](assets/sketch_rendering.png)
|
81 |
-
|
82 |
-
### Model Rendering
|
83 |
-
*The following case only utilized Anyline as the preprocessor and MistoLine as the controlnet.*
|
84 |
-
![Model Rendering](assets/model_rendering.png)
|
85 |
-
|
86 |
-
## ComfyUI Recommended Parameters
|
87 |
-
```
|
88 |
-
sampler steps:30
|
89 |
-
CFG:7.0
|
90 |
-
sampler_name:dpmpp_2m_sde
|
91 |
-
scheduler:karras
|
92 |
-
denoise:0.93
|
93 |
-
controlnet_strength:1.0
|
94 |
-
stargt_percent:0.0
|
95 |
-
end_percent:0.9
|
96 |
-
```
|
97 |
-
## Diffusers pipeline
|
98 |
-
Make sure to first install the libraries:
|
99 |
-
```
|
100 |
-
pip install accelerate transformers safetensors opencv-python diffusers
|
101 |
-
```
|
102 |
-
And then we're ready to go:
|
103 |
-
```
|
104 |
-
from diffusers import ControlNetModel, StableDiffusionXLControlNetPipeline, AutoencoderKL
|
105 |
-
from diffusers.utils import load_image
|
106 |
-
from PIL import Image
|
107 |
-
import torch
|
108 |
-
import numpy as np
|
109 |
-
import cv2
|
110 |
-
|
111 |
-
prompt = "aerial view, a futuristic research complex in a bright foggy jungle, hard lighting"
|
112 |
-
negative_prompt = 'low quality, bad quality, sketches'
|
113 |
-
|
114 |
-
image = load_image("https://huggingface.co/datasets/hf-internal-testing/diffusers-images/resolve/main/sd_controlnet/hf-logo.png")
|
115 |
-
|
116 |
-
controlnet_conditioning_scale = 0.5
|
117 |
-
|
118 |
-
controlnet = ControlNetModel.from_pretrained(
|
119 |
-
"TheMistoAI/MistoLine",
|
120 |
-
torch_dtype=torch.float16,
|
121 |
-
variant="fp16",
|
122 |
-
)
|
123 |
-
vae = AutoencoderKL.from_pretrained("madebyollin/sdxl-vae-fp16-fix", torch_dtype=torch.float16)
|
124 |
-
pipe = StableDiffusionXLControlNetPipeline.from_pretrained(
|
125 |
-
"stabilityai/stable-diffusion-xl-base-1.0",
|
126 |
-
controlnet=controlnet,
|
127 |
-
vae=vae,
|
128 |
-
torch_dtype=torch.float16,
|
129 |
-
)
|
130 |
-
pipe.enable_model_cpu_offload()
|
131 |
-
|
132 |
-
image = np.array(image)
|
133 |
-
image = cv2.Canny(image, 100, 200)
|
134 |
-
image = image[:, :, None]
|
135 |
-
image = np.concatenate([image, image, image], axis=2)
|
136 |
-
image = Image.fromarray(image)
|
137 |
-
|
138 |
-
images = pipe(
|
139 |
-
prompt, negative_prompt=negative_prompt, image=image, controlnet_conditioning_scale=controlnet_conditioning_scale,
|
140 |
-
).images
|
141 |
-
|
142 |
-
images[0].save(f"hug_lab.png")
|
143 |
-
```
|
144 |
|
|
|
145 |
|
146 |
-
##
|
147 |
-
* mistoLine_rank256.safetensors : General usage version, for ComfyUI and AUTOMATIC1111-WebUI.
|
148 |
-
* mistoLine_fp16.safetensors : FP16 weights, for ComfyUI and AUTOMATIC1111-WebUI.
|
149 |
|
150 |
-
|
151 |
-
## !!!mistoLine_rank256.safetensors 表现更加出色!!
|
152 |
|
153 |
-
|
154 |
-
|
|
|
|
|
|
|
|
|
|
|
155 |
|
156 |
-
## 中国(大陆地区)便捷下载地址:
|
157 |
-
链接:https://pan.baidu.com/s/1DbZWmGJ40Uzr3Iz9RNBG_w?pwd=8mzs
|
158 |
-
提取码:8mzs
|
159 |
|
160 |
-
|
161 |
-
|
162 |
-
|
163 |
-
|
164 |
-
|
165 |
-
|
166 |
-
|
167 |
-
|
168 |
-
|
169 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
170 |
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Discord-Scraper
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2 |
|
3 |
+
Pipeline to scrape prompt + image url pairs from Discord channels. The idea started by wanting to scrape the image-prompt pairs from [share-dalle-3](https://discord.com/channels/823813159592001537/1158354590463447092) Discord channel from [LAION server](https://discord.com/invite/eq3cAMZtCC). But now you can re-use the scraper to work with any channel you want.
|
4 |
|
5 |
+
## How to use
|
|
|
|
|
6 |
|
7 |
+
Clone the repo `git clone https://github.com/LAION-AI/Discord-Scrapers.git`
|
|
|
8 |
|
9 |
+
1. Set up a virtual environment and install the requirements with `pip install -r requirements.txt`
|
10 |
+
2. Get your `DISCORD_TOKEN` and `HF_TOKEN` and add as environment variables.
|
11 |
+
1. `DISCORD_TOKEN` can be obtained by looking at developer tools in your Web Browser
|
12 |
+
2. `HF_TOKEN` can be obtained by logging in to HuggingFace and looking at your profile
|
13 |
+
3. Get the `channel_id` from the Discord channel you want to scrape. You can do this by enabling developer mode in Discord and right clicking the channel you want to scrape.
|
14 |
+
4. Create a `condition_fn` and a `parse_fn` that will be used to filter and parse the messages. You can use the ones I created as an example.
|
15 |
+
5. Create your scraping script and optionally your `config.json`
|
16 |
|
|
|
|
|
|
|
17 |
|
18 |
+
**NOTE PAY ATTENTION TO THE FUNC SIGNATURE OF parse_fn and condition_fn**
|
19 |
+
|
20 |
+
```python
|
21 |
+
import os
|
22 |
+
from typing import Any, Dict, List
|
23 |
+
|
24 |
+
from scraper import ScraperBot, ScraperBotConfig, HFDatasetScheme
|
25 |
+
|
26 |
+
def parse_fn(message: Dict[str, Any]) -> List[HFDatasetScheme]:
|
27 |
+
...
|
28 |
+
|
29 |
+
def condition_fn(message: Dict[str, Any]) -> bool:
|
30 |
+
...
|
31 |
+
|
32 |
+
if __name__ == "__main__":
|
33 |
+
config_path = os.path.join(os.path.dirname(__file__), "config.json")
|
34 |
+
config = ScraperBotConfig.from_json(config_path)
|
35 |
+
|
36 |
+
bot = ScraperBot(config=config, parse_fn=parse_fn, condition_fn=condition_fn)
|
37 |
+
bot.scrape(fetch_all=False, push_to_hub=False)
|
38 |
```
|
39 |
+
|
40 |
+
|
41 |
+
## Main Components
|
42 |
+
|
43 |
+
### ScraperBotConfig
|
44 |
+
|
45 |
+
Dataclass with configuration attributes to be used by the ScraperBot. You can create your own config.json file and load it with `ScraperBotConfig.from_json(path_to_config)`.
|
46 |
+
|
47 |
+
attributes:
|
48 |
+
- base_url: str, The base url of the Discord API (in chase it changes)
|
49 |
+
- channel_id: str, The id of the channel you want to scrape
|
50 |
+
- limit: int, The number of messages to fetch (from my tests the max allowed by Discord is 100)
|
51 |
+
- hf_dataset_name: str, The name of the dataset you want to push to HuggingFace
|
52 |
+
|
53 |
+
### ScraperBot
|
54 |
+
|
55 |
+
Implementation of the scraper. Get's the messages from the Discord API and filters them using the `condition_fn`. Then parses the messages using the `parse_fn` and pushes the dataset to HuggingFace.
|
56 |
+
|
57 |
+
attributes:
|
58 |
+
- config: ScraperBotConfig, The configuration to be used by the bot
|
59 |
+
- parse_fn: Callable[[Dict[str, Any]], List[HFDatasetScheme]], The function to parse the messages
|
60 |
+
- condition_fn: Callable[[Dict[str, Any]], bool], The function to filter the messages
|
61 |
+
|
62 |
+
methods:
|
63 |
+
|
64 |
+
#### scrape(fetch_all: bool = False, push_to_hub: bool = False) -> Dataset
|
65 |
+
|
66 |
+
Scrapes the messages and optionally pushes the dataset to HuggingFace.
|
67 |
+
|
68 |
+
args:
|
69 |
+
- fetch_all: bool, If True will fetch all the messages from the channel. If False will fetch only the messages that weren't processed yet.
|
70 |
+
- push_to_hub: bool, If True will push the dataset to HuggingFace. If False will only return the dataset.
|
71 |
+
|
72 |
+
**NOTE: If you want to push the dataset to HuggingFace you need to set the `HF_TOKEN` environment variable.**
|
73 |
+
**NOTE 2: If the dataset doesn't exist in HuggingFace it will be created. If it already exists it will be updated.**
|
74 |
+
|
config.json
CHANGED
@@ -1,57 +1,9 @@
|
|
1 |
{
|
2 |
-
|
3 |
-
|
4 |
-
|
5 |
-
|
6 |
-
|
7 |
-
|
8 |
-
|
9 |
-
5,
|
10 |
-
10,
|
11 |
-
20
|
12 |
-
],
|
13 |
-
"block_out_channels": [
|
14 |
-
320,
|
15 |
-
640,
|
16 |
-
1280
|
17 |
-
],
|
18 |
-
"class_embed_type": null,
|
19 |
-
"conditioning_channels": 3,
|
20 |
-
"conditioning_embedding_out_channels": [
|
21 |
-
16,
|
22 |
-
32,
|
23 |
-
96,
|
24 |
-
256
|
25 |
-
],
|
26 |
-
"controlnet_conditioning_channel_order": "rgb",
|
27 |
-
"cross_attention_dim": 2048,
|
28 |
-
"down_block_types": [
|
29 |
-
"DownBlock2D",
|
30 |
-
"CrossAttnDownBlock2D",
|
31 |
-
"CrossAttnDownBlock2D"
|
32 |
-
],
|
33 |
-
"downsample_padding": 1,
|
34 |
-
"encoder_hid_dim": null,
|
35 |
-
"encoder_hid_dim_type": null,
|
36 |
-
"flip_sin_to_cos": true,
|
37 |
-
"freq_shift": 0,
|
38 |
-
"global_pool_conditions": false,
|
39 |
-
"in_channels": 4,
|
40 |
-
"layers_per_block": 2,
|
41 |
-
"mid_block_scale_factor": 1,
|
42 |
-
"mid_block_type": "UNetMidBlock2DCrossAttn",
|
43 |
-
"norm_eps": 1e-05,
|
44 |
-
"norm_num_groups": 32,
|
45 |
-
"num_attention_heads": null,
|
46 |
-
"num_class_embeds": null,
|
47 |
-
"only_cross_attention": false,
|
48 |
-
"projection_class_embeddings_input_dim": 2816,
|
49 |
-
"resnet_time_scale_shift": "default",
|
50 |
-
"transformer_layers_per_block": [
|
51 |
-
1,
|
52 |
-
2,
|
53 |
-
10
|
54 |
-
],
|
55 |
-
"upcast_attention": false,
|
56 |
-
"use_linear_projection": true
|
57 |
}
|
|
|
1 |
{
|
2 |
+
"base_url": "https://discord.com/api/v9",
|
3 |
+
"channel_id": "1159217496390389801",
|
4 |
+
"limit": 100,
|
5 |
+
"max_chunk_size": 300,
|
6 |
+
"embed_data": false,
|
7 |
+
"data_key": "image",
|
8 |
+
"hf_dataset_name": "laion/gpt4v-dataset"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
9 |
}
|
requirements.txt
ADDED
@@ -0,0 +1,6 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
requests==2.31.0
|
2 |
+
git+https://github.com/ZachNagengast/datasets.git@a6bd7b4a268dbda6b86d4ca59f5d2a78848b0199
|
3 |
+
Pillow==10.0.1
|
4 |
+
huggingface_hub>=0.18
|
5 |
+
numpy
|
6 |
+
fsspec==2023.9.2
|
scrape.py
ADDED
@@ -0,0 +1,97 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
import io
|
2 |
+
import os
|
3 |
+
import re
|
4 |
+
import pandas as pd
|
5 |
+
from typing import Any, Dict, List
|
6 |
+
import requests
|
7 |
+
from PIL import Image as PILImage
|
8 |
+
from scraper import ScraperBot, ScraperBotConfig
|
9 |
+
from helpers import starts_with_quotes, get_start_end_quotes
|
10 |
+
from dataclasses import dataclass
|
11 |
+
from datasets import Image
|
12 |
+
|
13 |
+
|
14 |
+
@dataclass(frozen=True)
|
15 |
+
class HFDatasetScheme:
|
16 |
+
caption: str
|
17 |
+
image: Image(decode=True)
|
18 |
+
link: str
|
19 |
+
message_id: str
|
20 |
+
timestamp: str
|
21 |
+
|
22 |
+
|
23 |
+
url_pattern = re.compile(r'https?://\S+')
|
24 |
+
|
25 |
+
|
26 |
+
def parse_fn(message: Dict[str, Any]) -> List[HFDatasetScheme]:
|
27 |
+
"""Parses a message into a list of Hugging Face Dataset Schemes.
|
28 |
+
|
29 |
+
Parameters
|
30 |
+
----------
|
31 |
+
message : Dict[str, Any]
|
32 |
+
The message to parse.
|
33 |
+
|
34 |
+
Returns
|
35 |
+
-------
|
36 |
+
List[HFDatasetScheme]
|
37 |
+
A list of Hugging Face Dataset Schemes.
|
38 |
+
"""
|
39 |
+
content = message["content"]
|
40 |
+
|
41 |
+
(first_quote_index, last_quote_index) = get_start_end_quotes(content)
|
42 |
+
|
43 |
+
# Extract the text between the first and last quotes to get the complete prompt
|
44 |
+
prompt = content[first_quote_index + 1:last_quote_index].strip()
|
45 |
+
image_urls = url_pattern.findall(content)
|
46 |
+
timestamp = message["timestamp"]
|
47 |
+
message_id = message["id"]
|
48 |
+
|
49 |
+
return [HFDatasetScheme(caption=prompt, image=None, link=image_url, message_id=message_id, timestamp=timestamp)
|
50 |
+
for image_url in image_urls]
|
51 |
+
|
52 |
+
|
53 |
+
def condition_fn(message: Dict[str, Any]) -> bool:
|
54 |
+
"""Checks if a message meets the condition to be parsed.
|
55 |
+
|
56 |
+
Parameters
|
57 |
+
----------
|
58 |
+
message : Dict[str, Any]
|
59 |
+
The message to check.
|
60 |
+
|
61 |
+
Returns
|
62 |
+
-------
|
63 |
+
bool
|
64 |
+
True if the message meets the condition, False otherwise.
|
65 |
+
"""
|
66 |
+
return url_pattern.search(message["content"]) and starts_with_quotes(message["content"])
|
67 |
+
|
68 |
+
|
69 |
+
def prepare_dataset(messages: List[HFDatasetScheme]) -> pd.DataFrame:
|
70 |
+
return pd.DataFrame(
|
71 |
+
{
|
72 |
+
"caption": [msg.caption for msg in messages],
|
73 |
+
"image": [
|
74 |
+
None for msg in messages
|
75 |
+
], # Initialize to None, will be filled in later
|
76 |
+
"link": [
|
77 |
+
msg.link for msg in messages
|
78 |
+
], # will maintain just because we use it to filter
|
79 |
+
"message_id": [msg.message_id for msg in messages],
|
80 |
+
"timestamp": [msg.timestamp for msg in messages],
|
81 |
+
}
|
82 |
+
)
|
83 |
+
|
84 |
+
|
85 |
+
def get_image(link: str) -> bytes:
|
86 |
+
image = PILImage.open(requests.get(link, stream=True).raw).convert("RGB")
|
87 |
+
img_byte_arr = io.BytesIO()
|
88 |
+
image.save(img_byte_arr, format="PNG")
|
89 |
+
return {"bytes": img_byte_arr.getvalue(), "path": None}
|
90 |
+
|
91 |
+
|
92 |
+
if __name__ == "__main__":
|
93 |
+
config_path = os.path.join(os.path.dirname(__file__), "config.json")
|
94 |
+
config = ScraperBotConfig.from_json(config_path)
|
95 |
+
|
96 |
+
bot = ScraperBot(config=config, HFDatasetScheme=HFDatasetScheme, prepare_dataset=prepare_dataset, parse_fn=parse_fn, condition_fn=condition_fn, download_fn=get_image)
|
97 |
+
bot.scrape(fetch_all=os.environ.get("FETCH_ALL", "false").lower() == "true")
|