amkyawdev commited on
Commit
76918e4
Β·
verified Β·
1 Parent(s): a0d6b29

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +23 -25
README.md CHANGED
@@ -1,12 +1,16 @@
1
  # 🧠 Myanmar LLM Training
2
 
3
- Fine-tune **Llama-3.1-8B-Instruct** with Myanmar language dataset.
 
 
 
 
4
 
5
  ## πŸ“‹ Requirements
6
 
7
  - Python 3.8+
8
- - GPU with 16GB+ VRAM (recommended)
9
- - HuggingFace Account with Llama access
10
 
11
  ## πŸš€ Quick Start
12
 
@@ -18,11 +22,8 @@ pip install -r requirements.txt
18
  ### 2. Login to HuggingFace
19
  ```bash
20
  huggingface-cli login
21
- # Enter your token
22
  ```
23
 
24
- **Note:** Llama requires accepting the license at https://huggingface.co/meta-llama/Llama-3.1-8B-Instruct
25
-
26
  ### 3. Run training
27
  ```bash
28
  python train.py
@@ -32,45 +33,47 @@ python train.py
32
 
33
  | Parameter | Default | Description |
34
  |-----------|---------|-------------|
35
- | MODEL_NAME | meta-llama/Llama-3.1-8B-Instruct | Base model |
36
  | num_train_epochs | 3 | Training iterations |
37
- | per_device_train_batch_size | 2 | Batch size (4-bit) |
38
- | gradient_accumulation_steps | 8 | Effective batch |
39
- | learning_rate | 1e-5 | Learning rate |
40
 
41
  ## πŸ“Š Features
42
 
43
- - βœ… 4-bit quantization (NF4) - α€‘α€”α€Šα€Ία€Έα€†α€―α€Άα€Έ VRAM α€”α€²α€· run α€œα€―α€•α€Ία€”α€­α€―α€„α€Ία€•α€«α€žα€Šα€Ία‹
 
44
  - βœ… Gradient checkpointing - Memory α€α€»α€½α€±α€α€¬α€•α€«α€žα€Šα€Ία‹
45
  - βœ… Test/Validation evaluation - α€”α€Ύα€…α€Ία€α€―α€œα€―α€Άα€Έα€‘α€α€½α€€α€Ί α€…α€™α€Ία€Έα€žα€•α€Ία€•α€«α€žα€Šα€Ία‹
46
- - βœ… BF16 mixed precision - ပိုမိုတိကျတဲ့ training။
47
 
48
  ## πŸ“Š Training Data
49
 
50
- Dataset: [amkyawdev/myanmar-llm-data](https://huggingface.co/datasets/amkyawdev/myanmar-llm-data)
51
 
52
  | Split | Samples |
53
  |-------|---------|
54
- | Train | 1000 |
55
- | Validation | 1000 |
56
- | Test | 1000 |
 
 
57
 
58
  ## πŸ’Ύ Output
59
 
60
- Trained model saved to `./myanmar-llama-output/`
61
 
62
  ## πŸ“€ Upload to HuggingFace
63
 
64
  ```bash
65
- cd myanmar-llama-output
66
- huggingface-cli upload amkyawdev/my-myanmar-llama . --repo-type model
67
  ```
68
 
69
  ## πŸ–₯️ Google Colab
70
 
71
  ```python
72
  # Install
73
- !pip install transformers datasets torch bitsandbytes accelerate
74
 
75
  # Login
76
  from huggingface_hub import login
@@ -80,10 +83,5 @@ login("YOUR_TOKEN")
80
  %run train.py
81
  ```
82
 
83
- ## ⚠️ Important
84
-
85
- 1. Llama license α€œα€­α€―α€•α€«α€žα€Šα€Ία‹ https://huggingface.co/meta-llama/Llama-3.1-8B-Instruct မှာ Accept α€œα€―α€•α€Ία€•α€«α€žα€Šα€Ία‹
86
- 2. Token မှာLlama access α€›α€Ύα€­α€›α€•α€«α€žα€Šα€Ία‹
87
-
88
  ---
89
  Built by amkyawdev
 
1
  # 🧠 Myanmar LLM Training
2
 
3
+ Fine-tune **Qwen2.5-0.5B-Instruct** with Myanmar language dataset.
4
+
5
+ ## ⚑ No License Required!
6
+
7
+ This model is fully open. No Llama license needed!
8
 
9
  ## πŸ“‹ Requirements
10
 
11
  - Python 3.8+
12
+ - GPU with 6GB+ VRAM
13
+ - HuggingFace Account
14
 
15
  ## πŸš€ Quick Start
16
 
 
22
  ### 2. Login to HuggingFace
23
  ```bash
24
  huggingface-cli login
 
25
  ```
26
 
 
 
27
  ### 3. Run training
28
  ```bash
29
  python train.py
 
33
 
34
  | Parameter | Default | Description |
35
  |-----------|---------|-------------|
36
+ | MODEL_NAME | Qwen/Qwen2.5-0.5B-Instruct | Base model (fully open!) |
37
  | num_train_epochs | 3 | Training iterations |
38
+ | per_device_train_batch_size | 4 | Batch size |
39
+ | gradient_accumulation_steps | 4 | Effective batch = 16 |
40
+ | learning_rate | 2e-5 | Learning rate |
41
 
42
  ## πŸ“Š Features
43
 
44
+ - βœ… Fully open model - α€œα€­α€―α€„α€Ία€…α€„α€Ία€™α€œα€­α€―α€•α€«α€žα€Šα€Ία‹
45
+ - βœ… FP16 precision - α€•α€­α€―α€™α€­α€―α€™α€Όα€”α€Ία€•α€«α€žα€Šα€Ία‹
46
  - βœ… Gradient checkpointing - Memory α€α€»α€½α€±α€α€¬α€•α€«α€žα€Šα€Ία‹
47
  - βœ… Test/Validation evaluation - α€”α€Ύα€…α€Ία€α€―α€œα€―α€Άα€Έα€‘α€α€½α€€α€Ί α€…α€™α€Ία€Έα€žα€•α€Ία€•α€«α€žα€Šα€Ία‹
 
48
 
49
  ## πŸ“Š Training Data
50
 
51
+ Dataset: [amkyawdev/AmkyawDev-Dataset](https://huggingface.co/datasets/amkyawdev/AmkyawDev-Dataset)
52
 
53
  | Split | Samples |
54
  |-------|---------|
55
+ | Train | ~29,100 |
56
+ | Validation | ~29,100 |
57
+ | Test | ~29,100 |
58
+
59
+ > **Note:** Each file (train.jsonl, test.jsonl, validation.jsonl) has ~29,100 conversations!
60
 
61
  ## πŸ’Ύ Output
62
 
63
+ Trained model saved to `./myanmar-qwen-output/`
64
 
65
  ## πŸ“€ Upload to HuggingFace
66
 
67
  ```bash
68
+ cd myanmar-qwen-output
69
+ huggingface-cli upload amkyawdev/my-myanmar-qwen . --repo-type model
70
  ```
71
 
72
  ## πŸ–₯️ Google Colab
73
 
74
  ```python
75
  # Install
76
+ !pip install transformers datasets torch accelerate
77
 
78
  # Login
79
  from huggingface_hub import login
 
83
  %run train.py
84
  ```
85
 
 
 
 
 
 
86
  ---
87
  Built by amkyawdev