mkbadeniyi commited on
Commit
b4c07be
Β·
verified Β·
1 Parent(s): ffd1881

Update card for full-precision release

Browse files
Files changed (1) hide show
  1. README.md +37 -15
README.md CHANGED
@@ -5,7 +5,7 @@ base_model: NCAIR1/N-ATLaS
5
  base_model_relation: finetune
6
  language: [yo, ha, ig, en]
7
  pipeline_tag: text-generation
8
- library_name: gguf
9
  datasets: [google/smol, openai/gsm8k]
10
  metrics: [chrf, accuracy]
11
  tags:
@@ -21,6 +21,7 @@ tags:
21
  - llama-3
22
  - llama-cpp
23
  - gguf
 
24
  ---
25
 
26
  # WazoCore
@@ -29,7 +30,7 @@ WazoCore is an 8B language model for Yoruba, Hausa and Igbo, adapted from
29
  N-ATLaS with 15,000 additional tokens for the three languages. It encodes
30
  them in roughly a third fewer tokens than its base model, making generation
31
  1.6 to 1.7 times faster on commodity hardware, and is a drop-in replacement
32
- in llama.cpp, LM Studio and OpenAI-compatible stacks.
33
 
34
  This release, v13, supersedes [WazoCore v6](https://huggingface.co/quantile-labs/WazoCore-8B-v6-long).
35
  It retains v6's efficiency and translation quality and recovers most of the
@@ -37,10 +38,10 @@ reasoning lost in vocabulary adaptation.
37
 
38
  | Change from v6 | v6 | v13 |
39
  |---|---|---|
40
- | Mathematical reasoning (AfriMGSM), vs base model | βˆ’11.6 | +1.1 (βˆ’2.3, +4.4) |
41
- | Natural-language inference (AfriXNLI), vs base model | βˆ’7.5 | βˆ’5.3 |
42
- | Degenerate repetition, 750 test translations | 5 | 2 |
43
- | Truncated outputs, 750 test translations | 13 | 8 |
44
  | Decomposed Unicode input | efficiency lost | normalised (NFC) |
45
 
46
  ## Model details
@@ -51,7 +52,7 @@ reasoning lost in vocabulary adaptation.
51
  | Base model | NCAIR1/N-ATLaS (Llama-3 architecture, 8B parameters) |
52
  | Licensed name | WazoCore Powered by Awarri. |
53
  | Vocabulary | 143,256 tokens: the base model's 128,256, unchanged in id and embedding, plus 15,000 for Yoruba, Hausa and Igbo |
54
- | Release files | `WazoCore-8B.Q4_K_M.gguf` (5.0 GB). Full-precision weights to follow |
55
  | Languages | Yoruba, Hausa, Igbo, English |
56
  | Licence | N-ATLaS Open-Source Research and Innovation License ([details](#licence)) |
57
  | Code and evaluation | [github.com/Quantile-Labs/wazocore](https://github.com/Quantile-Labs/wazocore) |
@@ -65,7 +66,27 @@ tokenisation effectively unchanged.
65
 
66
  ## Usage
67
 
68
- WazoCore is a standard Llama-3 GGUF, validated in llama.cpp and LM Studio.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
69
 
70
  ```sh
71
  hf download quantile-labs/WazoCore-8B WazoCore-8B.Q4_K_M.gguf --local-dir .
@@ -94,11 +115,11 @@ bootstrap confidence intervals.
94
  |---|---|---|---|
95
  | Tokens per word | 2.87 β†’ 1.91 | 2.12 β†’ 1.34 | 2.53 β†’ 1.56 |
96
  | Generation speed-up (words/s), laptop CPU | 1.63Γ— | 1.61Γ— | 1.72Γ— |
97
- | Ξ”chrF++, English β†’ X, Q4_K_M | +3.1 (+2.0, +4.1) | βˆ’0.4 (βˆ’1.2, +0.4) | +0.3 (βˆ’1.3, +1.7) |
98
  | Ξ”chrF++, English β†’ X, held-out | +2.2 (+1.6, +2.8) | βˆ’0.4 (βˆ’0.9, 0.0) | +0.1 (βˆ’0.5, +0.7) |
99
  | Ξ”chrF++, X β†’ English, held-out | +0.2 (βˆ’0.4, +0.7) | βˆ’0.1 (βˆ’0.5, +0.4) | +0.9 (+0.5, +1.4) |
100
- | AfriMGSM accuracy (WazoCore / base) | 37.2 / 33.6 | 40.4 / 38.8 | 26.0 / 28.0 |
101
- | AfriXNLI accuracy (WazoCore / base) | 52.7 / 57.7 | 53.0 / 57.5 | 52.5 / 58.8 |
102
 
103
  - **Speed.** llama.cpp build 9430, Q4_K_M, Apple M4 CPU, 20 prompts per
104
  language, paired and interleaved, measured with the v6 release, which
@@ -108,10 +129,11 @@ bootstrap confidence intervals.
108
  - **Translation, Q4_K_M.** Both quantised models in llama.cpp, 250 NTREX-128
109
  sentences per language.
110
  - **Translation, held-out.** 1,497 NTREX-128 sentences per language reserved
111
- from all training and model-selection decisions, full precision.
 
112
  - **Reasoning.** IrokoBench, zero-shot, chat template, full precision.
113
- Pooled over the three languages: AfriMGSM +1.1 (βˆ’2.3, +4.4), AfriXNLI
114
- βˆ’5.3 (βˆ’7.4, βˆ’3.1).
115
 
116
  Full protocol and reproduction commands:
117
  [`docs/METHOD.md`](https://github.com/Quantile-Labs/wazocore/blob/main/docs/METHOD.md).
@@ -143,7 +165,7 @@ FLORES-200 or NTREX-128 are removed.
143
  | Area | Observation | Recommendation |
144
  |---|---|---|
145
  | Natural-language inference | AfriXNLI about 5 points below the base model | Prefer the base model for inference-heavy workloads |
146
- | Output encoding | 1 of 750 test outputs contained an incomplete UTF-8 character | Retry on decode error |
147
  | Dialogue | Not benchmarked; evaluation covers translation and reasoning | Validate on representative prompts before deployment |
148
 
149
  ## Licence
 
5
  base_model_relation: finetune
6
  language: [yo, ha, ig, en]
7
  pipeline_tag: text-generation
8
+ library_name: transformers
9
  datasets: [google/smol, openai/gsm8k]
10
  metrics: [chrf, accuracy]
11
  tags:
 
21
  - llama-3
22
  - llama-cpp
23
  - gguf
24
+ - safetensors
25
  ---
26
 
27
  # WazoCore
 
30
  N-ATLaS with 15,000 additional tokens for the three languages. It encodes
31
  them in roughly a third fewer tokens than its base model, making generation
32
  1.6 to 1.7 times faster on commodity hardware, and is a drop-in replacement
33
+ in Transformers, llama.cpp, LM Studio and OpenAI-compatible stacks.
34
 
35
  This release, v13, supersedes [WazoCore v6](https://huggingface.co/quantile-labs/WazoCore-8B-v6-long).
36
  It retains v6's efficiency and translation quality and recovers most of the
 
38
 
39
  | Change from v6 | v6 | v13 |
40
  |---|---|---|
41
+ | Mathematical reasoning (AfriMGSM), vs base model | βˆ’11.6 | +0.9 (βˆ’2.3, +4.3) |
42
+ | Natural-language inference (AfriXNLI), vs base model | βˆ’7.5 | βˆ’4.8 |
43
+ | Degenerate repetition, 750 test translations | 5 | 0 |
44
+ | Truncated outputs, 750 test translations | 11 | 5 |
45
  | Decomposed Unicode input | efficiency lost | normalised (NFC) |
46
 
47
  ## Model details
 
52
  | Base model | NCAIR1/N-ATLaS (Llama-3 architecture, 8B parameters) |
53
  | Licensed name | WazoCore Powered by Awarri. |
54
  | Vocabulary | 143,256 tokens: the base model's 128,256, unchanged in id and embedding, plus 15,000 for Yoruba, Hausa and Igbo |
55
+ | Release files | `model.safetensors` (BF16, 16.3 GB) with tokenizer and configuration; `WazoCore-8B.Q4_K_M.gguf` (5.0 GB) |
56
  | Languages | Yoruba, Hausa, Igbo, English |
57
  | Licence | N-ATLaS Open-Source Research and Innovation License ([details](#licence)) |
58
  | Code and evaluation | [github.com/Quantile-Labs/wazocore](https://github.com/Quantile-Labs/wazocore) |
 
66
 
67
  ## Usage
68
 
69
+ **Transformers.** The repository is a standard `LlamaForCausalLM`
70
+ checkpoint; the tokenizer applies NFC normalisation automatically.
71
+
72
+ ```sh
73
+ pip install transformers accelerate
74
+ ```
75
+
76
+ ```python
77
+ from transformers import AutoModelForCausalLM, AutoTokenizer
78
+
79
+ repo = "quantile-labs/WazoCore-8B"
80
+ tok = AutoTokenizer.from_pretrained(repo)
81
+ model = AutoModelForCausalLM.from_pretrained(repo, dtype="bfloat16", device_map="auto")
82
+
83
+ messages = [{"role": "user", "content": "Translate into Hausa: The clinic opens at eight in the morning."}]
84
+ inputs = tok.apply_chat_template(messages, add_generation_prompt=True, return_dict=True, return_tensors="pt").to(model.device)
85
+ out = model.generate(**inputs, max_new_tokens=128)
86
+ print(tok.decode(out[0, inputs["input_ids"].shape[1]:], skip_special_tokens=True))
87
+ ```
88
+
89
+ **llama.cpp.** The GGUF is validated in llama.cpp and LM Studio.
90
 
91
  ```sh
92
  hf download quantile-labs/WazoCore-8B WazoCore-8B.Q4_K_M.gguf --local-dir .
 
115
  |---|---|---|---|
116
  | Tokens per word | 2.87 β†’ 1.91 | 2.12 β†’ 1.34 | 2.53 β†’ 1.56 |
117
  | Generation speed-up (words/s), laptop CPU | 1.63Γ— | 1.61Γ— | 1.72Γ— |
118
+ | Ξ”chrF++, English β†’ X, Q4_K_M | +3.4 (+2.2, +4.6) | βˆ’0.6 (βˆ’1.5, +0.3) | +0.1 (βˆ’1.3, +1.3) |
119
  | Ξ”chrF++, English β†’ X, held-out | +2.2 (+1.6, +2.8) | βˆ’0.4 (βˆ’0.9, 0.0) | +0.1 (βˆ’0.5, +0.7) |
120
  | Ξ”chrF++, X β†’ English, held-out | +0.2 (βˆ’0.4, +0.7) | βˆ’0.1 (βˆ’0.5, +0.4) | +0.9 (+0.5, +1.4) |
121
+ | AfriMGSM accuracy (WazoCore / base) | 37.2 / 33.6 | 40.4 / 38.8 | 25.6 / 28.0 |
122
+ | AfriXNLI accuracy (WazoCore / base) | 52.3 / 57.7 | 54.2 / 57.5 | 53.0 / 58.8 |
123
 
124
  - **Speed.** llama.cpp build 9430, Q4_K_M, Apple M4 CPU, 20 prompts per
125
  language, paired and interleaved, measured with the v6 release, which
 
129
  - **Translation, Q4_K_M.** Both quantised models in llama.cpp, 250 NTREX-128
130
  sentences per language.
131
  - **Translation, held-out.** 1,497 NTREX-128 sentences per language reserved
132
+ from all training and model-selection decisions, full precision, measured on the
133
+ model-selection run of the same recipe.
134
  - **Reasoning.** IrokoBench, zero-shot, chat template, full precision.
135
+ Pooled over the three languages: AfriMGSM +0.9 (βˆ’2.3, +4.3), AfriXNLI
136
+ βˆ’4.8 (βˆ’6.9, βˆ’2.7).
137
 
138
  Full protocol and reproduction commands:
139
  [`docs/METHOD.md`](https://github.com/Quantile-Labs/wazocore/blob/main/docs/METHOD.md).
 
165
  | Area | Observation | Recommendation |
166
  |---|---|---|
167
  | Natural-language inference | AfriXNLI about 5 points below the base model | Prefer the base model for inference-heavy workloads |
168
+ | Output encoding | None of 750 test outputs; one incomplete UTF-8 character was seen in an earlier build | Retry on decode error |
169
  | Dialogue | Not benchmarked; evaluation covers translation and reasoning | Validate on representative prompts before deployment |
170
 
171
  ## Licence