p1atdev commited on
Commit
a48ac5f
1 Parent(s): 3025eb8

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +216 -0
README.md ADDED
@@ -0,0 +1,216 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ datasets:
3
+ - isek-ai/danbooru-tags-2016-2023
4
+ - wanng/midjourney-v5-202304-clean
5
+ language:
6
+ - en
7
+ library_name: transformers
8
+ widget:
9
+ - example_title: Danbooru Tag Prompt
10
+ text: >-
11
+ Create a tag prompt under the following conditions.
12
+ Tags: 1girl, cat ears, blue hair, school uniform, upper body, light smile
13
+ NSFW: No
14
+ Tag Prompt:
15
+ - example_title: Natural Prompt
16
+ text: >-
17
+ Create a natural prompt under the following conditions.
18
+ Tags: Rainy Day in Cyberpunk City Tokyo
19
+ NSFW: No
20
+ Natural Prompt:
21
+ ---
22
+
23
+ # Model Card for Model ID
24
+
25
+ <!-- Provide a quick summary of what the model is/does. -->
26
+
27
+ 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).
28
+
29
+ ## Model Details
30
+
31
+ ### Model Description
32
+
33
+ <!-- Provide a longer summary of what this model is. -->
34
+
35
+
36
+
37
+ - **Developed by:** [More Information Needed]
38
+ - **Funded by [optional]:** [More Information Needed]
39
+ - **Shared by [optional]:** [More Information Needed]
40
+ - **Model type:** [More Information Needed]
41
+ - **Language(s) (NLP):** [More Information Needed]
42
+ - **License:** [More Information Needed]
43
+ - **Finetuned from model [optional]:** [More Information Needed]
44
+
45
+ ### Model Sources [optional]
46
+
47
+ <!-- Provide the basic links for the model. -->
48
+
49
+ - **Repository:** [More Information Needed]
50
+ - **Paper [optional]:** [More Information Needed]
51
+ - **Demo [optional]:** [More Information Needed]
52
+
53
+ ## Uses
54
+
55
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
56
+
57
+ ### Direct Use
58
+
59
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
60
+
61
+ [More Information Needed]
62
+
63
+ ### Downstream Use [optional]
64
+
65
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
66
+
67
+ [More Information Needed]
68
+
69
+ ### Out-of-Scope Use
70
+
71
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
72
+
73
+ [More Information Needed]
74
+
75
+ ## Bias, Risks, and Limitations
76
+
77
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
78
+
79
+ [More Information Needed]
80
+
81
+ ### Recommendations
82
+
83
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
84
+
85
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
86
+
87
+ ## How to Get Started with the Model
88
+
89
+ Use the code below to get started with the model.
90
+
91
+ [More Information Needed]
92
+
93
+ ## Training Details
94
+
95
+ ### Training Data
96
+
97
+ <!-- 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. -->
98
+
99
+ [More Information Needed]
100
+
101
+ ### Training Procedure
102
+
103
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
104
+
105
+ #### Preprocessing [optional]
106
+
107
+ [More Information Needed]
108
+
109
+
110
+ #### Training Hyperparameters
111
+
112
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
113
+
114
+ #### Speeds, Sizes, Times [optional]
115
+
116
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
117
+
118
+ [More Information Needed]
119
+
120
+ ## Evaluation
121
+
122
+ <!-- This section describes the evaluation protocols and provides the results. -->
123
+
124
+ ### Testing Data, Factors & Metrics
125
+
126
+ #### Testing Data
127
+
128
+ <!-- This should link to a Dataset Card if possible. -->
129
+
130
+ [More Information Needed]
131
+
132
+ #### Factors
133
+
134
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
135
+
136
+ [More Information Needed]
137
+
138
+ #### Metrics
139
+
140
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
141
+
142
+ [More Information Needed]
143
+
144
+ ### Results
145
+
146
+ [More Information Needed]
147
+
148
+ #### Summary
149
+
150
+
151
+
152
+ ## Model Examination [optional]
153
+
154
+ <!-- Relevant interpretability work for the model goes here -->
155
+
156
+ [More Information Needed]
157
+
158
+ ## Environmental Impact
159
+
160
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
161
+
162
+ 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).
163
+
164
+ - **Hardware Type:** [More Information Needed]
165
+ - **Hours used:** [More Information Needed]
166
+ - **Cloud Provider:** [More Information Needed]
167
+ - **Compute Region:** [More Information Needed]
168
+ - **Carbon Emitted:** [More Information Needed]
169
+
170
+ ## Technical Specifications [optional]
171
+
172
+ ### Model Architecture and Objective
173
+
174
+ [More Information Needed]
175
+
176
+ ### Compute Infrastructure
177
+
178
+ [More Information Needed]
179
+
180
+ #### Hardware
181
+
182
+ [More Information Needed]
183
+
184
+ #### Software
185
+
186
+ [More Information Needed]
187
+
188
+ ## Citation [optional]
189
+
190
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
191
+
192
+ **BibTeX:**
193
+
194
+ [More Information Needed]
195
+
196
+ **APA:**
197
+
198
+ [More Information Needed]
199
+
200
+ ## Glossary [optional]
201
+
202
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
203
+
204
+ [More Information Needed]
205
+
206
+ ## More Information [optional]
207
+
208
+ [More Information Needed]
209
+
210
+ ## Model Card Authors [optional]
211
+
212
+ [More Information Needed]
213
+
214
+ ## Model Card Contact
215
+
216
+ [More Information Needed]