aztro commited on
Commit
9351860
·
verified ·
1 Parent(s): 2acd1af

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -199
README.md CHANGED
@@ -1,200 +1,7 @@
1
  ---
2
- # For reference on model card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1
3
- # Doc / guide: https://huggingface.co/docs/hub/model-cards
4
- {{ card_data }}
5
- ---
6
-
7
- # Model Card for {{ model_id | default("Model ID", true) }}
8
-
9
- <!-- Provide a quick summary of what the model is/does. -->
10
-
11
- {{ model_summary | default("", true) }}
12
-
13
- ## Model Details
14
-
15
- ### Model Description
16
-
17
- <!-- Provide a longer summary of what this model is. -->
18
-
19
- {{ model_description | default("", true) }}
20
-
21
- - **Developed by:** {{ developers | default("[More Information Needed]", true)}}
22
- - **Funded by [optional]:** {{ funded_by | default("[More Information Needed]", true)}}
23
- - **Shared by [optional]:** {{ shared_by | default("[More Information Needed]", true)}}
24
- - **Model type:** {{ model_type | default("[More Information Needed]", true)}}
25
- - **Language(s) (NLP):** {{ language | default("[More Information Needed]", true)}}
26
- - **License:** {{ license | default("[More Information Needed]", true)}}
27
- - **Finetuned from model [optional]:** {{ base_model | default("[More Information Needed]", true)}}
28
-
29
- ### Model Sources [optional]
30
-
31
- <!-- Provide the basic links for the model. -->
32
-
33
- - **Repository:** {{ repo | default("[More Information Needed]", true)}}
34
- - **Paper [optional]:** {{ paper | default("[More Information Needed]", true)}}
35
- - **Demo [optional]:** {{ demo | default("[More Information Needed]", true)}}
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
- {{ direct_use | default("[More Information Needed]", true)}}
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
- {{ downstream_use | default("[More Information Needed]", true)}}
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
- {{ out_of_scope_use | default("[More Information Needed]", true)}}
58
-
59
- ## Bias, Risks, and Limitations
60
-
61
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
62
-
63
- {{ bias_risks_limitations | default("[More Information Needed]", true)}}
64
-
65
- ### Recommendations
66
-
67
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
68
-
69
- {{ bias_recommendations | default("Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.", true)}}
70
-
71
- ## How to Get Started with the Model
72
-
73
- Use the code below to get started with the model.
74
-
75
- {{ get_started_code | default("[More Information Needed]", true)}}
76
-
77
- ## Training Details
78
-
79
- ### Training Data
80
-
81
- <!-- 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. -->
82
-
83
- {{ training_data | default("[More Information Needed]", true)}}
84
-
85
- ### Training Procedure
86
-
87
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
88
-
89
- #### Preprocessing [optional]
90
-
91
- {{ preprocessing | default("[More Information Needed]", true)}}
92
-
93
-
94
- #### Training Hyperparameters
95
-
96
- - **Training regime:** {{ training_regime | default("[More Information Needed]", true)}} <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
97
-
98
- #### Speeds, Sizes, Times [optional]
99
-
100
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
101
-
102
- {{ speeds_sizes_times | default("[More Information Needed]", true)}}
103
-
104
- ## Evaluation
105
-
106
- <!-- This section describes the evaluation protocols and provides the results. -->
107
-
108
- ### Testing Data, Factors & Metrics
109
-
110
- #### Testing Data
111
-
112
- <!-- This should link to a Dataset Card if possible. -->
113
-
114
- {{ testing_data | default("[More Information Needed]", true)}}
115
-
116
- #### Factors
117
-
118
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
119
-
120
- {{ testing_factors | default("[More Information Needed]", true)}}
121
-
122
- #### Metrics
123
-
124
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
125
-
126
- {{ testing_metrics | default("[More Information Needed]", true)}}
127
-
128
- ### Results
129
-
130
- {{ results | default("[More Information Needed]", true)}}
131
-
132
- #### Summary
133
-
134
- {{ results_summary | default("", true) }}
135
-
136
- ## Model Examination [optional]
137
-
138
- <!-- Relevant interpretability work for the model goes here -->
139
-
140
- {{ model_examination | default("[More Information Needed]", true)}}
141
-
142
- ## Environmental Impact
143
-
144
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
145
-
146
- 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).
147
-
148
- - **Hardware Type:** {{ hardware_type | default("[More Information Needed]", true)}}
149
- - **Hours used:** {{ hours_used | default("[More Information Needed]", true)}}
150
- - **Cloud Provider:** {{ cloud_provider | default("[More Information Needed]", true)}}
151
- - **Compute Region:** {{ cloud_region | default("[More Information Needed]", true)}}
152
- - **Carbon Emitted:** {{ co2_emitted | default("[More Information Needed]", true)}}
153
-
154
- ## Technical Specifications [optional]
155
-
156
- ### Model Architecture and Objective
157
-
158
- {{ model_specs | default("[More Information Needed]", true)}}
159
-
160
- ### Compute Infrastructure
161
-
162
- {{ compute_infrastructure | default("[More Information Needed]", true)}}
163
-
164
- #### Hardware
165
-
166
- {{ hardware_requirements | default("[More Information Needed]", true)}}
167
-
168
- #### Software
169
-
170
- {{ software | default("[More Information Needed]", true)}}
171
-
172
- ## Citation [optional]
173
-
174
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
175
-
176
- **BibTeX:**
177
-
178
- {{ citation_bibtex | default("[More Information Needed]", true)}}
179
-
180
- **APA:**
181
-
182
- {{ citation_apa | default("[More Information Needed]", true)}}
183
-
184
- ## Glossary [optional]
185
-
186
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
187
-
188
- {{ glossary | default("[More Information Needed]", true)}}
189
-
190
- ## More Information [optional]
191
-
192
- {{ more_information | default("[More Information Needed]", true)}}
193
-
194
- ## Model Card Authors [optional]
195
-
196
- {{ model_card_authors | default("[More Information Needed]", true)}}
197
-
198
- ## Model Card Contact
199
-
200
- {{ model_card_contact | default("[More Information Needed]", true)}}
 
1
  ---
2
+ '[object Object]': null
3
+ license: apache-2.0
4
+ language:
5
+ - en
6
+ pipeline_tag: text-to-image
7
+ ---