gospelgit commited on
Commit
8f15eda
·
verified ·
1 Parent(s): 76ca800

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +116 -193
README.md CHANGED
@@ -1,202 +1,125 @@
1
  ---
2
  base_model: togethercomputer/gpt-oss-20b-bf16
3
  library_name: peft
 
 
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
-
8
- <!-- Provide a quick summary of what the model is/does. -->
9
-
10
 
 
 
 
 
 
11
 
12
  ## Model Details
13
 
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
-
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- 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. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- 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).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
200
- ### Framework versions
201
-
202
- - PEFT 0.15.1
 
1
  ---
2
  base_model: togethercomputer/gpt-oss-20b-bf16
3
  library_name: peft
4
+ license: cc-by-4.0
5
+ language:
6
+ - ha
7
+ - yo
8
+ - sw
9
+ tags:
10
+ - sentiment-analysis
11
+ - african-languages
12
+ - lora
13
+ - peft
14
+ - autoscientist-challenge
15
  ---
16
 
17
+ # African Languages Sentiment Classifier (Hausa, Yorùbá, Swahili)
 
 
 
18
 
19
+ A LoRA-adapted sentiment classifier for Hausa, Yorùbá, and Swahili, fine-tuned
20
+ on [`gospelgit/African-Languages_Sentiments`](https://huggingface.co/datasets/gospelgit/African-Languages_Sentiments)
21
+ — a combined dataset of **46,725 rows** stitched from three independent
22
+ sources across three different domains, built to reduce the single-domain
23
+ (Twitter-only) bias common in existing African-language sentiment resources.
24
 
25
  ## Model Details
26
 
27
+ - **Base model:** `togethercomputer/gpt-oss-20b-bf16`
28
+ - **Adapter type:** LoRA (PEFT), rank 64, alpha 128, target modules `q_proj`/`k_proj`/`v_proj`/`o_proj`
29
+ - **Task formulation:** causal LM, prompt single-word completion (the model generates the sentiment label as its next-token completion)
30
+ - **Languages:** Hausa, Yorùbá, Swahili
31
+ - **License:** CC-BY-4.0
32
+ - **Produced via:** [Adaption Labs AutoScientist](https://adaptionlabs.ai/blog/autoscientist-challenge) (Language category submission)
33
+ - **AutoScientist training run ID:** `adaption_gpt_oss_20b_ha_yo_sw_sentiment_1eb424c7`
34
+
35
+ ## Training Data
36
+
37
+ The full dataset card, source breakdown, and licensing details live at
38
+ [`gospelgit/African-Languages_Sentiments`](https://huggingface.co/datasets/gospelgit/African-Languages_Sentiments).
39
+ Summary:
40
+
41
+ | Source | Domain | Languages | Rows |
42
+ |---|---|---|---|
43
+ | AfriSenti | Twitter | Hausa, Yorùbá, Swahili | 40,290 |
44
+ | NollySenti | Nollywood movie reviews (human-translated) | Hausa, Yorùbá | 2,510 |
45
+ | Neurotech-HQ Swahili | Social media / product reviews (back-translated) | Swahili | 3,925 |
46
+
47
+ 3-class labels (`positive` / `negative` / `neutral`), 70/15/15 train/dev/test
48
+ split per language, stratified by label.
49
+
50
+ > **Note on training data adaptation**: this specific adapter was trained on
51
+ > an AutoScientist-evolved version of the dataset above its "Adaptive
52
+ > Data" step rewrote the original rows into `enhanced_prompt`/
53
+ > `enhanced_completion` pairs (15,280 rows after this process) as part of
54
+ > its data-and-recipe co-optimization loop. Both versions are available in
55
+ > the [`gospelgit/African-Languages_Sentiments`](https://huggingface.co/datasets/gospelgit/African-Languages_Sentiments)
56
+ > repo: the original combined dataset described above, and the
57
+ > AutoScientist-adapted version this model was actually trained on. If you
58
+ > want the raw, unmodified rows for your own training pipeline, use the
59
+ > original files rather than the adapted ones.
60
+
61
+ ## Training Procedure
62
+
63
+ - 5 epochs, 585 total steps
64
+ - Train/eval loss decreased steadily across all 5 epochs (eval loss:
65
+ 0.828 0.787 → 0.769 → 0.760 → 0.757)
66
+ - Learning rate: warm-up then decay schedule
67
+ - Framework: PEFT 0.15.1
68
+
69
+ ## Evaluation (AutoScientist internal metrics)
70
+
71
+ These are AutoScientist's own judge-based scores comparing the base model
72
+ against the fine-tuned ("adapted") model — **not standard accuracy/F1**:
73
+
74
+ | Metric | Before (base) | After (adapted) |
75
+ |---|---|---|
76
+ | Quality score (0–10 scale) | 3.0 | 6.9 (+130% relative) |
77
+ | Grade | E | C |
78
+ | Percentile | 1.3 | 8.4 |
79
+ | Win rate on this dataset | 44 | 57 |
80
+ | Win rate — general category (all tasks) | 52 | 48 |
81
+
82
+ **Read this table carefully**: task-specific quality improved substantially
83
+ (grade E→C, +130% relative quality score), but the general-category win rate
84
+ slightly *dropped* (52→48), meaning the adaptation traded a small amount of
85
+ general-purpose capability for sentiment-task performance. This is disclosed
86
+ deliberately — don't assume "adapted" is strictly better in every dimension.
87
+
88
+ ## Intended Use
89
+
90
+ Sentiment classification (positive/negative/neutral) for short-form text in
91
+ Hausa, Yorùbá, or Swahili, primarily for research and benchmarking purposes
92
+ within the AutoScientist Challenge. Not validated for production deployment.
93
+
94
+ ## How to Use
95
+
96
+ ```python
97
+ from peft import PeftModel
98
+ from transformers import AutoModelForCausalLM, AutoTokenizer
99
+
100
+ base_model = AutoModelForCausalLM.from_pretrained("togethercomputer/gpt-oss-20b-bf16")
101
+ model = PeftModel.from_pretrained(base_model, "gospelgit/African-Languages-Sentiment-Classifier")
102
+ tokenizer = AutoTokenizer.from_pretrained("gospelgit/African-Languages-Sentiment-Classifier")
103
+
104
+ prompt = "Classify the sentiment of this text as positive, negative, or neutral: <your text here>"
105
+ inputs = tokenizer(prompt, return_tensors="pt")
106
+ output = model.generate(**inputs, max_new_tokens=5)
107
+ print(tokenizer.decode(output[0], skip_special_tokens=True))
108
+ ```
109
+
110
+ ## Limitations
111
+
112
+ - Evaluated via AutoScientist's internal judge/win-rate system, not an
113
+ external, reproducible benchmark — independent verification is
114
+ recommended before relying on these numbers.
115
+ - Trained on an evolved/rewritten version of the source data, not the raw
116
+ human-annotated labels directly.
117
+ - Slight general-capability regression observed post-adaptation (see table
118
+ above).
119
+ - Swahili has less underlying data than Hausa/Yorùbá — performance may be
120
+ less stable for that language.
121
+
122
+ ## Citation
123
+
124
+ If you use this model, please also cite the original dataset sources
125
+ listed in the [dataset card](https://huggingface.co/datasets/gospelgit/African-Languages_Sentiments).