Daudipdg commited on
Commit
d55b4e5
Β·
verified Β·
1 Parent(s): 0d9c271

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +98 -159
README.md CHANGED
@@ -1,199 +1,138 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
 
 
 
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
- This is the model card of a πŸ€— transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
 
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]
 
1
  ---
2
+ license: cc-by-nc-4.0
3
+ language:
4
+ - sw
5
+ - fr
6
+ - zu
7
+ - ha
8
+ base_model: Davlan/afro-xlmr-base
9
+ tags:
10
+ - bias-detection
11
+ - african-languages
12
+ - text-classification
13
+ - responsible-ai
14
+ pipeline_tag: text-classification
15
  ---
16
 
17
+ # MAKINI v2 β€” African Language Bias Detection Model
18
 
19
+ ## Model Description
20
 
21
+ MAKINI v2 is a 4-class bias detection model covering Swahili, French, isiZulu, and Hausa, fine-tuned on the AfricaBias dataset (60,234 sentences). It succeeds MAKINI v1 (Swahili/French only) β€” this is a new backbone and two additional languages, not an incremental v1.1.
22
 
23
+ **Validated for production use: Swahili, French, isiZulu β€” all four classes.**
24
+ **Hausa: neutral-vs-not detection only.** Hausa's stereotype, counter-stereotype, and derogation classes are not reliable in this release β€” see Known Limitations before using Hausa output for anything beyond flagging "neutral or not."
25
 
26
+ ## Base Model
27
 
28
+ `Davlan/afro-xlmr-base`, not vanilla `xlm-roberta-base` (used in v1). Chosen because standard XLM-R's pretraining did not meaningfully cover isiZulu; AfroXLMR extends coverage to isiZulu, Hausa, and Chichewa (planned next language) in one backbone.
29
 
30
+ ## Training Approach
31
 
32
+ Two-stage fine-tune, same recipe as v1:
33
+ - **Stage 1** β€” binary (neutral vs. biased), warm-start. F1 macro: 0.963
34
+ - **Stage 2** β€” 4-class, initialized from Stage 1's encoder, weighted cross-entropy for class imbalance
35
 
36
+ Note: this release uses the same Swahili/French label distribution as v1 (24,220 neutral / 9,605 stereotype / 1,288 counter-stereotype / 172 derogation, combined). The separate counterstereotype/derogation rebalancing effort for Swahili/French has not yet been incorporated into any shipped model.
 
 
 
 
 
 
37
 
38
+ ## Labels
39
 
40
+ | ID | Label |
41
+ | -- | ----- |
42
+ | 0 | neutral |
43
+ | 1 | stereotype |
44
+ | 2 | counter-stereotype |
45
+ | 3 | derogation |
46
 
47
+ ## Performance β€” Held-Out Test Set (n=6,024)
 
 
48
 
49
+ ### Overall
50
 
51
+ | Class | Precision | Recall | F1 | Support |
52
+ | ----- | --------- | ------ | -- | ------- |
53
+ | neutral | 0.97 | 0.98 | 0.97 | 3,963 |
54
+ | stereotype | 0.95 | 0.94 | 0.95 | 1,837 |
55
+ | counter-stereotype | 1.00 | 0.89 | 0.94 | 141 |
56
+ | derogation | 0.78 | 0.64 | 0.70 | 83 |
57
+ | **accuracy** | | | **0.96** | 6,024 |
58
+ | macro avg | 0.92 | 0.86 | 0.89 | 6,024 |
59
+ | weighted avg | 0.96 | 0.96 | 0.96 | 6,024 |
60
 
61
+ The overall row is not a safe substitute for the per-language breakdown below β€” see Known Limitations.
62
 
63
+ ### Per Language
64
 
65
+ **French (n=1,149)** β€” accuracy 0.95, macro F1 0.96
66
 
67
+ | Class | Precision | Recall | F1 | Support |
68
+ | ----- | --------- | ------ | -- | ------- |
69
+ | neutral | 0.98 | 0.93 | 0.95 | 600 |
70
+ | stereotype | 0.91 | 0.97 | 0.94 | 443 |
71
+ | counter-stereotype | 1.00 | 1.00 | 1.00 | 91 |
72
+ | derogation | 0.88 | 1.00 | 0.94 | 15 |
73
 
74
+ **Swahili (n=2,418)** β€” accuracy 0.98, macro F1 0.74 (derogation support = 1, statistically meaningless β€” see Known Limitations)
75
 
76
+ | Class | Precision | Recall | F1 | Support |
77
+ | ----- | --------- | ------ | -- | ------- |
78
+ | neutral | 0.99 | 0.99 | 0.99 | 1,840 |
79
+ | stereotype | 0.97 | 0.96 | 0.97 | 541 |
80
+ | counter-stereotype | 1.00 | 0.97 | 0.99 | 36 |
81
+ | derogation | 0.00 | 0.00 | 0.00 | 1 |
82
 
83
+ **isiZulu (n=1,486)** β€” accuracy 0.99, macro F1 0.72 (counter-stereotype: no examples exist in source data β€” see Known Limitations)
84
 
85
+ | Class | Precision | Recall | F1 | Support |
86
+ | ----- | --------- | ------ | -- | ------- |
87
+ | neutral | 0.99 | 0.99 | 0.99 | 667 |
88
+ | stereotype | 0.99 | 0.99 | 0.99 | 783 |
89
+ | counter-stereotype | β€” | β€” | β€” | 0 |
90
+ | derogation | 0.94 | 0.89 | 0.91 | 36 |
91
 
92
+ **Hausa (n=971)** β€” accuracy 0.88, macro F1 0.32. **Neutral detection works; the other three classes do not.**
93
 
94
+ | Class | Precision | Recall | F1 | Support |
95
+ | ----- | --------- | ------ | -- | ------- |
96
+ | neutral | 0.90 | 0.98 | 0.94 | 856 |
97
+ | stereotype | 0.19 | 0.04 | 0.07 | 70 |
98
+ | counter-stereotype | 0.00 | 0.00 | 0.00 | 14 |
99
+ | derogation | 0.38 | 0.19 | 0.26 | 31 |
100
 
101
+ ## Known Limitations
102
 
103
+ **Hausa: stereotype, counter-stereotype, and derogation detection are not usable.** Recall on stereotype is 0.04 β€” the model misses 96% of actual Hausa stereotype content. Counter-stereotype recall is 0.00. Only neutral-vs-not-neutral is reliable for Hausa in this release. Root cause: Hausa's own 4-class split is heavily neutral-skewed (89%), and its 718/124/293 stereotype/counter-stereotype/derogation examples are a small fraction of the pooled multilingual training signal for those classes β€” global class weighting does not protect a single language's minority share within an already-weighted class. Addressing this needs either more Hausa non-neutral annotation or language-aware reweighting, not just longer training.
104
 
105
+ **isiZulu has no counter-stereotype examples** in the source data β€” this class cannot be evaluated for isiZulu and its true performance on isiZulu counter-stereotype content is unknown, not zero.
106
 
107
+ **Swahili derogation test support is 1 example.** The 0.00 F1 shown above reflects a single data point, not a real measurement of Swahili derogation performance.
108
 
109
+ **isiZulu's `domain` field is unreliable for ~43% of source rows** (see dataset card) β€” do not use domain-level breakdowns for isiZulu.
110
 
111
+ Limitations carried over from v1, not addressed by this release:
112
+ - Negation handling: stereotypes stated then negated are not reliably detected
113
+ - Sheng (informal Kenyan Swahili slang) is underrepresented in training data
114
+ - Implicit stereotyping conveyed through French sentence structure may be missed
115
 
116
+ ## Languages
117
 
118
+ Swahili, French, isiZulu, Hausa (Hausa scoped per Known Limitations above).
119
 
120
+ ## License
121
 
122
+ CC BY-NC 4.0. Commercial use requires explicit permission from Makini AI Limited.
123
 
124
+ ## Citation
125
 
126
+ ```bibtex
127
+ @model{wachira2026makiniv2,
128
+ title = {MAKINI v2: African Language Bias Detection Model},
129
+ author = {Wachira, David Maina},
130
+ year = {2026},
131
+ publisher = {Algedi Intelligence Labs},
132
+ url = {https://huggingface.co/MakiniAI/makini-v2},
133
+ }
134
+ ```
135
 
136
+ ## Contact
137
 
138
+ David Maina Wachira β€” dave@makini.tech β€” https://makini.tech