mueggi commited on
Commit
34588bb
·
verified ·
1 Parent(s): ba430a9

Add generation config (stop at <|im_end|>) + model card

Browse files
Files changed (2) hide show
  1. README.md +75 -198
  2. generation_config.json +14 -0
README.md CHANGED
@@ -1,207 +1,84 @@
1
  ---
 
 
 
 
 
 
 
 
 
 
2
  base_model: google/gemma-2-9b
3
- library_name: peft
4
  pipeline_tag: text-generation
5
- tags:
6
- - base_model:adapter:google/gemma-2-9b
7
- - lora
8
- - transformers
9
  ---
10
 
11
- # Model Card for Model ID
12
-
13
- <!-- Provide a quick summary of what the model is/does. -->
14
-
15
 
 
16
 
17
  ## Model Details
18
 
19
- ### Model Description
20
-
21
- <!-- Provide a longer summary of what this model is. -->
22
-
23
-
24
-
25
- - **Developed by:** [More Information Needed]
26
- - **Funded by [optional]:** [More Information Needed]
27
- - **Shared by [optional]:** [More Information Needed]
28
- - **Model type:** [More Information Needed]
29
- - **Language(s) (NLP):** [More Information Needed]
30
- - **License:** [More Information Needed]
31
- - **Finetuned from model [optional]:** [More Information Needed]
32
-
33
- ### Model Sources [optional]
34
-
35
- <!-- Provide the basic links for the model. -->
36
-
37
- - **Repository:** [More Information Needed]
38
- - **Paper [optional]:** [More Information Needed]
39
- - **Demo [optional]:** [More Information Needed]
40
-
41
- ## Uses
42
-
43
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
44
-
45
- ### Direct Use
46
-
47
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
48
-
49
- [More Information Needed]
50
-
51
- ### Downstream Use [optional]
52
-
53
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
54
-
55
- [More Information Needed]
56
-
57
- ### Out-of-Scope Use
58
-
59
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
60
-
61
- [More Information Needed]
62
-
63
- ## Bias, Risks, and Limitations
64
-
65
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
66
-
67
- [More Information Needed]
68
-
69
- ### Recommendations
70
-
71
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
72
-
73
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
74
-
75
- ## How to Get Started with the Model
76
-
77
- Use the code below to get started with the model.
78
-
79
- [More Information Needed]
80
-
81
- ## Training Details
82
-
83
- ### Training Data
84
-
85
- <!-- 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. -->
86
-
87
- [More Information Needed]
88
-
89
- ### Training Procedure
90
-
91
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
92
-
93
- #### Preprocessing [optional]
94
-
95
- [More Information Needed]
96
-
97
-
98
- #### Training Hyperparameters
99
-
100
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
101
-
102
- #### Speeds, Sizes, Times [optional]
103
-
104
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
105
-
106
- [More Information Needed]
107
-
108
- ## Evaluation
109
-
110
- <!-- This section describes the evaluation protocols and provides the results. -->
111
-
112
- ### Testing Data, Factors & Metrics
113
-
114
- #### Testing Data
115
-
116
- <!-- This should link to a Dataset Card if possible. -->
117
-
118
- [More Information Needed]
119
-
120
- #### Factors
121
-
122
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
123
-
124
- [More Information Needed]
125
-
126
- #### Metrics
127
-
128
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
129
-
130
- [More Information Needed]
131
-
132
- ### Results
133
-
134
- [More Information Needed]
135
-
136
- #### Summary
137
-
138
-
139
-
140
- ## Model Examination [optional]
141
-
142
- <!-- Relevant interpretability work for the model goes here -->
143
-
144
- [More Information Needed]
145
-
146
- ## Environmental Impact
147
-
148
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
149
-
150
- 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).
151
-
152
- - **Hardware Type:** [More Information Needed]
153
- - **Hours used:** [More Information Needed]
154
- - **Cloud Provider:** [More Information Needed]
155
- - **Compute Region:** [More Information Needed]
156
- - **Carbon Emitted:** [More Information Needed]
157
-
158
- ## Technical Specifications [optional]
159
-
160
- ### Model Architecture and Objective
161
-
162
- [More Information Needed]
163
-
164
- ### Compute Infrastructure
165
-
166
- [More Information Needed]
167
-
168
- #### Hardware
169
-
170
- [More Information Needed]
171
-
172
- #### Software
173
-
174
- [More Information Needed]
175
-
176
- ## Citation [optional]
177
-
178
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
179
-
180
- **BibTeX:**
181
-
182
- [More Information Needed]
183
-
184
- **APA:**
185
-
186
- [More Information Needed]
187
-
188
- ## Glossary [optional]
189
-
190
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
191
-
192
- [More Information Needed]
193
-
194
- ## More Information [optional]
195
-
196
- [More Information Needed]
197
-
198
- ## Model Card Authors [optional]
199
-
200
- [More Information Needed]
201
-
202
- ## Model Card Contact
203
-
204
- [More Information Needed]
205
- ### Framework versions
206
-
207
- - PEFT 0.18.1
 
1
  ---
2
+ language:
3
+ - ka
4
+ - en
5
+ license: apache-2.0
6
+ tags:
7
+ - georgian
8
+ - gemma2
9
+ - lora
10
+ - sft
11
+ - instruction-tuned
12
  base_model: google/gemma-2-9b
 
13
  pipeline_tag: text-generation
 
 
 
 
14
  ---
15
 
16
+ # ka-ai-instruct Georgian Instruction-Tuned LLM
 
 
 
17
 
18
+ The first open-source instruction-tuned LLM optimized for Georgian language.
19
 
20
  ## Model Details
21
 
22
+ - **Base model**: Google Gemma 2 9B
23
+ - **Training**: Continual pretraining on 5M Georgian documents + SFT on 15K instruction examples
24
+ - **Architecture**: QLoRA adapter (r=32, 4 attention modules)
25
+ - **Tokenizer**: Extended with +10K Georgian tokens (265K total vocab)
26
+ - **Training loss**: 0.92
27
+
28
+ ## Usage
29
+
30
+ ```python
31
+ from transformers import AutoTokenizer, AutoModelForCausalLM, BitsAndBytesConfig
32
+ from peft import PeftModel
33
+ import torch
34
+
35
+ # Load base + adapter
36
+ bnb_config = BitsAndBytesConfig(load_in_4bit=True, bnb_4bit_compute_dtype=torch.float16)
37
+ base = AutoModelForCausalLM.from_pretrained("google/gemma-2-9b", quantization_config=bnb_config, device_map="auto")
38
+ tokenizer = AutoTokenizer.from_pretrained("mueggi/ka-ai-tokenizer")
39
+ base.resize_token_embeddings(len(tokenizer), mean_resizing=False)
40
+ model = PeftModel.from_pretrained(base, "mueggi/ka-ai-instruct")
41
+
42
+ # Chat
43
+ messages = [{"role": "user", "content": "რა არის საქართველოს დედაქალაქი?"}]
44
+ template = "{% for message in messages %}<|im_start|>{{ message.role }}\n{{ message.content }}<|im_end|>\n{% endfor %}<|im_start|>assistant\n"
45
+ tokenizer.chat_template = template
46
+ text = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
47
+ inputs = tokenizer(text, return_tensors="pt").to(model.device)
48
+ out = model.generate(**inputs, max_new_tokens=256, do_sample=True, temperature=0.7,
49
+ stop_strings=["<|im_end|>"], tokenizer=tokenizer)
50
+ print(tokenizer.decode(out[0][inputs["input_ids"].shape[1]:], skip_special_tokens=True))
51
+ ```
52
+
53
+ ## Capabilities
54
+
55
+ | Task | Quality |
56
+ |------|---------|
57
+ | Georgian QA | ⭐⭐⭐⭐ |
58
+ | Georgian fluency | ⭐⭐⭐⭐ |
59
+ | KA→EN translation | ⭐⭐⭐⭐ |
60
+ | EN→KA translation | ⭐⭐ |
61
+ | Creative writing | ⭐⭐⭐⭐ |
62
+
63
+ ## Training Data
64
+
65
+ - **Pretraining**: 5.1M Georgian documents (C4, HPLT, Wikipedia, news)
66
+ - **SFT**: 15K examples sampled from 103K (hand-crafted + Kona SFT + translation pairs)
67
+ - **Format**: ChatML
68
+
69
+ ## Limitations
70
+
71
+ - Trained with max 256 token sequences (hardware constraint) — may truncate long responses
72
+ - EN→KA translation needs improvement
73
+ - Can hallucinate facts
74
+ - Stop token (`<|im_end|>`) requires `stop_strings` parameter in generation
75
+
76
+ ## Future
77
+
78
+ - Full 103K SFT dataset with 1024 seq_len (pending better hardware)
79
+ - DPO alignment with 387K preference pairs
80
+ - Larger base models (27B, 70B)
81
+
82
+ ## License
83
+
84
+ Apache 2.0 (same as Gemma 2)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
generation_config.json ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_from_model_config": false,
3
+ "bos_token_id": 2,
4
+ "eos_token_id": 1,
5
+ "max_new_tokens": 512,
6
+ "do_sample": true,
7
+ "temperature": 0.7,
8
+ "top_p": 0.9,
9
+ "repetition_penalty": 1.1,
10
+ "stop_strings": [
11
+ "<|im_end|>"
12
+ ],
13
+ "transformers_version": "4.48.0"
14
+ }