Update README.md
Browse files
README.md
CHANGED
@@ -10,12 +10,12 @@ metrics:
|
|
10 |
pipeline_tag: text-classification
|
11 |
---
|
12 |
|
13 |
-
#
|
14 |
|
15 |
<!-- Provide a quick summary of what the model is/does. -->
|
16 |
This repo contains LoRA adapters for the [xlm-roberta-base](https://huggingface.co/xlm-roberta-base) model finetuned on the [Amharic-News-Text-classification-Dataset](https://huggingface.co/datasets/israel/Amharic-News-Text-classification-Dataset).
|
17 |
|
18 |
-
The finetuned model classifies an Amharic news article into the following 6 categories.
|
19 |
- ሀገር አቀፍ ዜና (Local News)
|
20 |
- መዝናኛ (Entertainment)
|
21 |
- ስፖርት (Sports)
|
@@ -95,179 +95,6 @@ Output:
|
|
95 |
- **License:** [More Information Needed]
|
96 |
- **Finetuned from model [optional]:** [More Information Needed]
|
97 |
|
98 |
-
### Model Sources [optional]
|
99 |
-
|
100 |
-
<!-- Provide the basic links for the model. -->
|
101 |
-
|
102 |
-
- **Repository:** [More Information Needed]
|
103 |
-
- **Paper [optional]:** [More Information Needed]
|
104 |
-
- **Demo [optional]:** [More Information Needed]
|
105 |
-
|
106 |
-
## Uses
|
107 |
-
|
108 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
109 |
-
|
110 |
-
### Direct Use
|
111 |
-
|
112 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
113 |
-
|
114 |
-
[More Information Needed]
|
115 |
-
|
116 |
-
### Downstream Use [optional]
|
117 |
-
|
118 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
119 |
-
|
120 |
-
[More Information Needed]
|
121 |
-
|
122 |
-
### Out-of-Scope Use
|
123 |
-
|
124 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
125 |
-
|
126 |
-
[More Information Needed]
|
127 |
-
|
128 |
-
## Bias, Risks, and Limitations
|
129 |
-
|
130 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
131 |
-
|
132 |
-
[More Information Needed]
|
133 |
-
|
134 |
-
### Recommendations
|
135 |
-
|
136 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
137 |
-
|
138 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
139 |
-
|
140 |
-
## How to Get Started with the Model
|
141 |
-
|
142 |
-
Use the code below to get started with the model.
|
143 |
-
|
144 |
-
[More Information Needed]
|
145 |
-
|
146 |
-
## Training Details
|
147 |
-
|
148 |
-
### Training Data
|
149 |
-
|
150 |
-
<!-- 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. -->
|
151 |
-
|
152 |
-
[More Information Needed]
|
153 |
-
|
154 |
-
### Training Procedure
|
155 |
-
|
156 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
157 |
-
|
158 |
-
#### Preprocessing [optional]
|
159 |
-
|
160 |
-
[More Information Needed]
|
161 |
-
|
162 |
-
|
163 |
-
#### Training Hyperparameters
|
164 |
-
|
165 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
166 |
-
|
167 |
-
#### Speeds, Sizes, Times [optional]
|
168 |
-
|
169 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
170 |
-
|
171 |
-
[More Information Needed]
|
172 |
-
|
173 |
-
## Evaluation
|
174 |
-
|
175 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
176 |
-
|
177 |
-
### Testing Data, Factors & Metrics
|
178 |
-
|
179 |
-
#### Testing Data
|
180 |
-
|
181 |
-
<!-- This should link to a Dataset Card if possible. -->
|
182 |
-
|
183 |
-
[More Information Needed]
|
184 |
-
|
185 |
-
#### Factors
|
186 |
-
|
187 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
188 |
-
|
189 |
-
[More Information Needed]
|
190 |
-
|
191 |
-
#### Metrics
|
192 |
-
|
193 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
194 |
-
|
195 |
-
[More Information Needed]
|
196 |
-
|
197 |
-
### Results
|
198 |
-
|
199 |
-
[More Information Needed]
|
200 |
-
|
201 |
-
#### Summary
|
202 |
-
|
203 |
-
|
204 |
-
|
205 |
-
## Model Examination [optional]
|
206 |
-
|
207 |
-
<!-- Relevant interpretability work for the model goes here -->
|
208 |
-
|
209 |
-
[More Information Needed]
|
210 |
-
|
211 |
-
## Environmental Impact
|
212 |
-
|
213 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
214 |
-
|
215 |
-
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).
|
216 |
-
|
217 |
-
- **Hardware Type:** [More Information Needed]
|
218 |
-
- **Hours used:** [More Information Needed]
|
219 |
-
- **Cloud Provider:** [More Information Needed]
|
220 |
-
- **Compute Region:** [More Information Needed]
|
221 |
-
- **Carbon Emitted:** [More Information Needed]
|
222 |
-
|
223 |
-
## Technical Specifications [optional]
|
224 |
-
|
225 |
-
### Model Architecture and Objective
|
226 |
-
|
227 |
-
[More Information Needed]
|
228 |
-
|
229 |
-
### Compute Infrastructure
|
230 |
-
|
231 |
-
[More Information Needed]
|
232 |
-
|
233 |
-
#### Hardware
|
234 |
-
|
235 |
-
[More Information Needed]
|
236 |
-
|
237 |
-
#### Software
|
238 |
-
|
239 |
-
[More Information Needed]
|
240 |
-
|
241 |
-
## Citation [optional]
|
242 |
-
|
243 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
244 |
-
|
245 |
-
**BibTeX:**
|
246 |
-
|
247 |
-
[More Information Needed]
|
248 |
-
|
249 |
-
**APA:**
|
250 |
-
|
251 |
-
[More Information Needed]
|
252 |
-
|
253 |
-
## Glossary [optional]
|
254 |
-
|
255 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
256 |
-
|
257 |
-
[More Information Needed]
|
258 |
-
|
259 |
-
## More Information [optional]
|
260 |
-
|
261 |
-
[More Information Needed]
|
262 |
-
|
263 |
-
## Model Card Authors [optional]
|
264 |
-
|
265 |
-
[More Information Needed]
|
266 |
-
|
267 |
-
## Model Card Contact
|
268 |
-
|
269 |
-
[More Information Needed]
|
270 |
-
|
271 |
|
272 |
### Framework versions
|
273 |
|
|
|
10 |
pipeline_tag: text-classification
|
11 |
---
|
12 |
|
13 |
+
# xlm-roberta-base-lora-amharic-news-classification
|
14 |
|
15 |
<!-- Provide a quick summary of what the model is/does. -->
|
16 |
This repo contains LoRA adapters for the [xlm-roberta-base](https://huggingface.co/xlm-roberta-base) model finetuned on the [Amharic-News-Text-classification-Dataset](https://huggingface.co/datasets/israel/Amharic-News-Text-classification-Dataset).
|
17 |
|
18 |
+
The finetuned model classifies an Amharic news article into one of the following 6 categories.
|
19 |
- ሀገር አቀፍ ዜና (Local News)
|
20 |
- መዝናኛ (Entertainment)
|
21 |
- ስፖርት (Sports)
|
|
|
95 |
- **License:** [More Information Needed]
|
96 |
- **Finetuned from model [optional]:** [More Information Needed]
|
97 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
98 |
|
99 |
### Framework versions
|
100 |
|