Update README.md
Browse files
README.md
CHANGED
@@ -8,199 +8,33 @@ metrics:
|
|
8 |
- rouge
|
9 |
pipeline_tag: summarization
|
10 |
---
|
11 |
-
# Model Card for Model ID
|
12 |
-
|
13 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
14 |
-
|
15 |
-
Test
|
16 |
-
|
17 |
-
## Model Details
|
18 |
-
|
19 |
### Model Description
|
20 |
|
21 |
<!-- Provide a longer summary of what this model is. -->
|
|
|
22 |
|
23 |
|
24 |
-
|
25 |
-
- **
|
26 |
-
- **
|
27 |
-
- **
|
28 |
-
- **Model type:** [More Information Needed]
|
29 |
-
- **Language(s) (NLP):** [More Information Needed]
|
30 |
-
- **License:** [More Information Needed]
|
31 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
32 |
-
|
33 |
-
### Model Sources [optional]
|
34 |
-
|
35 |
-
<!-- Provide the basic links for the model. -->
|
36 |
-
|
37 |
-
- **Repository:** [More Information Needed]
|
38 |
-
- **Paper [optional]:** [More Information Needed]
|
39 |
-
- **Demo [optional]:** [More Information Needed]
|
40 |
|
41 |
## Uses
|
42 |
|
43 |
-
|
44 |
-
|
45 |
-
### Direct Use
|
46 |
-
|
47 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
48 |
-
|
49 |
-
[More Information Needed]
|
50 |
-
|
51 |
-
### Downstream Use [optional]
|
52 |
-
|
53 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
54 |
-
|
55 |
-
[More Information Needed]
|
56 |
-
|
57 |
-
### Out-of-Scope Use
|
58 |
-
|
59 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
60 |
-
|
61 |
-
[More Information Needed]
|
62 |
-
|
63 |
-
## Bias, Risks, and Limitations
|
64 |
-
|
65 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
66 |
-
|
67 |
-
[More Information Needed]
|
68 |
-
|
69 |
-
### Recommendations
|
70 |
-
|
71 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
72 |
-
|
73 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
74 |
|
75 |
## How to Get Started with the Model
|
76 |
|
77 |
-
Use the code below to get started with the model.
|
78 |
-
|
79 |
-
[More Information Needed]
|
80 |
-
|
81 |
-
## Training Details
|
82 |
-
|
83 |
-
### Training Data
|
84 |
-
|
85 |
-
<!-- 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. -->
|
86 |
-
|
87 |
-
[More Information Needed]
|
88 |
-
|
89 |
-
### Training Procedure
|
90 |
-
|
91 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
92 |
-
|
93 |
-
#### Preprocessing [optional]
|
94 |
-
|
95 |
-
[More Information Needed]
|
96 |
-
|
97 |
-
|
98 |
-
#### Training Hyperparameters
|
99 |
-
|
100 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
101 |
-
|
102 |
-
#### Speeds, Sizes, Times [optional]
|
103 |
-
|
104 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
105 |
-
|
106 |
-
[More Information Needed]
|
107 |
-
|
108 |
-
## Evaluation
|
109 |
-
|
110 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
111 |
-
|
112 |
-
### Testing Data, Factors & Metrics
|
113 |
-
|
114 |
-
#### Testing Data
|
115 |
|
116 |
-
|
117 |
-
|
118 |
-
[More Information Needed]
|
119 |
-
|
120 |
-
#### Factors
|
121 |
-
|
122 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
123 |
-
|
124 |
-
[More Information Needed]
|
125 |
-
|
126 |
-
#### Metrics
|
127 |
-
|
128 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
129 |
-
|
130 |
-
[More Information Needed]
|
131 |
-
|
132 |
-
### Results
|
133 |
-
|
134 |
-
[More Information Needed]
|
135 |
-
|
136 |
-
#### Summary
|
137 |
-
|
138 |
-
|
139 |
-
|
140 |
-
## Model Examination [optional]
|
141 |
-
|
142 |
-
<!-- Relevant interpretability work for the model goes here -->
|
143 |
-
|
144 |
-
[More Information Needed]
|
145 |
-
|
146 |
-
## Environmental Impact
|
147 |
-
|
148 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
149 |
-
|
150 |
-
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).
|
151 |
-
|
152 |
-
- **Hardware Type:** [More Information Needed]
|
153 |
-
- **Hours used:** [More Information Needed]
|
154 |
-
- **Cloud Provider:** [More Information Needed]
|
155 |
-
- **Compute Region:** [More Information Needed]
|
156 |
-
- **Carbon Emitted:** [More Information Needed]
|
157 |
-
|
158 |
-
## Technical Specifications [optional]
|
159 |
-
|
160 |
-
### Model Architecture and Objective
|
161 |
-
|
162 |
-
[More Information Needed]
|
163 |
-
|
164 |
-
### Compute Infrastructure
|
165 |
-
|
166 |
-
[More Information Needed]
|
167 |
-
|
168 |
-
#### Hardware
|
169 |
-
|
170 |
-
[More Information Needed]
|
171 |
-
|
172 |
-
#### Software
|
173 |
-
|
174 |
-
[More Information Needed]
|
175 |
-
|
176 |
-
## Citation [optional]
|
177 |
-
|
178 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
179 |
-
|
180 |
-
**BibTeX:**
|
181 |
-
|
182 |
-
[More Information Needed]
|
183 |
-
|
184 |
-
**APA:**
|
185 |
-
|
186 |
-
[More Information Needed]
|
187 |
-
|
188 |
-
## Glossary [optional]
|
189 |
-
|
190 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
191 |
-
|
192 |
-
[More Information Needed]
|
193 |
-
|
194 |
-
## More Information [optional]
|
195 |
-
|
196 |
-
[More Information Needed]
|
197 |
-
|
198 |
-
## Model Card Authors [optional]
|
199 |
-
|
200 |
-
[More Information Needed]
|
201 |
|
202 |
## Model Card Contact
|
203 |
|
204 |
-
|
|
|
|
|
|
|
205 |
|
206 |
|
|
|
|
8 |
- rouge
|
9 |
pipeline_tag: summarization
|
10 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
11 |
### Model Description
|
12 |
|
13 |
<!-- Provide a longer summary of what this model is. -->
|
14 |
+
This is a fine-tuned T5-small model for abstractive summarization. This model is fine-tuned with XSUM dataset and CNN/DailyMail dataset where only 20% of the train split and test split are used due to the limited resources for fine-tuning the model (the fine-tuning is done via Google Colab freeplan). The way the datasets are used is by concatenating the the train split and the test split of each datasets. This model achieved 0.25 in ROUGE-1, 0.08 in ROUGE-2, and 0.20 in both ROUGE-L and ROUGE-LSum. The low scores achieved might be happened because the amount of data used for both training and testing, the limit put on the hyperparameters, and the method of preprocessing the data for the model to train and test with. A better resourceful environment might improve the performance of this model.
|
15 |
|
16 |
|
17 |
+
- **Developed by:** Daviadi Auzan Fadhlillah
|
18 |
+
- **Model type:** T5-small
|
19 |
+
- **Language(s) (NLP):** English
|
20 |
+
- **Finetuned from model [optional]:** T5-small
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
21 |
|
22 |
## Uses
|
23 |
|
24 |
+
The aim of fine-tuning this model is to generate an abstractive summarization of online news articles, however this model can be used for other purposes where a summarization is needed.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
25 |
|
26 |
## How to Get Started with the Model
|
27 |
|
28 |
+
Use the code below to get started with the model or to improve the fine-tuning of the model.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
29 |
|
30 |
+
https://colab.research.google.com/drive/1pFUqp51uPdTIIeFUdrpKAYlWD-0VRnAC?usp=sharing
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
31 |
|
32 |
## Model Card Contact
|
33 |
|
34 |
+
I open for any suggestions, therefore you can contact me via email.
|
35 | |
36 |
+
|
37 |
+
Your suggestions are highly appreciated.
|
38 |
|
39 |
|
40 |
+
Thank you for using this model.
|