amkyawdev commited on
Commit
df2fd27
·
verified ·
1 Parent(s): e7c9932

Update README.md with model details

Browse files
Files changed (1) hide show
  1. README.md +99 -174
README.md CHANGED
@@ -17,197 +17,122 @@ language:
17
  metrics:
18
  - accuracy
19
  ---
20
- # Model Card for Model ID
21
-
22
- <!-- Provide a quick summary of what the model is/does. -->
23
-
24
-
25
 
26
  ## Model Details
27
 
28
  ### Model Description
29
-
30
- <!-- Provide a longer summary of what this model is. -->
31
-
32
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
33
-
34
- - **Developed by:** [More Information Needed]
35
- - **Funded by [optional]:** [More Information Needed]
36
- - **Shared by [optional]:** [More Information Needed]
37
- - **Model type:** [More Information Needed]
38
- - **Language(s) (NLP):** [More Information Needed]
39
- - **License:** [More Information Needed]
40
- - **Finetuned from model [optional]:** [More Information Needed]
41
-
42
- ### Model Sources [optional]
43
-
44
- <!-- Provide the basic links for the model. -->
45
-
46
- - **Repository:** [More Information Needed]
47
- - **Paper [optional]:** [More Information Needed]
48
- - **Demo [optional]:** [More Information Needed]
49
-
50
- ## Uses
51
-
52
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
53
-
54
- ### Direct Use
55
-
56
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
57
-
58
- [More Information Needed]
59
-
60
- ### Downstream Use [optional]
61
-
62
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
63
-
64
- [More Information Needed]
65
-
66
- ### Out-of-Scope Use
67
-
68
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
69
-
70
- [More Information Needed]
71
-
72
- ## Bias, Risks, and Limitations
73
-
74
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
75
-
76
- [More Information Needed]
77
-
78
- ### Recommendations
79
-
80
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
81
-
82
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
83
-
84
- ## How to Get Started with the Model
85
-
86
- Use the code below to get started with the model.
87
-
88
- [More Information Needed]
89
 
90
  ## Training Details
91
 
92
  ### Training Data
 
 
93
 
94
- <!-- 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. -->
95
-
96
- [More Information Needed]
97
-
98
- ### Training Procedure
99
-
100
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
101
-
102
- #### Preprocessing [optional]
103
-
104
- [More Information Needed]
105
-
106
-
107
- #### Training Hyperparameters
108
-
109
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
110
-
111
- #### Speeds, Sizes, Times [optional]
112
-
113
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
114
 
115
- [More Information Needed]
116
-
117
- ## Evaluation
118
-
119
- <!-- This section describes the evaluation protocols and provides the results. -->
120
-
121
- ### Testing Data, Factors & Metrics
122
-
123
- #### Testing Data
124
-
125
- <!-- This should link to a Dataset Card if possible. -->
126
-
127
- [More Information Needed]
128
-
129
- #### Factors
130
-
131
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
132
-
133
- [More Information Needed]
134
-
135
- #### Metrics
136
-
137
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
138
-
139
- [More Information Needed]
140
 
141
- ### Results
 
142
 
143
- [More Information Needed]
 
 
144
 
145
- #### Summary
 
 
 
 
 
 
 
 
146
 
 
 
 
 
147
 
 
148
 
149
- ## Model Examination [optional]
 
150
 
151
- <!-- Relevant interpretability work for the model goes here -->
 
 
 
152
 
153
- [More Information Needed]
 
 
 
 
154
 
155
  ## Environmental Impact
156
-
157
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
158
-
159
- 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).
160
-
161
- - **Hardware Type:** [More Information Needed]
162
- - **Hours used:** [More Information Needed]
163
- - **Cloud Provider:** [More Information Needed]
164
- - **Compute Region:** [More Information Needed]
165
- - **Carbon Emitted:** [More Information Needed]
166
-
167
- ## Technical Specifications [optional]
168
-
169
- ### Model Architecture and Objective
170
-
171
- [More Information Needed]
172
-
173
- ### Compute Infrastructure
174
-
175
- [More Information Needed]
176
-
177
- #### Hardware
178
-
179
- [More Information Needed]
180
-
181
- #### Software
182
-
183
- [More Information Needed]
184
-
185
- ## Citation [optional]
186
-
187
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
188
-
189
- **BibTeX:**
190
-
191
- [More Information Needed]
192
-
193
- **APA:**
194
-
195
- [More Information Needed]
196
-
197
- ## Glossary [optional]
198
-
199
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
200
-
201
- [More Information Needed]
202
-
203
- ## More Information [optional]
204
-
205
- [More Information Needed]
206
-
207
- ## Model Card Authors [optional]
208
-
209
- [More Information Needed]
210
-
211
- ## Model Card Contact
212
-
213
- [More Information Needed]
 
17
  metrics:
18
  - accuracy
19
  ---
20
+ # Model Card for amk-coder-v2
 
 
 
 
21
 
22
  ## Model Details
23
 
24
  ### Model Description
25
+ Myanmar-localized coding agent model fine-tuned from Qwen/Qwen2.5-Coder-1.5B using LoRA (PEFT). Designed for code generation and coding assistance in Myanmar language context.
26
+
27
+ - **Developed by:** amkyawdev
28
+ - **Model type:** Language Model (LLM)
29
+ - **Language(s) (NLP):** Myanmar (my), English (en)
30
+ - **License:** Apache-2.0
31
+ - **Finetuned from model:** Qwen/Qwen2.5-Coder-1.5B
32
+
33
+ ### Model Sources
34
+ - **Repository:** [amkyawdev/amk-coder-v2](https://huggingface.co/amkyawdev/amk-coder-v2)
35
+ - **Dataset:** [amkyawdev/mm-llm-coder-agent-dataset](https://huggingface.co/datasets/amkyawdev/mm-llm-coder-agent-dataset)
36
+
37
+ ## Model Configuration
38
+
39
+ | Parameter | Value |
40
+ |-----------|-------|
41
+ | Base Model | Qwen/Qwen2.5-Coder-1.5B |
42
+ | Fine-tuning Method | LoRA (PEFT) |
43
+ | Target Modules | q_proj, k_proj, v_proj, o_proj, gate_proj, up_proj, down_proj |
44
+ | Optimizer | paged_adamw_8bit |
45
+ | Precision | FP16 Mixed Precision |
46
+ | Learning Rate | 3e-5 |
47
+ | Training Infrastructure | Kaggle Cloud (Dual NVIDIA T4 GPUs) |
48
+
49
+ ## Chat Template
50
+
51
+ This model uses the ChatML structure:
52
+
53
+ ```xml
54
+ <|im_start|>system
55
+ You are an expert Myanmar AI coding agent with tool access.<|im_end|>
56
+ <|im_start|>user
57
+ {Instruction}
58
+ Tools available: {Tools}<|im_end|>
59
+ <|im_start|>assistant
60
+ Thought & Code:
61
+ ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
62
 
63
  ## Training Details
64
 
65
  ### Training Data
66
+ - **Dataset:** amkyawdev/mm-llm-coder-agent-dataset
67
+ - **Description:** Myanmar localized coding agent dataset for instruction-tuned code generation
68
 
69
+ ### Training Hyperparameters
70
+ | Parameter | Value |
71
+ |-----------|-------|
72
+ | Precision | FP16 Mixed Precision |
73
+ | Optimizer | paged_adamw_8bit |
74
+ | Learning Rate | 3e-5 |
75
+ | Hardware | Kaggle Cloud (Dual NVIDIA T4 GPUs) |
 
 
 
 
 
 
 
 
 
 
 
 
 
76
 
77
+ ## How to Get Started with the Model
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
78
 
79
+ ```python
80
+ from transformers import AutoModelForCausalLM, AutoTokenizer
81
 
82
+ model_name = "amkyawdev/amk-coder-v2"
83
+ tokenizer = AutoTokenizer.from_pretrained(model_name)
84
+ model = AutoModelForCausalLM.from_pretrained(model_name)
85
 
86
+ # Chat prompt format
87
+ prompt = """<|im_start|>system
88
+ You are an expert Myanmar AI coding agent with tool access.<|im_end|>
89
+ <|im_start|>user
90
+ Write a Python function to add two numbers
91
+ Tools available: python<|im_end|>
92
+ <|im_start|>assistant
93
+ Thought & Code:
94
+ """
95
 
96
+ inputs = tokenizer(prompt, return_tensors="pt")
97
+ outputs = model.generate(**inputs, max_new_tokens=512)
98
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
99
+ ```
100
 
101
+ ## Uses
102
 
103
+ ### Direct Use
104
+ This model can be used for code generation tasks with Myanmar language instructions. Suitable for building coding assistants that understand Burmese/Myanmar language prompts.
105
 
106
+ ### Out-of-Scope Use
107
+ - Not intended for production deployment without fine-tuning
108
+ - Not tested for safety-critical applications
109
+ - May generate incorrect code; always verify outputs
110
 
111
+ ## Bias, Risks, and Limitations
112
+ - Model may generate syntactically incorrect code
113
+ - May not follow security best practices
114
+ - Training data quality affects output quality
115
+ - Myanmar language support may be limited compared to English
116
 
117
  ## Environmental Impact
118
+ - **Hardware Type:** NVIDIA T4 GPUs (Dual)
119
+ - **Cloud Provider:** Kaggle
120
+ - **Training Time:** ~3-5 hours
121
+
122
+ ## Citation
123
+
124
+ If you use this model, please cite:
125
+
126
+ ```
127
+ @misc{amk-coder-v2,
128
+ author = {amkyawdev},
129
+ title = {amk-coder-v2: Myanmar Coding Agent Model},
130
+ year = {2025},
131
+ publisher = {HuggingFace},
132
+ url = {https://huggingface.co/amkyawdev/amk-coder-v2}
133
+ }
134
+ ```
135
+
136
+ ## More Information
137
+ - Dataset: [amkyawdev/mm-llm-coder-agent-dataset](https://huggingface.co/datasets/amkyawdev/mm-llm-coder-agent-dataset)
138
+ - Base Model: [Qwen/Qwen2.5-Coder-1.5B](https://huggingface.co/Qwen/Qwen2.5-Coder-1.5B)