vrashad commited on
Commit
f7cced1
·
verified ·
1 Parent(s): 62fb53f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +77 -170
README.md CHANGED
@@ -1,199 +1,106 @@
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-4.0
3
+ language:
4
+ - en
5
+ - az
6
+ base_model: facebook/nllb-200-3.3B
7
+ pipeline_tag: translation
8
+ tags:
9
+ - translation
10
+ - azerbaijani
11
+ - nllb
12
+ - english-azerbaijani
13
  library_name: transformers
14
+ datasets:
15
+ - LocalDoc/english-azerbaijani-parallel-corpus
16
  ---
17
 
18
+ # NLLB-3.3B English→Azerbaijani
19
 
20
+ A fine-tuned [NLLB-200-3.3B](https://huggingface.co/facebook/nllb-200-3.3B) model for **English→Azerbaijani** translation. It was trained with LoRA on a ~1.4M-pair corpus combining high-quality distilled translations across multiple domains (formal/encyclopedic, instruction-style, dialogue, and conversational registers), then merged into a self-contained model.
21
 
22
+ On a 1,012-sentence FLORES-based benchmark it **outperforms Google Translate and several commercial LLM APIs** on English→Azerbaijani, and approaches the strongest proprietary models — at a fraction of their size and cost.
23
 
24
+ ## Benchmark Results
25
 
26
+ Evaluated on [`LocalDoc/en_az_translate_benchmark`](https://huggingface.co/datasets/LocalDoc/en_az_translate_benchmark) (1,012 sentences, EN→AZ). All metrics are reference-based: chrF++ (`word_order=2`), BLEU (sacreBLEU), and COMET-DA (`Unbabel/wmt22-comet-da`). Higher is better.
27
 
28
+ | Model | chrF++ | BLEU | COMET-DA |
29
+ |---|---|---|---|
30
+ | GPT-5.4-mini | 70.08 | 45.61 | 92.86 |
31
+ | Gemini-2.5-flash | 69.61 | 45.71 | 92.70 |
32
+ | **This model (NLLB-3.3B EN→AZ)** | **69.30** | **44.42** | **92.70** |
33
+ | DeepSeek-V4-Pro | 68.67 | 43.88 | 92.78 |
34
+ | DeepSeek-V4-Flash | 67.96 | 42.82 | 92.58 |
35
+ | GPT-4.1 | 67.76 | 43.03 | 92.71 |
36
+ | Google Translate | 66.90 | 41.64 | 92.37 |
37
+ | Gemma-4-31B-it | 66.22 | 40.46 | 92.40 |
38
+ | GPT-5.4-nano | 62.10 | 33.87 | 91.41 |
39
+ | Qwen3.6-35B-A3B | 60.39 | 33.57 | 91.23 |
40
+ | NLLB-200-3.3B (base, zero-shot) | 59.03 | 31.76 | 89.86 |
41
 
42
+ Fine-tuning improved the base NLLB-3.3B by **+10.3 chrF++** (59.03 → 69.30) and **+2.84 COMET-DA** (89.86 → 92.70). The result surpasses Google Translate, DeepSeek-V4-Pro, GPT-4.1, Gemma-3-31B, and Qwen-35B, and comes within 0.8 chrF++ of GPT-5.4-mini and Gemini-2.5-flash.
43
 
44
+ ## Example Translations
45
 
46
+ A few cases where this model produces more accurate or more natural Azerbaijani than the base NLLB-3.3B and/or Google Translate. Full sentences shown.
 
 
 
 
 
 
47
 
 
48
 
49
+ **EN:** *No worries, take your time. There's really no rush at all.* — idiomatic, not literal
50
+ - **This model:** Narahat olmayın, tələsməyin. Həqiqətən tələsmək lazım deyil.
51
+ - **Google:** Narahat olmayın, tələsməyin. Əslində heç bir tələskənlik yoxdur. — literal and stilted
52
 
53
+ **EN:** *Explain like I'm five: how does the internet actually work?* — natural idiom vs. base
54
+ - **This model:** Beş yaşım varmış kimi izah edin: internet əslində necə işləyir?
55
+ - **Base NLLB-3.3B:** Beş yaşında kimi izah edin: İnternet həqiqətən necə işləyir? — *Beş yaşında kimi* is ungrammatical
56
 
57
+ ## Usage
58
 
59
+ ```python
60
+ import torch
61
+ from transformers import AutoModelForSeq2SeqLM, NllbTokenizer
62
 
63
+ MODEL = "LocalDoc/nllb-3.3b-en-az"
64
+ SRC, TGT = "eng_Latn", "azj_Latn"
65
 
66
+ tokenizer = NllbTokenizer.from_pretrained(MODEL, src_lang=SRC, tgt_lang=TGT)
67
+ model = AutoModelForSeq2SeqLM.from_pretrained(MODEL, torch_dtype=torch.bfloat16).eval()
68
+ bos = tokenizer.convert_tokens_to_ids(TGT)
69
 
70
+ def translate(texts, num_beams=4, max_length=256):
71
+ if isinstance(texts, str):
72
+ texts = [texts]
73
+ tokenizer.src_lang = SRC
74
+ enc = tokenizer(texts, return_tensors="pt", padding=True,
75
+ truncation=True, max_length=max_length)
76
+ with torch.no_grad():
77
+ gen = model.generate(**enc, forced_bos_token_id=bos,
78
+ num_beams=num_beams, max_length=max_length)
79
+ return tokenizer.batch_decode(gen, skip_special_tokens=True)
80
 
81
+ print(translate("The agreement is expected to be signed by the end of the month."))
82
+ ```
83
 
84
+ For best results, translate one sentence at a time (the model is sentence-level). Split long texts into sentences before translating.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
85
 
86
  ## Training Details
87
 
88
+ - **Base model:** facebook/nllb-200-3.3B
89
+ - **Method:** LoRA (r=32, alpha=64) on attention and FFN projections, then merged
90
+ - **Training data:** ~1.4M EN→AZ pairs, distilled and filtered across domains:
91
+ - Formal / encyclopedic / news
92
+ - Instruction-style (assistant tasks, Q&A)
93
+ - Dialogue and conversational speech
94
+ - **Direction:** English → Azerbaijani (direct, no pivot language)
95
+ - **Sequence length:** 256 tokens
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
96
 
97
+ ## Limitations
98
 
99
+ - **Sentence-level:** translate sentence by sentence; long documents should be split first.
100
+ - **Direction:** trained for English→Azerbaijani only.
101
+ - **Rare lexical gaps:** very specialized vocabulary (e.g. exotic culinary terms) may occasionally be less precise than large general-purpose systems.
102
+ - **Latin script:** outputs standard literary Azerbaijani in Latin script (`azj_Latn`).
103
 
104
+ ## Citation
105
 
106
+ If you use this model, please cite the LocalDoc organization on Hugging Face.