Update README.md

README.md

@@ -1,33 +1,32 @@
 ---
+
 license: apache-2.0
 language: c++
 tags:
-  - code-generation
-  - codellama
-  - peft
-  - unit-tests
-  - causal-lm
-  - text-generation
+- code-generation
+- codellama
+- peft
+- unit-tests
+- causal-lm
+- text-generation
+- embedded-systems
 base_model: codellama/CodeLlama-7b-hf
 model_type: llama
 pipeline_tag: text-generation
 ---
-
 # 🧪 CodeLLaMA Unit Test Generator — Full Merged Model (v2)
 
-This is a **merged model** that combines [`codellama/CodeLlama-7b-hf`](https://huggingface.co/codellama/CodeLlama-7b-hf) with a LoRA adapter fine-tuned on embedded C/C++ code and high-quality unit tests using GoogleTest and CppUTest. This version includes enhanced formatting, stop tokens, and test cleanup mechanisms.
+This is a **merged model** that combines [`codellama/CodeLlama-7b-hf`](https://huggingface.co/codellama/CodeLlama-7b-hf) with a LoRA adapter 
+fine-tuned on embedded C/C++ code and high-quality unit tests using GoogleTest and CppUTest. This version includes enhanced formatting, stop tokens, 
+and test cleanup mechanisms.
 
-> ✅ Trained to generate only test cases, no headers, no `main()`, and uses `// END_OF_TESTS` token to denote completion.
 
 ---
 
 ## 🎯 Use Cases
 
-- 🧪 Generate comprehensive unit tests for embedded C/C++ functions
-- ✅ Focus on edge cases, boundaries, error handling
-- ⚠️ Ensure MISRA-C compliance (if trained accordingly)
-- 📏 Automatically remove boilerplate and focus on `TEST(...)` blocks
-
+-  Generate comprehensive unit tests for embedded C/C++ functions
+-  Focus on edge cases, boundaries, error handling
 ---
 
 ## 🧠 Training Summary
@@ -69,3 +68,41 @@ int add(int a, int b) { return a + b; }
 inputs = tokenizer(prompt, return_tensors="pt").to("cuda")
 outputs = model.generate(**inputs, max_new_tokens=512, eos_token_id=tokenizer.convert_tokens_to_ids("// END_OF_TESTS"))
 print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+```
+
+
+##  Training & Optimization Details
+
+| Step                | Description                                                                 |
+|---------------------|-----------------------------------------------------------------------------|
+| **Dataset**         | athrv/Embedded_Unittest2 (filtered for valid code-test pairs)               |
+| **Preprocessing**   | Token length filtering (≤4096), special token injection                     |
+| **Quantization**    | 8-bit (BitsAndBytesConfig), llm_int8_threshold=6.0                         |
+| **LoRA Config**     | r=64, alpha=32, dropout=0.1 on q_proj/v_proj/k_proj/o_proj                 |
+| **Training**        | 4 epochs, batch=4 (effective 8), lr=2e-4, FP16                             |
+| **Optimization**    | Paged AdamW 8-bit, gradient checkpointing, custom data collator            |
+| **Special Tokens**  | Added `<|system|>`, `<|user|>`, `<|assistant|>`                            |
+
+---
+
+##  Tips for Best Results
+
+- **Temperature:** 0.2–0.4  
+- **Top-p:** 0.85–0.95  
+- **Max New Tokens:** 256–512-1024-2048  
+- **Input Formatting:**
+  - Include complete function signatures
+  - Remove unnecessary comments
+  - Keep functions under 200 lines
+  - For long functions, split into logical units
+
+---
+
+##  Feedback & Citation
+
+**Dataset Credit:** `athrv/Embedded_Unittest2`  
+**Report Issues:** [Model's Hugging Face page](https://huggingface.co/Utkarsh524/codellama_utests_full_new_ver2)
+
+**Maintainer:** Utkarsh524  
+**Model Version:** v2 (4-epoch trained)
+---