philipp-zettl commited on
Commit
d70b0f8
1 Parent(s): 7731834

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +26 -194
README.md CHANGED
@@ -40,197 +40,29 @@ widget:
40
  <Gallery />
41
 
42
 
43
- # Model Card for Model ID
44
-
45
- <!-- Provide a quick summary of what the model is/does. -->
46
-
47
-
48
-
49
- ## Model Details
50
-
51
- ### Model Description
52
-
53
- <!-- Provide a longer summary of what this model is. -->
54
-
55
- This is the model card of a 🧨 diffusers model that has been pushed on the Hub. This model card has been automatically generated.
56
-
57
- - **Developed by:** [More Information Needed]
58
- - **Funded by [optional]:** [More Information Needed]
59
- - **Shared by [optional]:** [More Information Needed]
60
- - **Model type:** [More Information Needed]
61
- - **Language(s) (NLP):** [More Information Needed]
62
- - **License:** [More Information Needed]
63
- - **Finetuned from model [optional]:** [More Information Needed]
64
-
65
- ### Model Sources [optional]
66
-
67
- <!-- Provide the basic links for the model. -->
68
-
69
- - **Repository:** [More Information Needed]
70
- - **Paper [optional]:** [More Information Needed]
71
- - **Demo [optional]:** [More Information Needed]
72
-
73
- ## Uses
74
-
75
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
76
-
77
- ### Direct Use
78
-
79
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
80
-
81
- [More Information Needed]
82
-
83
- ### Downstream Use [optional]
84
-
85
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
86
-
87
- [More Information Needed]
88
-
89
- ### Out-of-Scope Use
90
-
91
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
92
-
93
- [More Information Needed]
94
-
95
- ## Bias, Risks, and Limitations
96
-
97
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
98
-
99
- [More Information Needed]
100
-
101
- ### Recommendations
102
-
103
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
104
-
105
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
106
-
107
- ## How to Get Started with the Model
108
-
109
- Use the code below to get started with the model.
110
-
111
- [More Information Needed]
112
-
113
- ## Training Details
114
-
115
- ### Training Data
116
-
117
- <!-- 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. -->
118
-
119
- [More Information Needed]
120
-
121
- ### Training Procedure
122
-
123
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
124
-
125
- #### Preprocessing [optional]
126
-
127
- [More Information Needed]
128
-
129
-
130
- #### Training Hyperparameters
131
-
132
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
133
-
134
- #### Speeds, Sizes, Times [optional]
135
-
136
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
137
-
138
- [More Information Needed]
139
-
140
- ## Evaluation
141
-
142
- <!-- This section describes the evaluation protocols and provides the results. -->
143
-
144
- ### Testing Data, Factors & Metrics
145
-
146
- #### Testing Data
147
-
148
- <!-- This should link to a Dataset Card if possible. -->
149
-
150
- [More Information Needed]
151
-
152
- #### Factors
153
-
154
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
155
-
156
- [More Information Needed]
157
-
158
- #### Metrics
159
-
160
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
161
-
162
- [More Information Needed]
163
-
164
- ### Results
165
-
166
- [More Information Needed]
167
-
168
- #### Summary
169
-
170
-
171
-
172
- ## Model Examination [optional]
173
-
174
- <!-- Relevant interpretability work for the model goes here -->
175
-
176
- [More Information Needed]
177
-
178
- ## Environmental Impact
179
-
180
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
181
-
182
- 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).
183
-
184
- - **Hardware Type:** [More Information Needed]
185
- - **Hours used:** [More Information Needed]
186
- - **Cloud Provider:** [More Information Needed]
187
- - **Compute Region:** [More Information Needed]
188
- - **Carbon Emitted:** [More Information Needed]
189
-
190
- ## Technical Specifications [optional]
191
-
192
- ### Model Architecture and Objective
193
-
194
- [More Information Needed]
195
-
196
- ### Compute Infrastructure
197
-
198
- [More Information Needed]
199
-
200
- #### Hardware
201
-
202
- [More Information Needed]
203
-
204
- #### Software
205
-
206
- [More Information Needed]
207
-
208
- ## Citation [optional]
209
-
210
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
211
-
212
- **BibTeX:**
213
-
214
- [More Information Needed]
215
-
216
- **APA:**
217
-
218
- [More Information Needed]
219
-
220
- ## Glossary [optional]
221
-
222
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
223
-
224
- [More Information Needed]
225
-
226
- ## More Information [optional]
227
-
228
- [More Information Needed]
229
-
230
- ## Model Card Authors [optional]
231
-
232
- [More Information Needed]
233
-
234
- ## Model Card Contact
235
-
236
- [More Information Needed]
 
40
  <Gallery />
41
 
42
 
43
+ ## Trigger words
44
+ To trigger the LoRA use the prompt `in style of DSYL`
45
+
46
+ ## Training
47
+ This adapter has been trained using the [autotrain-advanced dreambooth colab-notebook](https://github.com/huggingface/autotrain-advanced/tree/main?tab=readme-ov-file#colabs) with the dataset stored in `./images/training`.
48
+
49
+ Training time was ~14 minutes on a T4 instance.
50
+
51
+ ### Config
52
+ The following config has been used
53
+ ```yaml
54
+ project_name = 'disco-elysium'
55
+ model_name = 'stable-diffusion-v1-5/stable-diffusion-v1-5'
56
+ prompt = 'in the style of DSYL'
57
+
58
+ learning_rate = 1e-4
59
+ num_steps = 500
60
+ batch_size = 1
61
+ gradient_accumulation = 4
62
+ resolution = 512
63
+ use_8bit_adam = False
64
+ use_xformers = False
65
+ mixed_precision = "fp16"
66
+ train_text_encoder = True
67
+ disable_gradient_checkpointing = False
68
+ ```