Justin Du commited on
Commit
12681ff
1 Parent(s): abf5454

update model card

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