Justin Du commited on
Commit
8236ee0
1 Parent(s): ed83b7e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +42 -183
README.md CHANGED
@@ -22,201 +22,60 @@ model-index:
22
  value: 15.134827404979639
23
  ---
24
 
25
- # Model Card for Model ID
 
26
 
27
- <!-- Provide a quick summary of what the model is/does. -->
28
 
29
- # Table of Contents
 
 
 
 
 
 
30
 
31
- 1. [Model Details](#model-details)
32
- 2. [Uses](#uses)
33
- 3. [Bias, Risks, and Limitations](#bias-risks-and-limitations)
34
- 4. [Training Details](#training-details)
35
- 5. [Evaluation](#evaluation)
36
- 6. [Model Examination](#model-examination-optional)
37
- 7. [Environmental Impact](#environmental-impact)
38
- 8. [Technical Specifications](#technical-specifications-optional)
39
- 9. [Citation](#citation-optional)
40
- 10. [Glossary](#glossary-optional)
41
- 11. [More Information](#more-information-optional)
42
- 12. [Model Card Authors](#model-card-authors-optional)
43
- 13. [Model Card Contact](#model-card-contact)
44
- 14. [How To Get Started With the Model](#how-to-get-started-with-the-model)
45
 
 
46
 
47
- # Model Details
48
 
49
- ## Model Description
50
 
51
- <!-- Provide a longer summary of what this model is. -->
52
 
 
53
 
 
54
 
55
- - **Developed by:** [More Information Needed]
56
- - **Shared by [optional]:** [More Information Needed]
57
- - **Model type:** [More Information Needed]
58
- - **Language(s) (NLP):** en
59
- - **License:** mit
60
- - **Finetuned from model [optional]:** [More Information Needed]
61
- - **Resources for more information:** [More Information Needed]
62
 
63
- # Uses
 
 
 
 
 
 
64
 
65
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
66
 
67
- ## Direct Use
 
 
 
 
 
 
 
 
 
 
68
 
69
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
70
 
71
- [More Information Needed]
72
-
73
- ## Downstream Use [optional]
74
-
75
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
76
-
77
- [More Information Needed]
78
-
79
- ## Out-of-Scope Use
80
-
81
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
82
-
83
- [More Information Needed]
84
-
85
- # Bias, Risks, and Limitations
86
-
87
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
88
-
89
- [More Information Needed]
90
-
91
- ## Recommendations
92
-
93
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
94
-
95
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
96
-
97
- # Training Details
98
-
99
- ## Training Data
100
-
101
- <!-- 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. -->
102
-
103
- [More Information Needed]
104
-
105
- ## Training Procedure [optional]
106
-
107
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
108
-
109
- ### Preprocessing
110
-
111
- [More Information Needed]
112
-
113
- ### Speeds, Sizes, Times
114
-
115
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
116
-
117
- [More Information Needed]
118
-
119
- # Evaluation
120
-
121
- <!-- This section describes the evaluation protocols and provides the results. -->
122
-
123
- ## Testing Data, Factors & Metrics
124
-
125
- ### Testing Data
126
-
127
- <!-- This should link to a Data Card if possible. -->
128
-
129
- [More Information Needed]
130
-
131
- ### Factors
132
-
133
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
134
-
135
- [More Information Needed]
136
-
137
- ### Metrics
138
-
139
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
140
-
141
- [More Information Needed]
142
-
143
- ## Results
144
-
145
- [More Information Needed]
146
-
147
- # Model Examination [optional]
148
-
149
- <!-- Relevant interpretability work for the model goes here -->
150
-
151
- [More Information Needed]
152
-
153
- # Environmental Impact
154
-
155
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
156
-
157
- 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).
158
-
159
- - **Hardware Type:** [More Information Needed]
160
- - **Hours used:** [More Information Needed]
161
- - **Cloud Provider:** [More Information Needed]
162
- - **Compute Region:** [More Information Needed]
163
- - **Carbon Emitted:** [More Information Needed]
164
-
165
- # Technical Specifications [optional]
166
-
167
- ## Model Architecture and Objective
168
-
169
- [More Information Needed]
170
-
171
- ## Compute Infrastructure
172
-
173
- [More Information Needed]
174
-
175
- ### Hardware
176
-
177
- [More Information Needed]
178
-
179
- ### Software
180
-
181
- [More Information Needed]
182
-
183
- # Citation [optional]
184
-
185
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
186
-
187
- **BibTeX:**
188
-
189
- [More Information Needed]
190
-
191
- **APA:**
192
-
193
- [More Information Needed]
194
-
195
- # Glossary [optional]
196
-
197
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
198
-
199
- [More Information Needed]
200
-
201
- # More Information [optional]
202
-
203
- [More Information Needed]
204
-
205
- # Model Card Authors [optional]
206
-
207
- [More Information Needed]
208
-
209
- # Model Card Contact
210
-
211
- [More Information Needed]
212
-
213
- # How to Get Started with the Model
214
-
215
- Use the code below to get started with the model.
216
-
217
- <details>
218
- <summary> Click to expand </summary>
219
-
220
- [More Information Needed]
221
-
222
- </details>
 
22
  value: 15.134827404979639
23
  ---
24
 
25
+ <!-- This model card has been generated automatically according to the information the Trainer had access to. You
26
+ should probably proofread and complete it, then remove this comment. -->
27
 
28
+ # BARTxiv
29
 
30
+ This model is a fine-tuned version of [facebook/bart-large-cnn](https://huggingface.co/facebook/bart-large-cnn) on the [arxiv-summarization](https://huggingface.co/datasets/ccdv/arxiv-summarization) dataset.
31
+ It achieves the following results on the validation set:
32
+ - Loss: 0.86
33
+ - Rouge1: 41.70
34
+ - Rouge2: 15.13
35
+ - Rougel: 22.85
36
+ - Rougelsum: 37.77
37
 
38
+ ## Model description
 
 
 
 
 
 
 
 
 
 
 
 
 
39
 
40
+ More information needed
41
 
42
+ ## Intended uses & limitations
43
 
44
+ More information needed
45
 
46
+ ## Training and evaluation data
47
 
48
+ More information needed
49
 
50
+ ## Training procedure
51
 
52
+ ### Training hyperparameters
 
 
 
 
 
 
53
 
54
+ The following hyperparameters were used during training:
55
+ - learning_rate: 1e-6
56
+ - train_batch_size: 1
57
+ - eval_batch_size: 1
58
+ - seed: 42
59
+ - optimizer: Adafactor
60
+ - num_epochs: 9
61
 
62
+ ### Training results
63
 
64
+ | Training Loss | Epoch | Step | Validation Loss | Rouge1 | Rouge2 | Rougel | Rougelsum |
65
+ |:-------------:|:-----:|:----:|:---------------:|:-------:|:-------:|:-------:|:---------:|
66
+ | 1.24 | 1.0 | 1073 | 7.8495 | 38.32 | 12.80 | 20.55 | 34.50 |
67
+ | 1.04 | 2.0 | 2146 | 5.8341 | 39.65 | 13.74 | 21.28 | 35.83 |
68
+ | 0.979 | 3.0 | 3219 | 4.0960 | 40.19 | 14.30 | 21.87 | 36.38 |
69
+ | 0.970 | 4.0 | 4292 | 3.5401 | 40.87 | 14.44 | 22.14 | 36.89 |
70
+ | 0.918 | 5.0 | 5365 | 3.5401 | 41.17 | 14.94 | 22.54 | 37.40 |
71
+ | 0.901 | 6.0 | 6438 | 3.5401 | 41.02 | 14.65 | 22.46 | 37.05 |
72
+ | 0.889 | 7.0 | 7511 | 3.5401 | 41.32 | 15.09 | 22.64 | 37.42 |
73
+ | 0.900 | 8.0 | 8584 | 3.5401 | 41.23 | 15.02 | 22.67 | 37.28 |
74
+ | 0.869 | 9.0 | 9657 | 3.5401 | 41.70 | 15.13 | 22.85 | 37.77 |
75
 
76
+ ### Framework versions
77
 
78
+ - Transformers 4.25.1
79
+ - Pytorch 1.13.0+cu117
80
+ - Datasets 2.6.1
81
+ - Tokenizers 0.13.1