Update README.md

README.md

@@ -1,22 +1,72 @@
 ---
 base_model: unsloth/csm-1b
 tags:
-- text-generation-inference
+- text-to-speech
 - transformers
 - unsloth
 - csm
 - trl
+- lora
+- finetuning
 license: apache-2.0
 language:
 - en
+datasets:
+- TurkishCodeMan/tts-medium-clean
+pipeline_tag: text-to-speech
 ---
 
-# Uploaded  model
+# TurkishCodeMan - CSM-1B (LoRA Fine-tuned)
 
-- **Developed by:** TurkishCodeMan
-- **License:** apache-2.0
-- **Finetuned from model :** unsloth/csm-1b
+## 📌 Model Summary
+This is a **LoRA fine-tuned** version of [unsloth/csm-1b](https://huggingface.co/unsloth/csm-1b), trained for **text-to-speech (TTS)** tasks.  
+The model was trained using [Unsloth](https://github.com/unslothai/unsloth) for 2x faster finetuning and Hugging Face’s [TRL](https://huggingface.co/docs/trl/index) library.
 
-This csm model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
+- **Base Model:** `unsloth/csm-1b`  
+- **Fine-tuning Method:** LoRA  
+- **Training Frameworks:** Unsloth, TRL  
+- **Dataset:** [TurkishCodeMan/tts-medium-clean](https://huggingface.co/datasets/TurkishCodeMan/tts-medium-clean)  
+- **Languages:** English, Turkish  
+- **License:** Apache-2.0  
 
-[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
+---
+
+## 🚀 Intended Use
+- Convert text to high-quality speech.
+- Research and experimentation in TTS models.
+- Transfer learning and downstream fine-tuning.
+
+⚠️ **Not intended** for harmful or malicious use (hate speech, deepfakes, etc.).
+
+---
+
+## 🛠️ Training Details
+- **Method:** LoRA low-rank adaptation on transformer layers.  
+- **Batch Size:** 16 (8 × gradient_accumulation=2).  
+- **Epochs:** 3  
+- **Trainable Parameters:** ~29M of 1.66B (≈1.75% trained).  
+- **Hardware:** 1x GPU.  
+- **Optimizer:** AdamW.  
+- **Learning Rate Schedule:** Linear decay with warmup.  
+
+---
+
+## 📊 Dataset
+The model was fine-tuned on **[TurkishCodeMan/tts-medium-clean](https://huggingface.co/datasets/TurkishCodeMan/tts-medium-clean)**.  
+This dataset contains clean speech-text pairs suitable for TTS tasks.
+
+---
+
+## 🔧 How to Use
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model = AutoModelForCausalLM.from_pretrained("TurkishCodeMan/csm-1b-tts-lora")
+tokenizer = AutoTokenizer.from_pretrained("TurkishCodeMan/csm-1b-tts-lora")
+
+text = "Hi !"
+inputs = tokenizer(text, return_tensors="pt")
+
+outputs = model.generate(**inputs, max_new_tokens=200)
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))