Update README.md

README.md

@@ -10,12 +10,87 @@ language:
 - en
 ---
 
-# Uploaded finetuned  model
+# Opani Coder 1B (16-bit)
 
-- **Developed by:** michsethowusu
-- **License:** apache-2.0
-- **Finetuned from model :** unsloth/llama-3.2-1b-instruct-unsloth-bnb-4bit
+A fine-tuned Llama 3.2 1B model for coding assistance in Twi (Akan language), helping Twi speakers learn programming in their native language.
 
-This llama model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
+## Model Details
 
-[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
+- **Base Model**: Llama 3.2 1B
+- **Precision**: 16-bit full model
+- **Language**: Twi with code examples
+- **Fine-tuning**: Full model fine-tuning
+- **Developed by**: michsethowusu
+
+## Installation
+
+```bash
+pip install torch transformers
+```
+
+## Usage
+
+```python
+from transformers import AutoTokenizer, AutoModelForCausalLM, TextStreamer
+import torch
+
+# Load model
+model_id = "michsethowusu/opani-coder_1b-merged-16bit"
+
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+model = AutoModelForCausalLM.from_pretrained(
+    model_id,
+    torch_dtype=torch.float16,
+    device_map="auto",
+)
+
+# Prepare message
+messages = [
+    {"role": "user", "content": "Kyerɛkyerɛ nea for loop yɛ"}
+]
+
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True,
+)
+
+# Generate response
+streamer = TextStreamer(tokenizer, skip_prompt=True)
+_ = model.generate(
+    **tokenizer(text, return_tensors="pt").to(model.device),
+    max_new_tokens=512,
+    temperature=0.7,
+    top_p=0.9,
+    streamer=streamer,
+)
+```
+
+## Use Cases
+
+- Explaining programming concepts in Twi
+- Code generation with Twi commentary
+- Debugging assistance in Twi
+- Translating coding tutorials to Twi
+
+## Limitations
+
+- Optimized for Twi language programming interactions
+- May mix English technical terms
+- Verify generated code before production use
+
+## Citation
+
+```bibtex
+@misc{opani-coder_1b_2024,
+  author = {michsethowusu},
+  title = {Opani Coder 1B: Fine-tuned Llama 3.2 1B for Twi Coding Assistance},
+  year = {2024},
+  publisher = {HuggingFace},
+  url = {https://huggingface.co/michsethowusu/opani-coder_1b-merged-16bit}
+}
+```
+
+## Contact
+
+- HuggingFace: @michsethowusu