Upload README.md with huggingface_hub

README.md

@@ -8,43 +8,56 @@ tags:
 - instruct
 - conversational
 - chatbot
-- türkçe
 - text-generation
 base_model: TURKCELL/Turkcell-LLM-7b-v1
 pipeline_tag: text-generation
 library_name: transformers
 ---
 
-# Turkish-LLM-7B-Instruct 🇹🇷
+# Turkish-LLM-7B-Instruct
 
 The first open-source instruction-tuned Turkish language model at 7B scale.
 
-[![Model on HF](https://huggingface.co/datasets/huggingface/badges/resolve/main/model-on-hf-md.svg)](https://huggingface.co/ogulcanaydogan/turkish-llm-7b-instruct)
+<p align="center">
+  <a href="https://huggingface.co/spaces/ogulcanaydogan/Turkish-LLM-7B-Chat"><img src="https://img.shields.io/badge/Demo-Live_Chat-blue?style=for-the-badge&logo=huggingface" alt="Demo"></a>
+  <a href="https://github.com/ogulcanaydogan/Turkish-LLM"><img src="https://img.shields.io/badge/GitHub-Repository-black?style=for-the-badge&logo=github" alt="GitHub"></a>
+  <a href="https://huggingface.co/ogulcanaydogan/Turkish-LLM-14B-Instruct"><img src="https://img.shields.io/badge/Also_Available-14B_Model-yellow?style=for-the-badge&logo=huggingface" alt="14B"></a>
+</p>
+
+---
 
 ## Highlights
 
-- 🇹🇷 **Native Turkish** - Trained specifically for Turkish language tasks
-- 💬 **Instruction Following** - Optimized for chat and Q&A
-- 🚀 **7B Parameters** - Balanced performance and efficiency
-- 📖 **Open Source** - Apache 2.0 License
+- **Native Turkish** - Trained specifically for Turkish language tasks
+- **Instruction Following** - Optimized for chat and Q&A
+- **7B Parameters** - Balanced performance and efficiency
+- **Open Source** - Apache 2.0 License
 
 ## Model Details
 
-| | |
-|---|---|
+| Attribute | Value |
+|-----------|-------|
+| **Developer** | [Ogulcan Aydogan](https://ogulcanaydogan.com) |
 | **Base Model** | [TURKCELL/Turkcell-LLM-7b-v1](https://huggingface.co/TURKCELL/Turkcell-LLM-7b-v1) |
 | **Parameters** | 7 Billion |
-| **Language** | Turkish (Türkçe) |
+| **Language** | Turkish (tr) |
 | **License** | Apache 2.0 |
-| **Training Data** | 125,000+ Turkish instruction-response pairs |
 | **Fine-tuning** | LoRA (Low-Rank Adaptation) |
+| **Training Data** | 125,000+ Turkish instruction-response pairs |
+
+### Model Family
+
+| Model | Parameters | Base | Method | Use Case |
+|-------|-----------|------|--------|----------|
+| [Turkish-LLM-14B-Instruct](https://huggingface.co/ogulcanaydogan/Turkish-LLM-14B-Instruct) | 14.7B | Qwen2.5-14B-Instruct | SFT | Higher quality, complex reasoning |
+| [Turkish-LLM-14B-Instruct-GGUF](https://huggingface.co/ogulcanaydogan/Turkish-LLM-14B-Instruct-GGUF) | 14.7B | 14B-Instruct | GGUF quantized | Local/edge deployment |
+| **Turkish-LLM-7B-Instruct** (this) | 7B | Turkcell-LLM-7b-v1 | LoRA | Lightweight, faster inference |
 
 ## Training
 
 | Parameter | Value |
 |-----------|-------|
 | Hardware | NVIDIA A100 80GB |
-| Training Time | ~10 hours |
 | Framework | PyTorch + Transformers + PEFT |
 | Precision | bfloat16 |
 | Final Loss | 1.88 |
@@ -54,80 +67,92 @@ The first open-source instruction-tuned Turkish language model at 7B scale.
 | LoRA Rank | 64 |
 | LoRA Alpha | 128 |
 
-## Quick Start
+## Usage
+
+### Transformers
 
 ```python
 from transformers import AutoModelForCausalLM, AutoTokenizer
 import torch
 
-# Load model
 model = AutoModelForCausalLM.from_pretrained(
-    "ogulcanaydogan/turkish-llm-7b-instruct",
+    "ogulcanaydogan/Turkish-LLM-7B-Instruct",
     torch_dtype=torch.bfloat16,
     device_map="auto"
 )
-tokenizer = AutoTokenizer.from_pretrained("ogulcanaydogan/turkish-llm-7b-instruct")
-
-# Chat format
-def chat(message):
-    prompt = f"<|im_start|>user\n{message}<|im_end|>\n<|im_start|>assistant\n"
-    inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
-    outputs = model.generate(
-        **inputs,
-        max_new_tokens=512,
-        temperature=0.7,
-        top_p=0.9,
-        do_sample=True
-    )
-    return tokenizer.decode(outputs[0], skip_special_tokens=True).split("assistant\n")[-1]
-
-# Example
-print(chat("Türkiye'nin başkenti neresidir?"))
+tokenizer = AutoTokenizer.from_pretrained("ogulcanaydogan/Turkish-LLM-7B-Instruct")
+
+messages = [
+    {"role": "user", "content": "Turkiye'nin baskenti neresidir?"}
+]
+
+prompt = "<|im_start|>user\n" + messages[0]["content"] + "<|im_end|>\n<|im_start|>assistant\n"
+inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
+outputs = model.generate(
+    **inputs,
+    max_new_tokens=512,
+    temperature=0.7,
+    top_p=0.9,
+    do_sample=True
+)
+print(tokenizer.decode(outputs[0], skip_special_tokens=True).split("assistant\n")[-1])
 ```
 
-## Example Outputs
+### Ollama
+
+```bash
+ollama run hf.co/ogulcanaydogan/Turkish-LLM-7B-Instruct
+```
+
+### Chat Template
 
-### Question Answering
-| Soru | Cevap |
-|------|-------|
-| Türkiye'nin başkenti neresidir? | Türkiye'nin başkenti Ankara'dır. |
-| Yapay zeka nedir? | Yapay zeka, öğrenme ve akıl yürütme yeteneğine sahip bilgisayar sistemlerini ifade eder. |
+```
+<|im_start|>user
+{user_message}<|im_end|>
+<|im_start|>assistant
+{assistant_response}<|im_end|>
+```
+
+## Example Outputs
 
-### Creative Writing
-**Prompt:** Bana kısa bir hikaye yaz.
+**Q:** Turkiye'nin baskenti neresidir?
+**A:** Turkiye'nin baskenti Ankara'dir.
 
-**Response:** Bir varmış bir yokmuş, çok uzak bir diyarda, büyük bir maceraya atılan bir grup arkadaş varmış. Hepsi cesur ve cesurdu ve birbirlerine yardım etmek için her zaman hazırdı...
+**Q:** Yapay zeka nedir?
+**A:** Yapay zeka, ogrenme ve akil yurutme yetenegine sahip bilgisayar sistemlerini ifade eder.
 
-### Code Generation
-**Prompt:** Python'da bir listeyi nasıl sıralarım?
+## Hardware Requirements
 
-**Response:** Python'da bir listeyi sıralamanın birkaç yolu vardır. Yaygın yöntemlerden biri sorted() işlevini kullanmaktır...
+| Precision | VRAM Required | Recommended |
+|-----------|--------------|-------------|
+| BF16 | ~14 GB | RTX 4090, A10G, M2 Pro (16GB) |
+| INT8 | ~7 GB | RTX 3080, M1 Pro |
+| INT4 | ~4 GB | RTX 3060, Apple M-series (8GB) |
 
-## Use Cases
+## Intended Use
 
-- 🤖 Turkish chatbots and virtual assistants
-- ❓ Question answering systems
-- 📝 Text generation and creative writing
-- 📚 Educational applications
-- 🔬 NLP research for Turkish language
+- Turkish chatbots and virtual assistants
+- Question answering systems
+- Text generation and creative writing
+- Educational applications
+- NLP research for Turkish language
 
 ## Limitations
 
 - May occasionally generate incorrect information (hallucinations)
-- Code generation sometimes uses Turkish keywords instead of English
 - Performance on very long contexts (>2048 tokens) may degrade
 - Not recommended for production without additional safety measures
 
-## Author
+## Related Resources
 
-**Ogulcan Aydogan**
-
-| | |
-|---|---|
-| 🌐 Website | [ogulcanaydogan.com](https://ogulcanaydogan.com) |
-| 🐙 GitHub | [github.com/ogulcanaydogan](https://github.com/ogulcanaydogan) |
-| 🤗 HuggingFace | [huggingface.co/ogulcanaydogan](https://huggingface.co/ogulcanaydogan) |
-| 💼 LinkedIn | [linkedin.com/in/ogulcanaydogan](https://linkedin.com/in/ogulcanaydogan) |
+| Resource | Link |
+|----------|------|
+| 14B Model | [Turkish-LLM-14B-Instruct](https://huggingface.co/ogulcanaydogan/Turkish-LLM-14B-Instruct) |
+| 14B GGUF | [Turkish-LLM-14B-Instruct-GGUF](https://huggingface.co/ogulcanaydogan/Turkish-LLM-14B-Instruct-GGUF) |
+| Live Demo (14B) | [Turkish-LLM-14B-Chat](https://huggingface.co/spaces/ogulcanaydogan/Turkish-LLM-14B-Chat) |
+| Live Demo (7B) | [Turkish-LLM-7B-Chat](https://huggingface.co/spaces/ogulcanaydogan/Turkish-LLM-7B-Chat) |
+| Training Pipeline | [LowResource-LLM-Forge](https://github.com/ogulcanaydogan/LowResource-LLM-Forge) |
+| Project Repository | [Turkish-LLM on GitHub](https://github.com/ogulcanaydogan/Turkish-LLM) |
 
 ## Citation
 
@@ -137,22 +162,19 @@ print(chat("Türkiye'nin başkenti neresidir?"))
   title = {Turkish-LLM-7B-Instruct: An Instruction-Tuned Turkish Language Model},
   year = {2026},
   publisher = {HuggingFace},
-  url = {https://huggingface.co/ogulcanaydogan/turkish-llm-7b-instruct}
+  url = {https://huggingface.co/ogulcanaydogan/Turkish-LLM-7B-Instruct}
 }
 ```
 
+## Contact
+
+- Website: [ogulcanaydogan.com](https://ogulcanaydogan.com)
+- GitHub: [github.com/ogulcanaydogan](https://github.com/ogulcanaydogan)
+- Hugging Face: [huggingface.co/ogulcanaydogan](https://huggingface.co/ogulcanaydogan)
+- LinkedIn: [linkedin.com/in/ogulcanaydogan](https://linkedin.com/in/ogulcanaydogan)
+
 ## Acknowledgments
 
 - Base model by [TURKCELL](https://huggingface.co/TURKCELL)
 - Training framework: [HuggingFace Transformers](https://github.com/huggingface/transformers)
 - Fine-tuning: [PEFT](https://github.com/huggingface/peft)
-
----
-
-<p align="center">
-  <b>If you find this model useful, please ⭐ star the repository!</b>
-</p>
-
-<p align="center">
-  Made with ❤️ in Turkey 🇹🇷
-</p>