Create README.md

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