gxkok commited on
Commit
5397dc2
1 Parent(s): cdf9c0f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +212 -0
README.md CHANGED
@@ -1,3 +1,215 @@
1
  ---
2
  license: apache-2.0
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
  ---
4
+
5
+ # Model Card for layer_xl_transparent_attn
6
+
7
+ <!-- Provide a quick summary of what the model is/does. -->
8
+
9
+ This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
10
+
11
+ ## Model Details
12
+
13
+ LoRA weights for SDXL using huggingface diffusers converted from this [weight](https://huggingface.co/LayerDiffusion/layerdiffusion-v1/resolve/main/layer_xl_transparent_attn.safetensors).
14
+
15
+ ### Model Description
16
+
17
+ <!-- Provide a longer summary of what this model is. -->
18
+
19
+
20
+
21
+ - **Developed by:** Lvmin Zhang et al
22
+ - **Funded by [optional]:** [More Information Needed]
23
+ - **Shared by [optional]:** [More Information Needed]
24
+ - **Model type:** SDXL LoRA-256
25
+ - **Language(s) (NLP):** [More Information Needed]
26
+ - **License:** Apache 2.0
27
+ - **Finetuned from model [optional]:** SDXL
28
+
29
+ ### Model Sources [optional]
30
+
31
+ <!-- Provide the basic links for the model. -->
32
+
33
+ - **Repository:** https://github.com/layerdiffusion/LayerDiffuse
34
+ - **Paper [optional]:** https://arxiv.org/abs/2402.17113
35
+ - **Demo [optional]:** [More Information Needed]
36
+
37
+ ## Uses
38
+
39
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
40
+
41
+ ### Direct Use
42
+
43
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
44
+
45
+ [More Information Needed]
46
+
47
+ ### Downstream Use [optional]
48
+
49
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
50
+
51
+ [More Information Needed]
52
+
53
+ ### Out-of-Scope Use
54
+
55
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
56
+
57
+ [More Information Needed]
58
+
59
+ ## Bias, Risks, and Limitations
60
+
61
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
62
+
63
+ [More Information Needed]
64
+
65
+ ### Recommendations
66
+
67
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
68
+
69
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
70
+
71
+ ## How to Get Started with the Model
72
+
73
+ ```bash
74
+ from diffusers import StableDiffusionXLPipeline
75
+ from huggingface_hub import hf_hub_download
76
+ from safetensors.torch import load_file
77
+
78
+ pipe = StableDiffusionXLPipeline.from_pretrained(
79
+ "stabilityai/stable-diffusion-xl-base-1.0",
80
+ use_safetensors=True,
81
+ variant="fp16",
82
+ torch_dtype=torch.float16,
83
+ )
84
+ # pipe.enable_xformers_memory_efficient_attention()
85
+ pipe.to("cuda")
86
+
87
+ pipe.load_lora_weights(hf_hub_download("gxkok/layer-diffusion-xl-transparent-attn-lora", "pytorch_lora_weights.safetensors"))
88
+ ```
89
+
90
+ [More Information Needed]
91
+
92
+ ## Training Details
93
+
94
+ ### Training Data
95
+
96
+ <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
97
+
98
+ [More Information Needed]
99
+
100
+ ### Training Procedure
101
+
102
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
103
+
104
+ #### Preprocessing [optional]
105
+
106
+ [More Information Needed]
107
+
108
+
109
+ #### Training Hyperparameters
110
+
111
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
112
+
113
+ #### Speeds, Sizes, Times [optional]
114
+
115
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
116
+
117
+ [More Information Needed]
118
+
119
+ ## Evaluation
120
+
121
+ <!-- This section describes the evaluation protocols and provides the results. -->
122
+
123
+ ### Testing Data, Factors & Metrics
124
+
125
+ #### Testing Data
126
+
127
+ <!-- This should link to a Dataset Card if possible. -->
128
+
129
+ [More Information Needed]
130
+
131
+ #### Factors
132
+
133
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
134
+
135
+ [More Information Needed]
136
+
137
+ #### Metrics
138
+
139
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
140
+
141
+ [More Information Needed]
142
+
143
+ ### Results
144
+
145
+ [More Information Needed]
146
+
147
+ #### Summary
148
+
149
+
150
+
151
+ ## Model Examination [optional]
152
+
153
+ <!-- Relevant interpretability work for the model goes here -->
154
+
155
+ [More Information Needed]
156
+
157
+ ## Environmental Impact
158
+
159
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
160
+
161
+ Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
162
+
163
+ - **Hardware Type:** [More Information Needed]
164
+ - **Hours used:** [More Information Needed]
165
+ - **Cloud Provider:** [More Information Needed]
166
+ - **Compute Region:** [More Information Needed]
167
+ - **Carbon Emitted:** [More Information Needed]
168
+
169
+ ## Technical Specifications [optional]
170
+
171
+ ### Model Architecture and Objective
172
+
173
+ [More Information Needed]
174
+
175
+ ### Compute Infrastructure
176
+
177
+ [More Information Needed]
178
+
179
+ #### Hardware
180
+
181
+ [More Information Needed]
182
+
183
+ #### Software
184
+
185
+ [More Information Needed]
186
+
187
+ ## Citation [optional]
188
+
189
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
190
+
191
+ **BibTeX:**
192
+
193
+ [More Information Needed]
194
+
195
+ **APA:**
196
+
197
+ [More Information Needed]
198
+
199
+ ## Glossary [optional]
200
+
201
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
202
+
203
+ [More Information Needed]
204
+
205
+ ## More Information [optional]
206
+
207
+ [More Information Needed]
208
+
209
+ ## Model Card Authors [optional]
210
+
211
+ [More Information Needed]
212
+
213
+ ## Model Card Contact
214
+
215
+ [More Information Needed]